Chilkat Online Tools

autoit / Postman API / All Mocks

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",$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)

; {
;   "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

Local $sId
Local $sOwner
Local $sUid
Local $sCollection
Local $sEnvironment
Local $sMockUrl
Local $sName
Local $bMatchBody
Local $bMatchQueryParams
Local $bMatchWildcards
Local $sDelay
Local $sCreatedAt
Local $sUpdatedAt
Local $bIsPublic
Local $iJ
Local $iCount_j

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

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