Foxpro / Support API / List Automations
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_title
LOCAL lcTitle
LOCAL lcUpdated_at
LOCAL j
LOCAL lnCount_j
LOCAL lcField
LOCAL lcValue
LOCAL lcOperator
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/automations",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("automations")
DO WHILE i < lnCount_i
loJResp.I = i
lcActive = loJResp.StringOf("automations[i].active")
lcCreated_at = loJResp.StringOf("automations[i].created_at")
lcDefault = loJResp.StringOf("automations[i].default")
lcId = loJResp.StringOf("automations[i].id")
lcPosition = loJResp.StringOf("automations[i].position")
lcRaw_title = loJResp.StringOf("automations[i].raw_title")
lcTitle = loJResp.StringOf("automations[i].title")
lcUpdated_at = loJResp.StringOf("automations[i].updated_at")
j = 0
lnCount_j = loJResp.SizeOfArray("automations[i].actions")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("automations[i].actions[j].field")
lcValue = loJResp.StringOf("automations[i].actions[j].value")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("automations[i].conditions.all")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("automations[i].conditions.all[j].field")
lcOperator = loJResp.StringOf("automations[i].conditions.all[j].operator")
lcValue = loJResp.StringOf("automations[i].conditions.all[j].value")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("automations[i].conditions.any")
DO WHILE j < lnCount_j
loJResp.J = j
lcField = loJResp.StringOf("automations[i].conditions.any[j].field")
lcOperator = loJResp.StringOf("automations[i].conditions.any[j].operator")
lcValue = loJResp.StringOf("automations[i].conditions.any[j].value")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/automations
Postman Collection Item JSON
{
"name": "List Automations",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/automations",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations"
]
},
"description": "Lists all automations for the current account.\n\n#### Allowed For\n\n* Agents\n\n#### Available Parameters\n\nYou can pass in any combination of the following optional filters:\n\n| Name | Type | Comment\n| ---------- | ------- | -------\n| active | boolean | Only active automations if true, inactive automations if false\n| sort_by | string | Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"\n| sort_order | string | One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others\n\n#### Sideloads\n\nThe following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.\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\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"automations"
]
}
},
"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}"
}
]
}
