Chilkat Online Tools

Node.js / Support API / Show Many Custom Object Records

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "login";
    http.Password = "password";

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("ids","<string>");
    queryParams.UpdateString("ids","<string>");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/show_many",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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

    var name;
    var created_at;
    var created_by_user_id;
    var Voluptate571;
    var Aute_e;
    var Nostrud_6f;
    var custom_object_key;
    var external_id;
    var id;
    var updated_at;
    var updated_by_user_id;
    var url;
    var Eu4;

    var count = jResp.StringOf("count");
    var next_page = jResp.StringOf("next_page");
    var previous_page = jResp.StringOf("previous_page");
    var i = 0;
    var count_i = jResp.SizeOfArray("custom_object_records");
    while (i < count_i) {
        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;
    }


}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Many Custom Object Records",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/show_many?ids=<string>&ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "records",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Array of ids to retieve"
        },
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Array of ids to retieve"
        }
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        }
      ]
    },
    "description": "List multiple custom object records by their ids\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/show_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "records",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Array of ids to retieve"
            }
          ],
          "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}"
    }
  ]
}