Chilkat Online Tools

Node.js / Support API / List Active Macros

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("include","<string>");
    queryParams.UpdateString("access","<string>");
    queryParams.UpdateString("category","<integer>");
    queryParams.UpdateString("group_id","<integer>");
    queryParams.UpdateString("sort_by","<string>");
    queryParams.UpdateString("sort_order","<string>");

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

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

    // {
    //   "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": {
    //         "proidentf9": true
    //       },
    //       "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": {
    //         "deserunt_": false,
    //         "exercitation2": -75718943,
    //         "eiusmodeaf": 24563232.4790345,
    //         "estf5": "aute",
    //         "minim24": -78305859
    //       },
    //       "updated_at": "<dateTime>",
    //       "url": "<string>",
    //       "app_installation": "<string>",
    //       "categories": "<string>",
    //       "permissions": "<string>",
    //       "usage_1h": "<integer>",
    //       "usage_7d": "<integer>",
    //       "usage_24h": "<integer>",
    //       "usage_30d": "<integer>"
    //     }
    //   ],
    //   "count": "<integer>",
    //   "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 title;
    var active;
    var created_at;
    var default;
    var description;
    var id;
    var position;
    var Proidentf9;
    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 Deserunt_;
    var Exercitation2;
    var Eiusmodeaf;
    var Estf5;
    var Minim24;
    var j;
    var count_j;
    var field;
    var value;

    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("macros");
    while (i < count_i) {
        jResp.I = i;
        title = jResp.StringOf("macros[i].title");
        active = jResp.StringOf("macros[i].active");
        created_at = jResp.StringOf("macros[i].created_at");
        default = jResp.StringOf("macros[i].default");
        description = jResp.StringOf("macros[i].description");
        id = jResp.StringOf("macros[i].id");
        position = jResp.StringOf("macros[i].position");
        Proidentf9 = jResp.BoolOf("macros[i].restriction.proidentf9");
        updated_at = jResp.StringOf("macros[i].updated_at");
        url = jResp.StringOf("macros[i].url");
        app_installation = jResp.StringOf("macros[i].app_installation");
        categories = jResp.StringOf("macros[i].categories");
        permissions = jResp.StringOf("macros[i].permissions");
        usage_1h = jResp.StringOf("macros[i].usage_1h");
        usage_7d = jResp.StringOf("macros[i].usage_7d");
        usage_24h = jResp.StringOf("macros[i].usage_24h");
        usage_30d = jResp.StringOf("macros[i].usage_30d");
        Deserunt_ = jResp.BoolOf("macros[i].restriction.deserunt_");
        Exercitation2 = jResp.IntOf("macros[i].restriction.exercitation2");
        Eiusmodeaf = jResp.StringOf("macros[i].restriction.eiusmodeaf");
        Estf5 = jResp.StringOf("macros[i].restriction.estf5");
        Minim24 = jResp.IntOf("macros[i].restriction.minim24");
        j = 0;
        count_j = jResp.SizeOfArray("macros[i].actions");
        while (j < count_j) {
            jResp.J = j;
            field = jResp.StringOf("macros[i].actions[j].field");
            value = jResp.StringOf("macros[i].actions[j].value");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

curl  -u login:password -G -d "include=%3Cstring%3E"
	-d "access=%3Cstring%3E"
	-d "category=%3Cinteger%3E"
	-d "group_id=%3Cinteger%3E"
	-d "sort_by=%3Cstring%3E"
	-d "sort_order=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/macros/active

Postman Collection Item JSON

{
  "name": "List Active Macros",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/active?include=<string>&access=<string>&category=<integer>&group_id=<integer>&sort_by=<string>&sort_order=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        "active"
      ],
      "query": [
        {
          "key": "include",
          "value": "<string>",
          "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
        },
        {
          "key": "access",
          "value": "<string>",
          "description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
        },
        {
          "key": "category",
          "value": "<integer>",
          "description": "Filter macros by category"
        },
        {
          "key": "group_id",
          "value": "<integer>",
          "description": "Filter macros by group"
        },
        {
          "key": "sort_by",
          "value": "<string>",
          "description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
        },
        {
          "key": "sort_order",
          "value": "<string>",
          "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
        }
      ]
    },
    "description": "Lists all active shared and personal macros available to the current user.\n\n#### Allowed For\n* 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/macros/active?include=<string>&access=<string>&category=<integer>&group_id=<integer>&sort_by=<string>&sort_order=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            "active"
          ],
          "query": [
            {
              "key": "include",
              "value": "<string>",
              "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
            },
            {
              "key": "access",
              "value": "<string>",
              "description": "Filter macros by access. Possible values are \"personal\", \"shared\", or \"account\""
            },
            {
              "key": "category",
              "value": "<integer>",
              "description": "Filter macros by category"
            },
            {
              "key": "group_id",
              "value": "<integer>",
              "description": "Filter macros by group"
            },
            {
              "key": "sort_by",
              "value": "<string>",
              "description": "Possible values are alphabetical, \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical"
            },
            {
              "key": "sort_order",
              "value": "<string>",
              "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"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        \"proidentf9\": true\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        \"deserunt_\": false,\n        \"exercitation2\": -75718943,\n        \"eiusmodeaf\": 24563232.4790345,\n        \"estf5\": \"aute\",\n        \"minim24\": -78305859\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  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}