Chilkat Online Tools

C++ / Support API / List Custom Objects

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    // {
    //   "custom_objects": [
    //     {
    //       "key": "<string>",
    //       "title": "<string>",
    //       "title_pluralized": "<string>",
    //       "created_at": "<dateTime>",
    //       "created_by_user_id": "<string>",
    //       "description": "<string>",
    //       "raw_description": "<string>",
    //       "raw_title": "<string>",
    //       "raw_title_pluralized": "<string>",
    //       "updated_at": "<dateTime>",
    //       "updated_by_user_id": "<string>",
    //       "url": "<string>"
    //     },
    //     {
    //       "key": "<string>",
    //       "title": "<string>",
    //       "title_pluralized": "<string>",
    //       "created_at": "<dateTime>",
    //       "created_by_user_id": "<string>",
    //       "description": "<string>",
    //       "raw_description": "<string>",
    //       "raw_title": "<string>",
    //       "raw_title_pluralized": "<string>",
    //       "updated_at": "<dateTime>",
    //       "updated_by_user_id": "<string>",
    //       "url": "<string>"
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *key = 0;
    const char *title = 0;
    const char *title_pluralized = 0;
    const char *created_at = 0;
    const char *created_by_user_id = 0;
    const char *description = 0;
    const char *raw_description = 0;
    const char *raw_title = 0;
    const char *raw_title_pluralized = 0;
    const char *updated_at = 0;
    const char *updated_by_user_id = 0;
    const char *url = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("custom_objects");
    while (i < count_i) {
        jResp.put_I(i);
        key = jResp.stringOf("custom_objects[i].key");
        title = jResp.stringOf("custom_objects[i].title");
        title_pluralized = jResp.stringOf("custom_objects[i].title_pluralized");
        created_at = jResp.stringOf("custom_objects[i].created_at");
        created_by_user_id = jResp.stringOf("custom_objects[i].created_by_user_id");
        description = jResp.stringOf("custom_objects[i].description");
        raw_description = jResp.stringOf("custom_objects[i].raw_description");
        raw_title = jResp.stringOf("custom_objects[i].raw_title");
        raw_title_pluralized = jResp.stringOf("custom_objects[i].raw_title_pluralized");
        updated_at = jResp.stringOf("custom_objects[i].updated_at");
        updated_by_user_id = jResp.stringOf("custom_objects[i].updated_by_user_id");
        url = jResp.stringOf("custom_objects[i].url");
        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects

Postman Collection Item JSON

{
  "name": "List Custom Objects",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects"
      ]
    },
    "description": "Lists all undeleted custom objects for the account\n#### Allowed For\n* Everyone"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_objects\": [\n    {\n      \"key\": \"<string>\",\n      \"title\": \"<string>\",\n      \"title_pluralized\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"description\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"raw_title_pluralized\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"title\": \"<string>\",\n      \"title_pluralized\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"description\": \"<string>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"raw_title_pluralized\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}