Chilkat Online Tools

VB6 / Postman API / Update Mock

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' Use this online tool to generate code from sample JSON: Generate Code to Create JSON

' The following JSON is sent in the request body.

' {
'   "mock": {
'     "name": "My Mock Server",
'     "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19",
'     "description": "example describing update mock description",
'     "private": false,
'     "versionTag": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec"
'   }
' }

Dim json As New ChilkatJsonObject
success = json.UpdateString("mock.name","My Mock Server")
success = json.UpdateString("mock.environment","11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19")
success = json.UpdateString("mock.description","example describing update mock description")
success = json.UpdateBool("mock.private",0)
success = json.UpdateString("mock.versionTag","abf07d3d-f8ec-47d4-8015-9fe83078b4ec")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "X-API-Key","{{postman_api_key}}"

Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)

Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PUT","https://api.getpostman.com/mocks/{{mock_uid}}",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "mock": {
'     "id": "06040138-dd6b-4cce-9a02-7e1c1ab59723",
'     "owner": "11582779",
'     "uid": "11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723",
'     "collection": "11582779-fd6797e2-de6b-4699-975c-85290e4c2499",
'     "mockUrl": "https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io",
'     "name": "My Mock Server",
'     "config": {
'       "headers": [
'       ],
'       "matchBody": false,
'       "matchQueryParams": true,
'       "matchWildcards": true
'     },
'     "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19"
'   }
' }

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

Dim Id As String
Id = jResp.StringOf("mock.id")
Dim Owner As String
Owner = jResp.StringOf("mock.owner")
Dim Uid As String
Uid = jResp.StringOf("mock.uid")
Dim Collection As String
Collection = jResp.StringOf("mock.collection")
Dim MockUrl As String
MockUrl = jResp.StringOf("mock.mockUrl")
Dim Name As String
Name = jResp.StringOf("mock.name")
Dim MatchBody As Long
MatchBody = jResp.BoolOf("mock.config.matchBody")
Dim MatchQueryParams As Long
MatchQueryParams = jResp.BoolOf("mock.config.matchQueryParams")
Dim MatchWildcards As Long
MatchWildcards = jResp.BoolOf("mock.config.matchWildcards")
Dim Environment As String
Environment = jResp.StringOf("mock.environment")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("mock.config.headers")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop

Curl Command

curl -X PUT
	-H "X-API-Key: {{postman_api_key}}"
	-H "Content-Type: application/json"
	-d '{
    "mock": {
        "name": "My Mock Server",
        "environment": "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19",
        "description": "example describing update mock description",
        "private": false,
        "versionTag": "abf07d3d-f8ec-47d4-8015-9fe83078b4ec"
    }
}'
https://api.getpostman.com/mocks/{{mock_uid}}

Postman Collection Item JSON

{
  "name": "Update Mock",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"mock\": {\n        \"name\": \"My Mock Server\",\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\",\n        \"description\": \"example describing update mock description\",\n        \"private\": false,\n        \"versionTag\": \"abf07d3d-f8ec-47d4-8015-9fe83078b4ec\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.getpostman.com/mocks/{{mock_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "mocks",
        "{{mock_uid}}"
      ]
    },
    "description": "This endpoint allows you to update a mock you have created using its `uid`. The endpoint allows you to edit fields,\n* name\n* environment\n* description\n* private\n* versionTag\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": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"mock\": {\n        \"name\": \"My Mock Server\",\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\",\n        \"description\": \"example describing update mock description\",\n        \"private\": false,\n        \"versionTag\": \"abf07d3d-f8ec-47d4-8015-9fe83078b4ec\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "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"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"mock\": {\n        \"id\": \"06040138-dd6b-4cce-9a02-7e1c1ab59723\",\n        \"owner\": \"11582779\",\n        \"uid\": \"11582779-06040138-dd6b-4cce-9a02-7e1c1ab59723\",\n        \"collection\": \"11582779-fd6797e2-de6b-4699-975c-85290e4c2499\",\n        \"mockUrl\": \"https://06040138-dd6b-4cce-9a02-7e1c1ab59723.mock.pstmn.io\",\n        \"name\": \"My Mock Server\",\n        \"config\": {\n            \"headers\": [],\n            \"matchBody\": false,\n            \"matchQueryParams\": true,\n            \"matchWildcards\": true\n        },\n        \"environment\": \"11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19\"\n    }\n}"
    }
  ]
}