Chilkat Online Tools

Node.js / Support API / Show Many Items

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("identifiers","<string>");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/dynamic_content/items/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)

    // {
    //   "items": [
    //     {
    //       "name": "<string>",
    //       "default_locale_id": "<integer>",
    //       "variants": [
    //         {
    //           "content": "<string>",
    //           "locale_id": "<integer>",
    //           "active": "<boolean>",
    //           "created_at": "<dateTime>",
    //           "default": "<boolean>",
    //           "id": "<integer>",
    //           "outdated": "<boolean>",
    //           "updated_at": "<dateTime>",
    //           "url": "<string>"
    //         },
    //         {
    //           "content": "<string>",
    //           "locale_id": "<integer>",
    //           "active": "<boolean>",
    //           "created_at": "<dateTime>",
    //           "default": "<boolean>",
    //           "id": "<integer>",
    //           "outdated": "<boolean>",
    //           "updated_at": "<dateTime>",
    //           "url": "<string>"
    //         }
    //       ],
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "outdated": "<boolean>",
    //       "placeholder": "<string>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>"
    //     },
    //     {
    //       "name": "<string>",
    //       "default_locale_id": "<integer>",
    //       "variants": [
    //         {
    //           "content": "<string>",
    //           "locale_id": "<integer>",
    //           "active": "<boolean>",
    //           "created_at": "<dateTime>",
    //           "default": "<boolean>",
    //           "id": "<integer>",
    //           "outdated": "<boolean>",
    //           "updated_at": "<dateTime>",
    //           "url": "<string>"
    //         },
    //         {
    //           "content": "<string>",
    //           "locale_id": "<integer>",
    //           "active": "<boolean>",
    //           "created_at": "<dateTime>",
    //           "default": "<boolean>",
    //           "id": "<integer>",
    //           "outdated": "<boolean>",
    //           "updated_at": "<dateTime>",
    //           "url": "<string>"
    //         }
    //       ],
    //       "created_at": "<dateTime>",
    //       "id": "<integer>",
    //       "outdated": "<boolean>",
    //       "placeholder": "<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

    var name;
    var default_locale_id;
    var created_at;
    var id;
    var outdated;
    var placeholder;
    var updated_at;
    var url;
    var j;
    var count_j;
    var content;
    var locale_id;
    var active;
    var default;

    var i = 0;
    var count_i = jResp.SizeOfArray("items");
    while (i < count_i) {
        jResp.I = i;
        name = jResp.StringOf("items[i].name");
        default_locale_id = jResp.StringOf("items[i].default_locale_id");
        created_at = jResp.StringOf("items[i].created_at");
        id = jResp.StringOf("items[i].id");
        outdated = jResp.StringOf("items[i].outdated");
        placeholder = jResp.StringOf("items[i].placeholder");
        updated_at = jResp.StringOf("items[i].updated_at");
        url = jResp.StringOf("items[i].url");
        j = 0;
        count_j = jResp.SizeOfArray("items[i].variants");
        while (j < count_j) {
            jResp.J = j;
            content = jResp.StringOf("items[i].variants[j].content");
            locale_id = jResp.StringOf("items[i].variants[j].locale_id");
            active = jResp.StringOf("items[i].variants[j].active");
            created_at = jResp.StringOf("items[i].variants[j].created_at");
            default = jResp.StringOf("items[i].variants[j].default");
            id = jResp.StringOf("items[i].variants[j].id");
            outdated = jResp.StringOf("items[i].variants[j].outdated");
            updated_at = jResp.StringOf("items[i].variants[j].updated_at");
            url = jResp.StringOf("items[i].variants[j].url");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -G -d "identifiers=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/show_many

Postman Collection Item JSON

{
  "name": "Show Many Items",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/show_many?identifiers=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        "show_many"
      ],
      "query": [
        {
          "key": "identifiers",
          "value": "<string>",
          "description": "Identifiers for the dynamic contents"
        }
      ]
    },
    "description": "#### Stability\n\n* Development\n\n#### Allowed For\n\n* Admins, Agents\n"
  },
  "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/dynamic_content/items/show_many?identifiers=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            "show_many"
          ],
          "query": [
            {
              "key": "identifiers",
              "value": "<string>",
              "description": "Identifiers for the dynamic contents"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"items\": [\n    {\n      \"name\": \"<string>\",\n      \"default_locale_id\": \"<integer>\",\n      \"variants\": [\n        {\n          \"content\": \"<string>\",\n          \"locale_id\": \"<integer>\",\n          \"active\": \"<boolean>\",\n          \"created_at\": \"<dateTime>\",\n          \"default\": \"<boolean>\",\n          \"id\": \"<integer>\",\n          \"outdated\": \"<boolean>\",\n          \"updated_at\": \"<dateTime>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"content\": \"<string>\",\n          \"locale_id\": \"<integer>\",\n          \"active\": \"<boolean>\",\n          \"created_at\": \"<dateTime>\",\n          \"default\": \"<boolean>\",\n          \"id\": \"<integer>\",\n          \"outdated\": \"<boolean>\",\n          \"updated_at\": \"<dateTime>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"outdated\": \"<boolean>\",\n      \"placeholder\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"default_locale_id\": \"<integer>\",\n      \"variants\": [\n        {\n          \"content\": \"<string>\",\n          \"locale_id\": \"<integer>\",\n          \"active\": \"<boolean>\",\n          \"created_at\": \"<dateTime>\",\n          \"default\": \"<boolean>\",\n          \"id\": \"<integer>\",\n          \"outdated\": \"<boolean>\",\n          \"updated_at\": \"<dateTime>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"content\": \"<string>\",\n          \"locale_id\": \"<integer>\",\n          \"active\": \"<boolean>\",\n          \"created_at\": \"<dateTime>\",\n          \"default\": \"<boolean>\",\n          \"id\": \"<integer>\",\n          \"outdated\": \"<boolean>\",\n          \"updated_at\": \"<dateTime>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"outdated\": \"<boolean>\",\n      \"placeholder\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}