Chilkat Online Tools

Delphi (ActiveX) / Support API / List Custom Object Records

Back to Collection Items

var

begin
http.BasicAuth := 1;http.Login := 'login';http.Password := 'password';queryParams.UpdateString('external_ids[]','<string>');queryParams.UpdateString('external_ids[]','<string>');resp.GetBodySb(sbResponseBody.ControlInterface);jResp.LoadSb(sbResponseBody.ControlInterface);jResp.EmitCompact := 0;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;

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}"
    }
  ]
}