Foxpro / Postman API / Update Mock
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcOwner
LOCAL lcUid
LOCAL lcCollection
LOCAL lcMockUrl
LOCAL lcName
LOCAL lnMatchBody
LOCAL lnMatchQueryParams
LOCAL lnMatchWildcards
LOCAL lcEnvironment
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* 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"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("mock.name","My Mock Server")
loJson.UpdateString("mock.environment","11582779-ac1b6608-deb7-4c05-9d48-ee775aabfc19")
loJson.UpdateString("mock.description","example describing update mock description")
loJson.UpdateBool("mock.private",0)
loJson.UpdateString("mock.versionTag","abf07d3d-f8ec-47d4-8015-9fe83078b4ec")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("X-API-Key","{{postman_api_key}}")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.getpostman.com/mocks/{{mock_uid}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("mock.id")
lcOwner = loJResp.StringOf("mock.owner")
lcUid = loJResp.StringOf("mock.uid")
lcCollection = loJResp.StringOf("mock.collection")
lcMockUrl = loJResp.StringOf("mock.mockUrl")
lcName = loJResp.StringOf("mock.name")
lnMatchBody = loJResp.BoolOf("mock.config.matchBody")
lnMatchQueryParams = loJResp.BoolOf("mock.config.matchQueryParams")
lnMatchWildcards = loJResp.BoolOf("mock.config.matchWildcards")
lcEnvironment = loJResp.StringOf("mock.environment")
i = 0
lnCount_i = loJResp.SizeOfArray("mock.config.headers")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
