Chilkat Tools

delphiDll / Support API / List Custom Object Fields

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
key: PWideChar;
v_type: PWideChar;
title: PWideChar;
active: PWideChar;
created_at: PWideChar;
description: PWideChar;
id: PWideChar;
position: PWideChar;
raw_description: PWideChar;
raw_title: PWideChar;
regexp_for_validation: PWideChar;
relationship_target_type: PWideChar;
system: PWideChar;
tag: PWideChar;
updated_at: PWideChar;
url: PWideChar;
j: Integer;
count_j: Integer;
name: PWideChar;
value: PWideChar;
raw_name: PWideChar;
i: Integer;
count_i: Integer;

begin
// 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/:custom_object_key/fields',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

// {
//   "custom_object_fields": [
//     {
//       "key": "<string>",
//       "type": "<string>",
//       "title": "<string>",
//       "active": "<boolean>",
//       "created_at": "<dateTime>",
//       "custom_field_options": [
//         {
//           "name": "<string>",
//           "value": "<string>",
//           "id": "<integer>",
//           "position": "<integer>",
//           "raw_name": "<string>",
//           "url": "<string>"
//         },
//         {
//           "name": "<string>",
//           "value": "<string>",
//           "id": "<integer>",
//           "position": "<integer>",
//           "raw_name": "<string>",
//           "url": "<string>"
//         }
//       ],
//       "description": "<string>",
//       "id": "<integer>",
//       "position": "<integer>",
//       "raw_description": "<string>",
//       "raw_title": "<string>",
//       "regexp_for_validation": "<string>",
//       "relationship_filter": {},
//       "relationship_target_type": "<string>",
//       "system": "<boolean>",
//       "tag": "<string>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     },
//     {
//       "key": "<string>",
//       "type": "<string>",
//       "title": "<string>",
//       "active": "<boolean>",
//       "created_at": "<dateTime>",
//       "custom_field_options": [
//         {
//           "name": "<string>",
//           "value": "<string>",
//           "id": "<integer>",
//           "position": "<integer>",
//           "raw_name": "<string>",
//           "url": "<string>"
//         },
//         {
//           "name": "<string>",
//           "value": "<string>",
//           "id": "<integer>",
//           "position": "<integer>",
//           "raw_name": "<string>",
//           "url": "<string>"
//         }
//       ],
//       "description": "<string>",
//       "id": "<integer>",
//       "position": "<integer>",
//       "raw_description": "<string>",
//       "raw_title": "<string>",
//       "regexp_for_validation": "<string>",
//       "relationship_filter": {},
//       "relationship_target_type": "<string>",
//       "system": "<boolean>",
//       "tag": "<string>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     }
//   ]
// }

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

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'custom_object_fields');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    key := CkJsonObject__stringOf(jResp,'custom_object_fields[i].key');
    v_type := CkJsonObject__stringOf(jResp,'custom_object_fields[i].type');
    title := CkJsonObject__stringOf(jResp,'custom_object_fields[i].title');
    active := CkJsonObject__stringOf(jResp,'custom_object_fields[i].active');
    created_at := CkJsonObject__stringOf(jResp,'custom_object_fields[i].created_at');
    description := CkJsonObject__stringOf(jResp,'custom_object_fields[i].description');
    id := CkJsonObject__stringOf(jResp,'custom_object_fields[i].id');
    position := CkJsonObject__stringOf(jResp,'custom_object_fields[i].position');
    raw_description := CkJsonObject__stringOf(jResp,'custom_object_fields[i].raw_description');
    raw_title := CkJsonObject__stringOf(jResp,'custom_object_fields[i].raw_title');
    regexp_for_validation := CkJsonObject__stringOf(jResp,'custom_object_fields[i].regexp_for_validation');
    relationship_target_type := CkJsonObject__stringOf(jResp,'custom_object_fields[i].relationship_target_type');
    system := CkJsonObject__stringOf(jResp,'custom_object_fields[i].system');
    tag := CkJsonObject__stringOf(jResp,'custom_object_fields[i].tag');
    updated_at := CkJsonObject__stringOf(jResp,'custom_object_fields[i].updated_at');
    url := CkJsonObject__stringOf(jResp,'custom_object_fields[i].url');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'custom_object_fields[i].custom_field_options');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        name := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].name');
        value := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].value');
        id := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].id');
        position := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].position');
        raw_name := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].raw_name');
        url := CkJsonObject__stringOf(jResp,'custom_object_fields[i].custom_field_options[j].url');
        j := j + 1;
      end;

    i := i + 1;
  end;

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/:custom_object_key/fields

Postman Collection Item JSON

{
  "name": "List Custom Object Fields",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "fields"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "Lists all undeleted custom fields for the specified object.\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/:custom_object_key/fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "fields"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"type\": \"<string>\",\n      \"title\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"custom_field_options\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"regexp_for_validation\": \"<string>\",\n      \"relationship_filter\": {},\n      \"relationship_target_type\": \"<string>\",\n      \"system\": \"<boolean>\",\n      \"tag\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"type\": \"<string>\",\n      \"title\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"custom_field_options\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"regexp_for_validation\": \"<string>\",\n      \"relationship_filter\": {},\n      \"relationship_target_type\": \"<string>\",\n      \"system\": \"<boolean>\",\n      \"tag\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}

Chilkat Online Tools

delphiDll / Support API / List Custom Object Fields

Curl Command

Postman Collection Item JSON