Chilkat Online Tools

autoit / Postman API / Get an API Version

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.SetRequestHeader "X-API-Key","{{postman_api_key}}"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "version": {
;     "id": "03c17f53-7e2e-427d-b55a-006b244f29ff",
;     "name": "0.1",
;     "api": "06e41ca3-8bea-4bc5-a726-70338b9f1940",
;     "schema": [
;       "3484cd1e-e00d-4c39-aea4-539663afe898"
;     ],
;     "createdBy": "5665",
;     "updatedBy": "5665",
;     "createdAt": "2019-07-21T16:31:15.000Z",
;     "updatedAt": "2019-07-21T16:31:15.000Z"
;   }
; }

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

Local $strVal

Local $sId = $oJResp.StringOf("version.id")
Local $sName = $oJResp.StringOf("version.name")
Local $sApi = $oJResp.StringOf("version.api")
Local $sCreatedBy = $oJResp.StringOf("version.createdBy")
Local $sUpdatedBy = $oJResp.StringOf("version.updatedBy")
Local $sCreatedAt = $oJResp.StringOf("version.createdAt")
Local $sUpdatedAt = $oJResp.StringOf("version.updatedAt")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("version.schema")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("version.schema[i]")
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}

Postman Collection Item JSON

{
  "name": "Get an API Version",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "apis",
        "{{apiId}}",
        "versions",
        "{{apiVersionId}}"
      ]
    },
    "description": "This call fetches details about the specified API Version.\n\nThe response will contain a `version` object which would contain all the details of the API Version.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Get an API version",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{versionId}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "apis",
            "{{apiId}}",
            "versions",
            "{{versionId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"version\": {\n\t\t\"id\": \"03c17f53-7e2e-427d-b55a-006b244f29ff\",\n\t    \"name\": \"0.1\",\n\t    \"api\": \"06e41ca3-8bea-4bc5-a726-70338b9f1940\",\n\t    \"schema\": [\n\t      \"3484cd1e-e00d-4c39-aea4-539663afe898\"\n\t    ],\n\t    \"createdBy\": \"5665\",\n\t    \"updatedBy\": \"5665\",\n\t    \"createdAt\": \"2019-07-21T16:31:15.000Z\",\n\t    \"updatedAt\": \"2019-07-21T16:31:15.000Z\"\n\t}\n}"
    }
  ]
}