Ruby / Support API / Search Automations
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("query","<string>")
queryParams.UpdateString("active","<boolean>")
queryParams.UpdateString("sort_by","<string>")
queryParams.UpdateString("sort_order","<string>")
queryParams.UpdateString("include","<string>")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/automations/search",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)
# {
# "automations": [
# {
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "active": "<boolean>",
# "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>",
# "default": "<boolean>",
# "id": "<integer>",
# "position": "<integer>",
# "raw_title": "<string>",
# "title": "<string>",
# "updated_at": "<dateTime>"
# },
# {
# "actions": [
# {
# "field": "<string>",
# "value": "<string>"
# },
# {
# "field": "<string>",
# "value": "<string>"
# }
# ],
# "active": "<boolean>",
# "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>",
# "default": "<boolean>",
# "id": "<integer>",
# "position": "<integer>",
# "raw_title": "<string>",
# "title": "<string>",
# "updated_at": "<dateTime>"
# }
# ],
# "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("automations")
while i < count_i
jResp.put_I(i)
active = jResp.stringOf("automations[i].active")
created_at = jResp.stringOf("automations[i].created_at")
default = jResp.stringOf("automations[i].default")
id = jResp.stringOf("automations[i].id")
position = jResp.stringOf("automations[i].position")
raw_title = jResp.stringOf("automations[i].raw_title")
title = jResp.stringOf("automations[i].title")
updated_at = jResp.stringOf("automations[i].updated_at")
j = 0
count_j = jResp.SizeOfArray("automations[i].actions")
while j < count_j
jResp.put_J(j)
field = jResp.stringOf("automations[i].actions[j].field")
value = jResp.stringOf("automations[i].actions[j].value")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.all")
while j < count_j
jResp.put_J(j)
field = jResp.stringOf("automations[i].conditions.all[j].field")
operator = jResp.stringOf("automations[i].conditions.all[j].operator")
value = jResp.stringOf("automations[i].conditions.all[j].value")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("automations[i].conditions.any")
while j < count_j
jResp.put_J(j)
field = jResp.stringOf("automations[i].conditions.any[j].field")
operator = jResp.stringOf("automations[i].conditions.any[j].operator")
value = jResp.stringOf("automations[i].conditions.any[j].value")
j = j + 1
end
i = i + 1
end
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "active=%3Cboolean%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-d "include=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations/search
Postman Collection Item JSON
{
"name": "Search Automations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations/search?query=<string>&active=<boolean>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all automations with matching title"
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active automations if true or inactive automations if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the automations are sorted by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
}
]
},
"description": "#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Allowed For\n\n* Agents\n\n#### Sideloads\n\nThe following sideloads are supported. For more information, see [Side-loading](/documentation/ticketing/using-the-zendesk-api/side_loading/).\n\n| Name | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each automation, if present\n| permissions | The permissions for each automation\n| usage_1h | The number of times each automation has been used in the past hour\n| usage_24h | The number of times each automation has been used in the past day\n| usage_7d | The number of times each automation has been used in the past week\n| usage_30d | The number of times each automation has been used in the past thirty days\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/automations/search?query=<string>&active=<boolean>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all automations with matching title"
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active automations if true or inactive automations if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the automations are sorted by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-2)"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"automations\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\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 \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"active\": \"<boolean>\",\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 \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
