Chilkat Online Tools

TCL / Postman API / All Mocks

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/mocks" $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)

# {
#   "mocks": [
#     {
#       "id": "e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
#       "owner": "1686168",
#       "uid": "1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706",
#       "collection": "1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc",
#       "environment": "1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
#       "mockUrl": "https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io",
#       "name": "mock1",
#       "config": {
#         "headers": [
#         ],
#         "matchBody": false,
#         "matchQueryParams": true,
#         "matchWildcards": true,
#         "delay": null
#       },
#       "createdAt": "2020-12-15T06:44:37.000Z",
#       "updatedAt": "2020-12-15T06:44:37.000Z",
#       "isPublic": false
#     },
#     {
#       "id": "8f9d4b95-780d-455d-af38-772277bc9393",
#       "owner": "1686168",
#       "uid": "1686168-8f9d4b95-780d-455d-af38-772277bc9393",
#       "collection": "1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664",
#       "mockUrl": "https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io",
#       "name": "mock2",
#       "config": {
#         "headers": [
#         ],
#         "matchBody": false,
#         "matchQueryParams": true,
#         "matchWildcards": true,
#         "delay": null
#       },
#       "createdAt": "2020-11-15T06:44:37.000Z",
#       "updatedAt": "2020-12-15T06:48:37.000Z",
#       "isPublic": true
#     }
#   ]
# }

# 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 "mocks"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "mocks[i].id"]
    set owner [CkJsonObject_stringOf $jResp "mocks[i].owner"]
    set uid [CkJsonObject_stringOf $jResp "mocks[i].uid"]
    set collection [CkJsonObject_stringOf $jResp "mocks[i].collection"]
    set environment [CkJsonObject_stringOf $jResp "mocks[i].environment"]
    set mockUrl [CkJsonObject_stringOf $jResp "mocks[i].mockUrl"]
    set name [CkJsonObject_stringOf $jResp "mocks[i].name"]
    set MatchBody [CkJsonObject_BoolOf $jResp "mocks[i].config.matchBody"]
    set MatchQueryParams [CkJsonObject_BoolOf $jResp "mocks[i].config.matchQueryParams"]
    set MatchWildcards [CkJsonObject_BoolOf $jResp "mocks[i].config.matchWildcards"]
    set Delay [CkJsonObject_stringOf $jResp "mocks[i].config.delay"]
    set createdAt [CkJsonObject_stringOf $jResp "mocks[i].createdAt"]
    set updatedAt [CkJsonObject_stringOf $jResp "mocks[i].updatedAt"]
    set isPublic [CkJsonObject_BoolOf $jResp "mocks[i].isPublic"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "mocks[i].config.headers"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set j [expr $j + 1]
    }
    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/mocks

Postman Collection Item JSON

{
  "name": "All Mocks",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks"
      ]
    },
    "description": "This endpoint fetches all the mocks that you have created.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
  },
  "response": [
    {
      "name": "Successful Response",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/mocks",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks"
          ]
        }
      },
      "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    \"mocks\": [\n        {\n            \"id\": \"e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n            \"owner\": \"1686168\",\n            \"uid\": \"1686168-e782b64e-406b-4a6c-8fe9-9ebe84aeb706\",\n            \"collection\": \"1686168-39fee52f-b806-3ffa-1173-00a6f5b183dc\",\n            \"environment\": \"1686168-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n            \"mockUrl\": \"https://e782b64e-406b-4a6c-8fe9-9ebe84aeb706.mock.pstmn.io\",\n            \"name\": \"mock1\",\n            \"config\": {\n                \"headers\": [],\n                \"matchBody\": false,\n                \"matchQueryParams\": true,\n                \"matchWildcards\": true,\n                \"delay\": null\n            },\n            \"createdAt\": \"2020-12-15T06:44:37.000Z\",\n            \"updatedAt\": \"2020-12-15T06:44:37.000Z\",\n            \"isPublic\": false\n        },\n        {\n            \"id\": \"8f9d4b95-780d-455d-af38-772277bc9393\",\n            \"owner\": \"1686168\",\n            \"uid\": \"1686168-8f9d4b95-780d-455d-af38-772277bc9393\",\n            \"collection\": \"1686168-37eeb72f-5d3e-48b4-8022-6b9cca6d2664\",\n            \"mockUrl\": \"https://8f9d4b95-780d-455d-af38-772277bc93936.mock.pstmn.io\",\n            \"name\": \"mock2\",\n            \"config\": {\n                \"headers\": [],\n                \"matchBody\": false,\n                \"matchQueryParams\": true,\n                \"matchWildcards\": true,\n                \"delay\": null\n            },\n            \"createdAt\": \"2020-11-15T06:44:37.000Z\",\n            \"updatedAt\": \"2020-12-15T06:48:37.000Z\",\n            \"isPublic\": true\n        }\n    ]\n}"
    }
  ]
}