Chilkat Online Tools

autoit / Postman API / Publish 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}}"

Local $oResp = $oHttp.QuickRequest("POST","https://api.getpostman.com/mocks/{{mock_uid}}/publish")
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "mock": {
;     "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723"
;   }
; }

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

Curl Command

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

Postman Collection Item JSON

{
  "name": "Publish Mock",
  "request": {
    "method": "POST",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}/publish",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}",
        "publish"
      ]
    },
    "description": "This endpoint publishes the mock you have created 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": "Success Response",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "url": {
          "raw": "https://api.getpostman.com/mocks/{{mock_uid}}/publish",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "mocks",
            "{{mock_uid}}",
            "publish"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json",
          "description": {
            "content": "",
            "type": "text/plain"
          }
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"mock\": {\n        \"id\": \"06040138-dd6b-4cce-9a02-7e1c1ab59723\"\n    }\n}"
    }
  ]
}