DataFlex / Postman API / All Environments
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sName
String sCreatedAt
String sUpdatedAt
String sOwner
String sUid
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/environments" 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)
// {
// "environments": [
// {
// "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
// "name": "Users API (prod)",
// "createdAt": "2020-09-23T14:31:18.000Z",
// "updatedAt": "2020-12-04T14:13:40.000Z",
// "owner": "10016724",
// "uid": "10016724-5daabc50-8451-43f6-922d-96b403b4f28e",
// "isPublic": false
// },
// {
// "id": "7d786cc8-142b-4d62-b5a5-872afc37ad16",
// "name": "Environment Scanner",
// "createdAt": "2020-02-04T19:34:23.000Z",
// "updatedAt": "2020-08-12T13:34:06.000Z",
// "owner": "10016724",
// "uid": "10016724-7d786cc8-142b-4d62-b5a5-872afc37ad16",
// "isPublic": false
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Move 0 To i
Get ComSizeOfArray Of hoJResp "environments" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "environments[i].id" To sId
Get ComStringOf Of hoJResp "environments[i].name" To sName
Get ComStringOf Of hoJResp "environments[i].createdAt" To sCreatedAt
Get ComStringOf Of hoJResp "environments[i].updatedAt" To sUpdatedAt
Get ComStringOf Of hoJResp "environments[i].owner" To sOwner
Get ComStringOf Of hoJResp "environments[i].uid" To sUid
Get ComBoolOf Of hoJResp "environments[i].isPublic" To iIsPublic
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/environments
Postman Collection Item JSON
{
"name": "All Environments",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"var responseJSON;",
"",
"// parse response body as JSON",
"try { responseJSON = JSON.parse(responseBody); } catch (e) { }",
"tests['received a valid response JSON'] = !!responseJSON;",
"!responseJSON && (responseJSON = {});",
"",
"tests['status code is 200'] = (responseCode.code === 200);",
"tests['response does not have errors'] = (!responseJSON.error);",
"",
"tests['response has an array of environments'] = Array.isArray(responseJSON.environments);"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
},
"description": "The `/environments` endpoint returns a list of all [environments](https://www.getpostman.com/docs/environments) that belong to you..\n\nThe response contains an array of environments' information containing the `name`, `id`, `owner` and `uid` of each environment.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Valid Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"environments\": [\n {\n \"id\": \"5daabc50-8451-43f6-922d-96b403b4f28e\",\n \"name\": \"Users API (prod)\",\n \"createdAt\": \"2020-09-23T14:31:18.000Z\",\n \"updatedAt\": \"2020-12-04T14:13:40.000Z\",\n \"owner\": \"10016724\",\n \"uid\": \"10016724-5daabc50-8451-43f6-922d-96b403b4f28e\",\n \"isPublic\": false\n },\n {\n \"id\": \"7d786cc8-142b-4d62-b5a5-872afc37ad16\",\n \"name\": \"Environment Scanner\",\n \"createdAt\": \"2020-02-04T19:34:23.000Z\",\n \"updatedAt\": \"2020-08-12T13:34:06.000Z\",\n \"owner\": \"10016724\",\n \"uid\": \"10016724-7d786cc8-142b-4d62-b5a5-872afc37ad16\",\n \"isPublic\": false\n }\n ]\n}"
}
]
}
