Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "mock.name" "My Mock Server"
CkJsonObject_UpdateString $json "mock.environment" "11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19"
CkJsonObject_UpdateString $json "mock.description" "example describing update mock description"
CkJsonObject_UpdateBool $json "mock.private" 0
CkJsonObject_UpdateString $json "mock.versionTag" "abf07d3d-f8ec-47d4-8015-9fe83078b4ec"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "X-API-Key" "{{postman_api_key}}"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.getpostman.com/mocks/{{mock_uid}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Id [CkJsonObject_stringOf $jResp "mock.id"]
set Owner [CkJsonObject_stringOf $jResp "mock.owner"]
set Uid [CkJsonObject_stringOf $jResp "mock.uid"]
set Collection [CkJsonObject_stringOf $jResp "mock.collection"]
set MockUrl [CkJsonObject_stringOf $jResp "mock.mockUrl"]
set Name [CkJsonObject_stringOf $jResp "mock.name"]
set MatchBody [CkJsonObject_BoolOf $jResp "mock.config.matchBody"]
set MatchQueryParams [CkJsonObject_BoolOf $jResp "mock.config.matchQueryParams"]
set MatchWildcards [CkJsonObject_BoolOf $jResp "mock.config.matchWildcards"]
set Environment [CkJsonObject_stringOf $jResp "mock.environment"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "mock.config.headers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
