Chilkat Online Tools

Node.js / Support API / Show Workspace

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/workspaces/:workspace_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)

    // {
    //   "workspace": {
    //     "activated": "<boolean>",
    //     "apps": [
    //       {
    //         "ad_be": true,
    //         "ead07": 69455617,
    //         "adipisicinga": true
    //       },
    //       {
    //         "fugiat_e": false,
    //         "dolorf7": -57129708.70016649
    //       }
    //     ],
    //     "conditions": {
    //       "all": [
    //         {
    //           "field": "<string>",
    //           "operator": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "operator": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "any": [
    //         {
    //           "field": "<string>",
    //           "operator": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "operator": "<string>",
    //           "value": "<string>"
    //         }
    //       ]
    //     },
    //     "created_at": "<dateTime>",
    //     "description": "<string>",
    //     "id": "<integer>",
    //     "macro_ids": [
    //       "<integer>",
    //       "<integer>"
    //     ],
    //     "macros": [
    //       "<integer>",
    //       "<integer>"
    //     ],
    //     "position": "<integer>",
    //     "prefer_workspace_app_order": "<boolean>",
    //     "selected_macros": [
    //       {
    //         "actions": [
    //           {
    //             "field": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "value": "<string>"
    //           }
    //         ],
    //         "title": "<string>",
    //         "active": "<boolean>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "description": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "restriction": {
    //           "in_f25": true,
    //           "nisid81": "reprehenderit anim nostrud id",
    //           "minim_886": false
    //         },
    //         "updated_at": "<dateTime>",
    //         "url": "<string>",
    //         "app_installation": "<string>",
    //         "categories": "<string>",
    //         "permissions": "<string>",
    //         "usage_1h": "<integer>",
    //         "usage_7d": "<integer>",
    //         "usage_24h": "<integer>",
    //         "usage_30d": "<integer>"
    //       },
    //       {
    //         "actions": [
    //           {
    //             "field": "<string>",
    //             "value": "<string>"
    //           },
    //           {
    //             "field": "<string>",
    //             "value": "<string>"
    //           }
    //         ],
    //         "title": "<string>",
    //         "active": "<boolean>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "description": "<string>",
    //         "id": "<integer>",
    //         "position": "<integer>",
    //         "restriction": {
    //           "culpa__d7": false,
    //           "ad7": true,
    //           "esse0": -82046233.9137964,
    //           "veniam_f": -91185504
    //         },
    //         "updated_at": "<dateTime>",
    //         "url": "<string>",
    //         "app_installation": "<string>",
    //         "categories": "<string>",
    //         "permissions": "<string>",
    //         "usage_1h": "<integer>",
    //         "usage_7d": "<integer>",
    //         "usage_24h": "<integer>",
    //         "usage_30d": "<integer>"
    //       }
    //     ],
    //     "ticket_form_id": "<integer>",
    //     "title": "<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 ad_be;
    var ead07;
    var adipisicinga;
    var fugiat_e;
    var dolorf7;
    var field;
    var operator;
    var value;
    var strVal;
    var title;
    var active;
    var created_at;
    var default;
    var description;
    var id;
    var position;
    var In_f25;
    var Nisid81;
    var Minim_886;
    var updated_at;
    var url;
    var app_installation;
    var categories;
    var permissions;
    var usage_1h;
    var usage_7d;
    var usage_24h;
    var usage_30d;
    var Culpa__d7;
    var Ad7;
    var Esse0;
    var Veniam_f;
    var j;
    var count_j;

    var Activated = jResp.StringOf("workspace.activated");
    var Created_at = jResp.StringOf("workspace.created_at");
    var Description = jResp.StringOf("workspace.description");
    var Id = jResp.StringOf("workspace.id");
    var Position = jResp.StringOf("workspace.position");
    var Prefer_workspace_app_order = jResp.StringOf("workspace.prefer_workspace_app_order");
    var Ticket_form_id = jResp.StringOf("workspace.ticket_form_id");
    var Title = jResp.StringOf("workspace.title");
    var Updated_at = jResp.StringOf("workspace.updated_at");
    var v_Url = jResp.StringOf("workspace.url");
    var i = 0;
    var count_i = jResp.SizeOfArray("workspace.apps");
    while (i < count_i) {
        jResp.I = i;
        ad_be = jResp.BoolOf("workspace.apps[i].ad_be");
        ead07 = jResp.IntOf("workspace.apps[i].ead07");
        adipisicinga = jResp.BoolOf("workspace.apps[i].adipisicinga");
        fugiat_e = jResp.BoolOf("workspace.apps[i].fugiat_e");
        dolorf7 = jResp.StringOf("workspace.apps[i].dolorf7");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("workspace.conditions.all");
    while (i < count_i) {
        jResp.I = i;
        field = jResp.StringOf("workspace.conditions.all[i].field");
        operator = jResp.StringOf("workspace.conditions.all[i].operator");
        value = jResp.StringOf("workspace.conditions.all[i].value");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("workspace.conditions.any");
    while (i < count_i) {
        jResp.I = i;
        field = jResp.StringOf("workspace.conditions.any[i].field");
        operator = jResp.StringOf("workspace.conditions.any[i].operator");
        value = jResp.StringOf("workspace.conditions.any[i].value");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("workspace.macro_ids");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("workspace.macro_ids[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("workspace.macros");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("workspace.macros[i]");
        i = i+1;
    }

    i = 0;
    count_i = jResp.SizeOfArray("workspace.selected_macros");
    while (i < count_i) {
        jResp.I = i;
        title = jResp.StringOf("workspace.selected_macros[i].title");
        active = jResp.StringOf("workspace.selected_macros[i].active");
        created_at = jResp.StringOf("workspace.selected_macros[i].created_at");
        default = jResp.StringOf("workspace.selected_macros[i].default");
        description = jResp.StringOf("workspace.selected_macros[i].description");
        id = jResp.StringOf("workspace.selected_macros[i].id");
        position = jResp.StringOf("workspace.selected_macros[i].position");
        In_f25 = jResp.BoolOf("workspace.selected_macros[i].restriction.in_f25");
        Nisid81 = jResp.StringOf("workspace.selected_macros[i].restriction.nisid81");
        Minim_886 = jResp.BoolOf("workspace.selected_macros[i].restriction.minim_886");
        updated_at = jResp.StringOf("workspace.selected_macros[i].updated_at");
        url = jResp.StringOf("workspace.selected_macros[i].url");
        app_installation = jResp.StringOf("workspace.selected_macros[i].app_installation");
        categories = jResp.StringOf("workspace.selected_macros[i].categories");
        permissions = jResp.StringOf("workspace.selected_macros[i].permissions");
        usage_1h = jResp.StringOf("workspace.selected_macros[i].usage_1h");
        usage_7d = jResp.StringOf("workspace.selected_macros[i].usage_7d");
        usage_24h = jResp.StringOf("workspace.selected_macros[i].usage_24h");
        usage_30d = jResp.StringOf("workspace.selected_macros[i].usage_30d");
        Culpa__d7 = jResp.BoolOf("workspace.selected_macros[i].restriction.culpa__d7");
        Ad7 = jResp.BoolOf("workspace.selected_macros[i].restriction.ad7");
        Esse0 = jResp.StringOf("workspace.selected_macros[i].restriction.esse0");
        Veniam_f = jResp.IntOf("workspace.selected_macros[i].restriction.veniam_f");
        j = 0;
        count_j = jResp.SizeOfArray("workspace.selected_macros[i].actions");
        while (j < count_j) {
            jResp.J = j;
            field = jResp.StringOf("workspace.selected_macros[i].actions[j].field");
            value = jResp.StringOf("workspace.selected_macros[i].actions[j].value");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Workspace",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/workspaces/:workspace_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "workspaces",
        ":workspace_id"
      ],
      "variable": [
        {
          "key": "workspace_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n* Admins\n"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/workspaces/:workspace_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "workspaces",
            ":workspace_id"
          ],
          "variable": [
            {
              "key": "workspace_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"workspace\": {\n    \"activated\": \"<boolean>\",\n    \"apps\": [\n      {\n        \"ad_be\": true,\n        \"ead07\": 69455617,\n        \"adipisicinga\": true\n      },\n      {\n        \"fugiat_e\": false,\n        \"dolorf7\": -57129708.70016649\n      }\n    ],\n    \"conditions\": {\n      \"all\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"any\": [\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"field\": \"<string>\",\n          \"operator\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    },\n    \"created_at\": \"<dateTime>\",\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"macro_ids\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"macros\": [\n      \"<integer>\",\n      \"<integer>\"\n    ],\n    \"position\": \"<integer>\",\n    \"prefer_workspace_app_order\": \"<boolean>\",\n    \"selected_macros\": [\n      {\n        \"actions\": [\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"title\": \"<string>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"restriction\": {\n          \"in_f25\": true,\n          \"nisid81\": \"reprehenderit anim nostrud id\",\n          \"minim_886\": false\n        },\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\",\n        \"app_installation\": \"<string>\",\n        \"categories\": \"<string>\",\n        \"permissions\": \"<string>\",\n        \"usage_1h\": \"<integer>\",\n        \"usage_7d\": \"<integer>\",\n        \"usage_24h\": \"<integer>\",\n        \"usage_30d\": \"<integer>\"\n      },\n      {\n        \"actions\": [\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"title\": \"<string>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"description\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"restriction\": {\n          \"culpa__d7\": false,\n          \"ad7\": true,\n          \"esse0\": -82046233.9137964,\n          \"veniam_f\": -91185504\n        },\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\",\n        \"app_installation\": \"<string>\",\n        \"categories\": \"<string>\",\n        \"permissions\": \"<string>\",\n        \"usage_1h\": \"<integer>\",\n        \"usage_7d\": \"<integer>\",\n        \"usage_24h\": \"<integer>\",\n        \"usage_30d\": \"<integer>\"\n      }\n    ],\n    \"ticket_form_id\": \"<integer>\",\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}