C / Support API / List Custom Objects
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *key;
const char *title;
const char *title_pluralized;
const char *created_at;
const char *created_by_user_id;
const char *description;
const char *raw_description;
const char *raw_title;
const char *raw_title_pluralized;
const char *updated_at;
const char *updated_by_user_id;
const char *url;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/custom_objects",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"custom_objects");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
key = CkJsonObject_stringOf(jResp,"custom_objects[i].key");
title = CkJsonObject_stringOf(jResp,"custom_objects[i].title");
title_pluralized = CkJsonObject_stringOf(jResp,"custom_objects[i].title_pluralized");
created_at = CkJsonObject_stringOf(jResp,"custom_objects[i].created_at");
created_by_user_id = CkJsonObject_stringOf(jResp,"custom_objects[i].created_by_user_id");
description = CkJsonObject_stringOf(jResp,"custom_objects[i].description");
raw_description = CkJsonObject_stringOf(jResp,"custom_objects[i].raw_description");
raw_title = CkJsonObject_stringOf(jResp,"custom_objects[i].raw_title");
raw_title_pluralized = CkJsonObject_stringOf(jResp,"custom_objects[i].raw_title_pluralized");
updated_at = CkJsonObject_stringOf(jResp,"custom_objects[i].updated_at");
updated_by_user_id = CkJsonObject_stringOf(jResp,"custom_objects[i].updated_by_user_id");
url = CkJsonObject_stringOf(jResp,"custom_objects[i].url");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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}"
}
]
}