Ruby / Support API / List Trigger Categories
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("page[after]","<string>")
queryParams.UpdateString("page[before]","<string>")
queryParams.UpdateString("page[size]","<integer>")
queryParams.UpdateString("sort","-updated_at")
queryParams.UpdateString("include","rule_counts")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/trigger_categories",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)
# {
# "trigger_categories": [
# {
# "active_count": "<long>",
# "inactive_count": "<long>"
# },
# {
# "active_count": "<long>",
# "inactive_count": "<long>"
# }
# ],
# "links": {
# "next": "<string>",
# "prev": "<string>"
# },
# "meta": {
# "after_cursor": "<string>",
# "before_cursor": "<string>",
# "has_more": "<boolean>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Next = jResp.stringOf("links.next")
Prev = jResp.stringOf("links.prev")
After_cursor = jResp.stringOf("meta.after_cursor")
Before_cursor = jResp.stringOf("meta.before_cursor")
Has_more = jResp.stringOf("meta.has_more")
i = 0
count_i = jResp.SizeOfArray("trigger_categories")
while i < count_i
jResp.put_I(i)
active_count = jResp.stringOf("trigger_categories[i].active_count")
inactive_count = jResp.stringOf("trigger_categories[i].inactive_count")
i = i + 1
end
Curl Command
curl -u login:password -G -d "page[after]=%3Cstring%3E"
-d "page[before]=%3Cstring%3E"
-d "page[size]=%3Cinteger%3E"
-d "sort=-updated_at"
-d "include=rule_counts"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/trigger_categories
Postman Collection Item JSON
{
"name": "List Trigger Categories",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
},
"description": "Returns all the trigger categories in the account."
},
"response": [
{
"name": "A paged array of trigger categories",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger_categories\": [\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n },\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\",\n \"prev\": \"<string>\"\n },\n \"meta\": {\n \"after_cursor\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"has_more\": \"<boolean>\"\n }\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
