Chilkat Online Tools

delphiAx / Support API / List Custom Object Records

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
name: WideString;
created_at: WideString;
created_by_user_id: WideString;
Voluptate571: WideString;
Aute_e: WideString;
Nostrud_6f: WideString;
custom_object_key: WideString;
external_id: WideString;
id: WideString;
updated_at: WideString;
updated_by_user_id: WideString;
url: WideString;
Eu4: WideString;
count: WideString;
next_page: WideString;
previous_page: WideString;
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 := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('external_ids[]','<string>');
queryParams.UpdateString('external_ids[]','<string>');

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

resp := http.QuickRequestParams('GET','https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

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

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

// {
//   "count": "<integer>",
//   "custom_object_records": [
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "created_by_user_id": "<string>",
//       "custom_object_fields": {
//         "voluptate571": "<string>",
//         "aute_e": "<string>",
//         "nostrud_6f": "<string>"
//       },
//       "custom_object_key": "<string>",
//       "external_id": "<string>",
//       "id": "<string>",
//       "updated_at": "<dateTime>",
//       "updated_by_user_id": "<string>",
//       "url": "<string>"
//     },
//     {
//       "name": "<string>",
//       "created_at": "<dateTime>",
//       "created_by_user_id": "<string>",
//       "custom_object_fields": {
//         "eu4": "<string>"
//       },
//       "custom_object_key": "<string>",
//       "external_id": "<string>",
//       "id": "<string>",
//       "updated_at": "<dateTime>",
//       "updated_by_user_id": "<string>",
//       "url": "<string>"
//     }
//   ],
//   "next_page": "<string>",
//   "previous_page": "<string>"
// }

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

count := jResp.StringOf('count');
next_page := jResp.StringOf('next_page');
previous_page := jResp.StringOf('previous_page');
i := 0;
count_i := jResp.SizeOfArray('custom_object_records');
while i < count_i do
  begin
    jResp.I := i;
    name := jResp.StringOf('custom_object_records[i].name');
    created_at := jResp.StringOf('custom_object_records[i].created_at');
    created_by_user_id := jResp.StringOf('custom_object_records[i].created_by_user_id');
    Voluptate571 := jResp.StringOf('custom_object_records[i].custom_object_fields.voluptate571');
    Aute_e := jResp.StringOf('custom_object_records[i].custom_object_fields.aute_e');
    Nostrud_6f := jResp.StringOf('custom_object_records[i].custom_object_fields.nostrud_6f');
    custom_object_key := jResp.StringOf('custom_object_records[i].custom_object_key');
    external_id := jResp.StringOf('custom_object_records[i].external_id');
    id := jResp.StringOf('custom_object_records[i].id');
    updated_at := jResp.StringOf('custom_object_records[i].updated_at');
    updated_by_user_id := jResp.StringOf('custom_object_records[i].updated_by_user_id');
    url := jResp.StringOf('custom_object_records[i].url');
    Eu4 := jResp.StringOf('custom_object_records[i].custom_object_fields.eu4');
    i := i + 1;
  end;

Curl Command

curl  -u login:password -G -d "external_ids[]=%3Cstring%3E"
	-d "external_ids[]=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records

Postman Collection Item JSON

{
  "name": "List Custom Object Records",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records?external_ids[]=<string>&external_ids[]=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "records"
      ],
      "query": [
        {
          "key": "external_ids[]",
          "value": "<string>",
          "description": "Optional parameter to search records by external ids. If one or more ids are specified, only matching records will be returned. These ids are unique and case sencitive"
        },
        {
          "key": "external_ids[]",
          "value": "<string>",
          "description": "Optional parameter to search records by external ids. If one or more ids are specified, only matching records will be returned. These ids are unique and case sencitive"
        }
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "Lists all undeleted custom object records 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/records?external_ids[]=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "records"
          ],
          "query": [
            {
              "key": "external_ids[]",
              "value": "<string>",
              "description": "Optional parameter to search records by external ids. If one or more ids are specified, only matching records will be returned. These ids are unique and case sencitive"
            }
          ],
          "variable": [
            {
              "key": "custom_object_key"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"custom_object_records\": [\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"custom_object_fields\": {\n        \"voluptate571\": \"<string>\",\n        \"aute_e\": \"<string>\",\n        \"nostrud_6f\": \"<string>\"\n      },\n      \"custom_object_key\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"created_by_user_id\": \"<string>\",\n      \"custom_object_fields\": {\n        \"eu4\": \"<string>\"\n      },\n      \"custom_object_key\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_by_user_id\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}