PowerBuilder / Postman API / All Collections
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_Owner
string ls_Uid
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
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.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
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.getpostman.com/collections",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
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.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)
// {
// "collections": [
// {
// "id": "dac5eac9-148d-a32e-b76b-3edee9da28f7",
// "name": "Cloud API",
// "owner": "631643",
// "uid": "631643-dac5eac9-148d-a32e-b76b-3edee9da28f7"
// },
// {
// "id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
// "name": "Sample Collection",
// "owner": "631643",
// "uid": "631643-f2e66c2e-5297-e4a5-739e-20cbb90900e3"
// },
// {
// "id": "f695cab7-6878-eb55-7943-ad88e1ccfd65",
// "name": "Postman Echo",
// "owner": "631643",
// "uid": "631643-f695cab7-6878-eb55-7943-ad88e1ccfd65"
// }
// ]
// }
// 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("collections")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("collections[i].id")
ls_Name = loo_JResp.StringOf("collections[i].name")
ls_Owner = loo_JResp.StringOf("collections[i].owner")
ls_Uid = loo_JResp.StringOf("collections[i].uid")
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/collections
Postman Collection Item JSON
{
"name": "All Collections",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"pm.test(\"response is ok\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"response json data should not have errors\", function () {",
" pm.response.to.have.jsonBody();",
" pm.response.to.not.have.jsonBody('error');",
"});",
"",
"pm.test(\"response json should contain collections\", function () {",
" pm.expect(pm.response.json()).to.have.property('collections').and.be.an('array');",
"});",
"",
"// additional tests to ensure that the relevant environment variables are present",
"pm.test('\"postman_api_key\" variable should be present', function () {",
" pm.expect(pm.variables.get('postman_api_key')).to.be.a('string');",
"});"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/collections",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections"
]
},
"description": "The `/collections` endpoint returns a list of all [collections](https://www.getpostman.com/docs/collections) that are accessible by you. The list includes your own collections and the collections that you have subscribed to.\n\nThe response contains an array of collection information containing the `name`, `id`, `owner` and `uid` of each collection.\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/collections",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"collections\": [\n {\n \"id\": \"dac5eac9-148d-a32e-b76b-3edee9da28f7\",\n \"name\": \"Cloud API\",\n \"owner\": \"631643\",\n \"uid\": \"631643-dac5eac9-148d-a32e-b76b-3edee9da28f7\"\n },\n {\n \"id\": \"f2e66c2e-5297-e4a5-739e-20cbb90900e3\",\n \"name\": \"Sample Collection\",\n \"owner\": \"631643\",\n \"uid\": \"631643-f2e66c2e-5297-e4a5-739e-20cbb90900e3\"\n },\n {\n \"id\": \"f695cab7-6878-eb55-7943-ad88e1ccfd65\",\n \"name\": \"Postman Echo\",\n \"owner\": \"631643\",\n \"uid\": \"631643-f695cab7-6878-eb55-7943-ad88e1ccfd65\"\n }\n ]\n}"
}
]
}
