autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("mock.name","My Mock Server")
$oJson.UpdateString("mock.environment","11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19")
$oJson.UpdateString("mock.description","example describing update mock description")
$oJson.UpdateBool("mock.private",False)
$oJson.UpdateString("mock.versionTag","abf07d3d-f8ec-47d4-8015-9fe83078b4ec")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "X-API-Key","{{postman_api_key}}"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PUT","https://api.getpostman.com/mocks/{{mock_uid}}",$oSbRequestBody,"utf-8","application/json",False,False)
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",
; "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
Local $sId = $oJResp.StringOf("mock.id")
Local $sOwner = $oJResp.StringOf("mock.owner")
Local $sUid = $oJResp.StringOf("mock.uid")
Local $sCollection = $oJResp.StringOf("mock.collection")
Local $sMockUrl = $oJResp.StringOf("mock.mockUrl")
Local $sName = $oJResp.StringOf("mock.name")
Local $bMatchBody = $oJResp.BoolOf("mock.config.matchBody")
Local $bMatchQueryParams = $oJResp.BoolOf("mock.config.matchQueryParams")
Local $bMatchWildcards = $oJResp.BoolOf("mock.config.matchWildcards")
Local $sEnvironment = $oJResp.StringOf("mock.environment")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("mock.config.headers")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
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}"
}
]
}
