Ruby / Support API / List Active Macros
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")
queryParams = Chilkat::CkJsonObject.new()
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 is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/macros/active",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
count = jResp.stringOf("count")
next_page = jResp.stringOf("next_page")
previous_page = jResp.stringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("macros")
while i < count_i
jResp.put_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.put_J(j)
field = jResp.stringOf("macros[i].actions[j].field")
value = jResp.stringOf("macros[i].actions[j].value")
j = j + 1
end
i = i + 1
end
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}"
}
]
}
