PowerBuilder / Postman API / All Environments
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_CreatedAt
string ls_UpdatedAt
string ls_Owner
string ls_Uid
integer li_IsPublic
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("X-API-Key","{{postman_api_key}}")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.getpostman.com/environments",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// 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
i = 0
li_Count_i = loo_JResp.SizeOfArray("environments")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("environments[i].id")
ls_Name = loo_JResp.StringOf("environments[i].name")
ls_CreatedAt = loo_JResp.StringOf("environments[i].createdAt")
ls_UpdatedAt = loo_JResp.StringOf("environments[i].updatedAt")
ls_Owner = loo_JResp.StringOf("environments[i].owner")
ls_Uid = loo_JResp.StringOf("environments[i].uid")
li_IsPublic = loo_JResp.BoolOf("environments[i].isPublic")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
