Chilkat Online Tools

autoit / Postman API / Single Mock

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/mocks/{{mock_uid}}",$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)

; {
;   "mock": {
;     "id": "950dcaf2-ec37-4365-b106-ed659cc2ff5d",
;     "owner": "1679925",
;     "uid": "1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d",
;     "collection": "1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf",
;     "environment": "1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511",
;     "mockUrl": "https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.mock.pstmn.io",
;     "name": "mock1",
;     "config": {
;       "headers": [
;       ],
;       "matchBody": false,
;       "matchQueryParams": true,
;       "matchWildcards": true,
;       "delay": null
;     },
;     "createdAt": "2020-12-14T08:12:21.000Z",
;     "updatedAt": "2020-12-15T06:44:37.000Z",
;     "isPublic": false
;   }
; }

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

Local $sId = $oJResp.StringOf("mock.id")
Local $sOwner = $oJResp.StringOf("mock.owner")
Local $sUid = $oJResp.StringOf("mock.uid")
Local $sCollection = $oJResp.StringOf("mock.collection")
Local $sEnvironment = $oJResp.StringOf("mock.environment")
Local $sMockUrl = $oJResp.StringOf("mock.mockUrl")
Local $sName = $oJResp.StringOf("mock.name")
Local $bMatchBody = $oJResp.BoolOf("mock.config.matchBody")
Local $bMatchQueryParams = $oJResp.BoolOf("mock.config.matchQueryParams")
Local $bMatchWildcards = $oJResp.BoolOf("mock.config.matchWildcards")
Local $sDelay = $oJResp.StringOf("mock.config.delay")
Local $sCreatedAt = $oJResp.StringOf("mock.createdAt")
Local $sUpdatedAt = $oJResp.StringOf("mock.updatedAt")
Local $bIsPublic = $oJResp.BoolOf("mock.isPublic")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("mock.config.headers")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "Single Mock",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}"
      ]
    },
    "description": "This endpoint fetches you the basic information about a single mock using its `uid`.\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/{{mock_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks",
            "{{mock_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    \"mock\":{\n        \"id\":\"950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"owner\":\"1679925\",\n        \"uid\":\"1679925-950dcaf2-ec37-4365-b106-ed659cc2ff5d\",\n        \"collection\":\"1679925-8aa4c661-e0f4-4db0-98bc-d52cb72b5cbf\",\n        \"environment\": \"1679925-2b90cdd8-e9ac-4086-91c2-bc4cad659511\",\n        \"mockUrl\":\"https://950dcaf2-ec37-4365-b106-ed659cc2ff5d.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-14T08:12:21.000Z\",\n        \"updatedAt\":\"2020-12-15T06:44:37.000Z\",\n        \"isPublic\":false\n    }\n}"
    }
  ]
}