Chilkat Online Tools

VB.NET / Postman API / Single Environment

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.SetRequestHeader("X-API-Key","{{postman_api_key}}")

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.getpostman.com/environments/{{environment_uid}}",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "environment": {
'     "id": "1b163ddc-62ff-41d9-b74b-71424b9aa69d",
'     "name": "Contract Test Environment",
'     "owner": "10016724",
'     "createdAt": "2020-11-05T13:59:22.000Z",
'     "updatedAt": "2020-11-05T13:59:23.000Z",
'     "values": [
'       {
'         "key": "env-apiKey",
'         "value": "",
'         "enabled": true
'       }
'     ],
'     "isPublic": false
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code



Dim key As String
Dim value As String
Dim enabled As Boolean

Dim Id As String = jResp.StringOf("environment.id")
Dim Name As String = jResp.StringOf("environment.name")
Dim Owner As String = jResp.StringOf("environment.owner")
Dim CreatedAt As String = jResp.StringOf("environment.createdAt")
Dim UpdatedAt As String = jResp.StringOf("environment.updatedAt")
Dim IsPublic As Boolean = jResp.BoolOf("environment.isPublic")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("environment.values")
While i < count_i
    jResp.I = i
    key = jResp.StringOf("environment.values[i].key")
    value = jResp.StringOf("environment.values[i].value")
    enabled = jResp.BoolOf("environment.values[i].enabled")
    i = i + 1
End While

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/environments/{{environment_uid}}

Postman Collection Item JSON

{
  "name": "Single Environment",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var responseJSON;",
          "",
          "// parse response body as JSON",
          "try { responseJSON = JSON.parse(responseBody); } catch (e) { }",
          "tests['received a valid response JSON'] = !!responseJSON;",
          "!responseJSON && (responseJSON = {});",
          "",
          "tests['status code is 200'] = (responseCode.code === 200);",
          "tests['response does not have errors'] = (!responseJSON.error);",
          "",
          "tests['response has an environment object'] = (typeof responseJSON.environment === 'object');"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/environments/{{environment_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "environments",
        "{{environment_uid}}"
      ]
    },
    "description": "Access the contents of an environment that is accessible to you using its unique id (`uid`).\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Valid Response",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/environments/{{environment_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "environments",
            "{{environment_uid}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "name": "Content-Type",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"environment\": {\n        \"id\": \"1b163ddc-62ff-41d9-b74b-71424b9aa69d\",\n        \"name\": \"Contract Test Environment\",\n        \"owner\": \"10016724\",\n        \"createdAt\": \"2020-11-05T13:59:22.000Z\",\n        \"updatedAt\": \"2020-11-05T13:59:23.000Z\",\n        \"values\": [\n            {\n                \"key\": \"env-apiKey\",\n                \"value\": \"\",\n                \"enabled\": true\n            }\n        ],\n        \"isPublic\": false\n    }\n}"
    }
  ]
}