DataFlex / Postman API / Single Mock
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sOwner
String sUid
String sCollection
String sEnvironment
String sMockUrl
String sName
Boolean iMatchBody
Boolean iMatchQueryParams
Boolean iMatchWildcards
String sDelay
String sCreatedAt
String sUpdatedAt
Boolean iIsPublic
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "X-API-Key" "{{postman_api_key}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.getpostman.com/mocks/{{mock_uid}}" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "mock.id" To sId
Get ComStringOf Of hoJResp "mock.owner" To sOwner
Get ComStringOf Of hoJResp "mock.uid" To sUid
Get ComStringOf Of hoJResp "mock.collection" To sCollection
Get ComStringOf Of hoJResp "mock.environment" To sEnvironment
Get ComStringOf Of hoJResp "mock.mockUrl" To sMockUrl
Get ComStringOf Of hoJResp "mock.name" To sName
Get ComBoolOf Of hoJResp "mock.config.matchBody" To iMatchBody
Get ComBoolOf Of hoJResp "mock.config.matchQueryParams" To iMatchQueryParams
Get ComBoolOf Of hoJResp "mock.config.matchWildcards" To iMatchWildcards
Get ComStringOf Of hoJResp "mock.config.delay" To sDelay
Get ComStringOf Of hoJResp "mock.createdAt" To sCreatedAt
Get ComStringOf Of hoJResp "mock.updatedAt" To sUpdatedAt
Get ComBoolOf Of hoJResp "mock.isPublic" To iIsPublic
Move 0 To i
Get ComSizeOfArray Of hoJResp "mock.config.headers" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
