Chilkat Online Tools

Perl / Postman API / Get an API Version

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->SetRequestHeader("X-API-Key","{{postman_api_key}}");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# 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

$Id = $jResp->stringOf("version.id");
$Name = $jResp->stringOf("version.name");
$Api = $jResp->stringOf("version.api");
$CreatedBy = $jResp->stringOf("version.createdBy");
$UpdatedBy = $jResp->stringOf("version.updatedBy");
$CreatedAt = $jResp->stringOf("version.createdAt");
$UpdatedAt = $jResp->stringOf("version.updatedAt");
$i = 0;
$count_i = $jResp->SizeOfArray("version.schema");
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf("version.schema[i]");
    $i = $i + 1;
}

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}"
    }
  ]
}