Chilkat Online Tools

Node.js / Support API / Show Item

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";

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

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

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

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "item": {
    //     "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 content;
    var locale_id;
    var active;
    var created_at;
    var default;
    var id;
    var outdated;
    var updated_at;
    var url;

    var Name = jResp.StringOf("item.name");
    var Default_locale_id = jResp.StringOf("item.default_locale_id");
    var Created_at = jResp.StringOf("item.created_at");
    var Id = jResp.StringOf("item.id");
    var Outdated = jResp.StringOf("item.outdated");
    var Placeholder = jResp.StringOf("item.placeholder");
    var Updated_at = jResp.StringOf("item.updated_at");
    var v_Url = jResp.StringOf("item.url");
    var i = 0;
    var count_i = jResp.SizeOfArray("item.variants");
    while (i < count_i) {
        jResp.I = i;
        content = jResp.StringOf("item.variants[i].content");
        locale_id = jResp.StringOf("item.variants[i].locale_id");
        active = jResp.StringOf("item.variants[i].active");
        created_at = jResp.StringOf("item.variants[i].created_at");
        default = jResp.StringOf("item.variants[i].default");
        id = jResp.StringOf("item.variants[i].id");
        outdated = jResp.StringOf("item.variants[i].outdated");
        updated_at = jResp.StringOf("item.variants[i].updated_at");
        url = jResp.StringOf("item.variants[i].url");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id

Postman Collection Item JSON

{
  "name": "Show Item",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/:dynamic_content_item_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"item\": {\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}"
    }
  ]
}