Chilkat Online Tools

PowerBuilder / Postman API / Single Mock

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Owner
string ls_Uid
string ls_Collection
string ls_Environment
string ls_MockUrl
string ls_Name
integer li_MatchBody
integer li_MatchQueryParams
integer li_MatchWildcards
string ls_Delay
string ls_CreatedAt
string ls_UpdatedAt
integer li_IsPublic
integer i
integer li_Count_i

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http.SetRequestHeader("X-API-Key","{{postman_api_key}}")

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api.getpostman.com/mocks/{{mock_uid}}",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

ls_Id = loo_JResp.StringOf("mock.id")
ls_Owner = loo_JResp.StringOf("mock.owner")
ls_Uid = loo_JResp.StringOf("mock.uid")
ls_Collection = loo_JResp.StringOf("mock.collection")
ls_Environment = loo_JResp.StringOf("mock.environment")
ls_MockUrl = loo_JResp.StringOf("mock.mockUrl")
ls_Name = loo_JResp.StringOf("mock.name")
li_MatchBody = loo_JResp.BoolOf("mock.config.matchBody")
li_MatchQueryParams = loo_JResp.BoolOf("mock.config.matchQueryParams")
li_MatchWildcards = loo_JResp.BoolOf("mock.config.matchWildcards")
ls_Delay = loo_JResp.StringOf("mock.config.delay")
ls_CreatedAt = loo_JResp.StringOf("mock.createdAt")
ls_UpdatedAt = loo_JResp.StringOf("mock.updatedAt")
li_IsPublic = loo_JResp.BoolOf("mock.isPublic")
i = 0
li_Count_i = loo_JResp.SizeOfArray("mock.config.headers")
do while i < li_Count_i
    loo_JResp.I = i
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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