TCL / Postman API / Get All API Versions
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_SetRequestHeader $http "X-API-Key" "{{postman_api_key}}"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.getpostman.com/apis/{{apiId}}/versions" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "versions": [
# {
# "id": "024660a6-c837-46ca-91d8-7e8dd7c669de",
# "name": "0.1",
# "summary": "Summary",
# "description": "Description",
# "createdBy": "5665",
# "createdAt": "2019-02-12 19:34:49",
# "updatedAt": "2019-02-12 19:34:49"
# },
# {
# "id": "00932d3b-20f1-454f-a77e-38b4023163ea",
# "name": "0.2",
# "summary": "Summary",
# "description": "Description",
# "createdBy": "5665",
# "createdAt": "2019-02-12 19:34:49",
# "updatedAt": "2019-02-12 19:34:49"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "versions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "versions[i].id"]
set name [CkJsonObject_stringOf $jResp "versions[i].name"]
set summary [CkJsonObject_stringOf $jResp "versions[i].summary"]
set description [CkJsonObject_stringOf $jResp "versions[i].description"]
set createdBy [CkJsonObject_stringOf $jResp "versions[i].createdBy"]
set createdAt [CkJsonObject_stringOf $jResp "versions[i].createdAt"]
set updatedAt [CkJsonObject_stringOf $jResp "versions[i].updatedAt"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/{{apiId}}/versions
Postman Collection Item JSON
{
"name": "Get All API Versions",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions"
]
},
"description": "This call fetches details about the all the API Versions in the specified API.\n\nThe response will contain an array `versions` object which would be a list of all the API Version along with their details.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Get All API versions",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"versions\": [\n\t\t{\n\t \"id\": \"024660a6-c837-46ca-91d8-7e8dd7c669de\",\n\t \"name\": \"0.1\",\n\t \"summary\": \"Summary\",\n\t \"description\": \"Description\",\n\t \"createdBy\": \"5665\",\n\t \"createdAt\": \"2019-02-12 19:34:49\",\n\t \"updatedAt\": \"2019-02-12 19:34:49\"\n\t },\n\t {\n\t \"id\": \"00932d3b-20f1-454f-a77e-38b4023163ea\",\n\t \"name\": \"0.2\",\n\t \"summary\": \"Summary\",\n\t \"description\": \"Description\",\n\t \"createdBy\": \"5665\",\n\t \"createdAt\": \"2019-02-12 19:34:49\",\n\t \"updatedAt\": \"2019-02-12 19:34:49\"\n\t }\n\t]\n}"
}
]
}