Chilkat Online Tools

Objective-C / Postman API / Single Collection

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

[http SetRequestHeader: @"X-API-Key" value: @"{{postman_api_key}}"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.getpostman.com/collections/{{collection_uid}}" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "collection": {
//     "variables": [
//     ],
//     "info": {
//       "name": "Sample Collection",
//       "_postman_id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
//       "description": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.",
//       "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
//     },
//     "item": [
//       {
//         "id": "82ee981b-e19f-962a-401e-ea34ebfb4848",
//         "name": "Request Headers",
//         "event": [
//           {
//             "listen": "test",
//             "script": {
//               "type": "text/javascript",
//               "exec": "var responseJSON;\ntry {\n    tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n    responseJSON = JSON.parse(responseBody);\n    tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n    tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n"
//             }
//           }
//         ],
//         "request": {
//           "url": "https://echo.getpostman.com/headers",
//           "method": "GET",
//           "header": [
//             {
//               "key": "my-sample-header",
//               "value": "Lorem ipsum dolor sit amet",
//               "description": ""
//             }
//           ],
//           "body": {
//             "mode": "formdata",
//             "formdata": [
//             ]
//           },
//           "description": ""
//         },
//         "response": [
//         ]
//       }
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *id = 0;
NSString *name = 0;
NSString *v_Url = 0;
NSString *Method = 0;
NSString *Mode = 0;
NSString *requestDescription = 0;
int j;
int count_j;
NSString *listen = 0;
NSString *v_Type = 0;
NSString *Exec = 0;
NSString *key = 0;
NSString *value = 0;
NSString *description = 0;

NSString *Name = [jResp StringOf: @"collection.info.name"];
NSString *v_postman_id = [jResp StringOf: @"collection.info._postman_id"];
NSString *Description = [jResp StringOf: @"collection.info.description"];
NSString *Schema = [jResp StringOf: @"collection.info.schema"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"collection.variables"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"collection.item"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"collection.item[i].id"];
    name = [jResp StringOf: @"collection.item[i].name"];
    v_Url = [jResp StringOf: @"collection.item[i].request.url"];
    Method = [jResp StringOf: @"collection.item[i].request.method"];
    Mode = [jResp StringOf: @"collection.item[i].request.body.mode"];
    requestDescription = [jResp StringOf: @"collection.item[i].request.description"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"collection.item[i].event"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        listen = [jResp StringOf: @"collection.item[i].event[j].listen"];
        v_Type = [jResp StringOf: @"collection.item[i].event[j].script.type"];
        Exec = [jResp StringOf: @"collection.item[i].event[j].script.exec"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"collection.item[i].request.header"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        key = [jResp StringOf: @"collection.item[i].request.header[j].key"];
        value = [jResp StringOf: @"collection.item[i].request.header[j].value"];
        description = [jResp StringOf: @"collection.item[i].request.header[j].description"];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"collection.item[i].request.body.formdata"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    j = 0;
    count_j = [[jResp SizeOfArray: @"collection.item[i].response"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        j = j + 1;
    }

    i = i + 1;
}

Curl Command

curl -X GET
	-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/collections/{{collection_uid}}

Postman Collection Item JSON

{
  "name": "Single Collection ",
  "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 one collection\", function () {",
          "    pm.expect(pm.response.json()).to.have.property('collection').and.be.an('object');",
          "});",
          "",
          "// 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');",
          "});",
          "",
          "// you can unskip this test in case you want to have a stricter check on the selected",
          "// environment.",
          "pm.test.skip('\"collection_uid\" variable should be present', function () {",
          "    pm.expect(pm.variables.get('collection_uid')).to.be.a('string');",
          "});"
        ]
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.getpostman.com/collections/{{collection_uid}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "collections",
        "{{collection_uid}}"
      ]
    },
    "description": "Access the contents of a collection that is accessible to you using its unique id (`uid`).\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/{{collection_uid}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "collections",
            "{{collection_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    \"collection\": {\n        \"variables\": [],\n        \"info\": {\n            \"name\": \"Sample Collection\",\n            \"_postman_id\": \"f2e66c2e-5297-e4a5-739e-20cbb90900e3\",\n            \"description\": \"This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.\",\n            \"schema\": \"https://schema.getpostman.com/json/collection/v2.0.0/collection.json\"\n        },\n        \"item\": [\n            {\n                \"id\": \"82ee981b-e19f-962a-401e-ea34ebfb4848\",\n                \"name\": \"Request Headers\",\n                \"event\": [\n                    {\n                        \"listen\": \"test\",\n                        \"script\": {\n                            \"type\": \"text/javascript\",\n                            \"exec\": \"var responseJSON;\\ntry {\\n    tests[\\\"Body contains headers\\\"] = responseBody.has(\\\"headers\\\");\\n    responseJSON = JSON.parse(responseBody);\\n    tests[\\\"Header contains host\\\"] = \\\"host\\\" in responseJSON.headers;\\n    tests[\\\"Header contains test parameter sent as part of request header\\\"] = \\\"my-sample-header\\\" in responseJSON.headers;\\n}\\ncatch (e) { }\\n\\n\\n\\n\"\n                        }\n                    }\n                ],\n                \"request\": {\n                    \"url\": \"https://echo.getpostman.com/headers\",\n                    \"method\": \"GET\",\n                    \"header\": [\n                        {\n                            \"key\": \"my-sample-header\",\n                            \"value\": \"Lorem ipsum dolor sit amet\",\n                            \"description\": \"\"\n                        }\n                    ],\n                    \"body\": {\n                        \"mode\": \"formdata\",\n                        \"formdata\": []\n                    },\n                    \"description\": \"\"\n                },\n                \"response\": []\n            }\n        ]\n    }\n}"
    }
  ]
}