TCL / Support API / List Trigger Action and Condition Definitions
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/triggers/definitions" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "definitions": {
# "type": "object",
# "properties": {
# "actions": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "group": {
# "type": "string",
# "default": "<string>"
# },
# "nullable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "repeatable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "subject": {
# "type": "string",
# "default": "<string>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "type": {
# "type": "string",
# "default": "<string>"
# },
# "values": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "enabled": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# }
# }
# },
# "maxItems": 2
# },
# "conditions_all": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "group": {
# "type": "string",
# "default": "<string>"
# },
# "nullable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "operators": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "terminal": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "repeatable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "subject": {
# "type": "string",
# "default": "<string>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "type": {
# "type": "string",
# "default": "<string>"
# },
# "values": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "enabled": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# }
# }
# },
# "maxItems": 2
# },
# "conditions_any": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "group": {
# "type": "string",
# "default": "<string>"
# },
# "nullable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "operators": {
# "type": "array",
# "items": {
# "type": "object",
# "properties": {
# "terminal": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "value": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# },
# "repeatable": {
# "type": "boolean",
# "default": "<boolean>"
# },
# "subject": {
# "type": "string",
# "default": "<string>"
# },
# "title": {
# "type": "string",
# "default": "<string>"
# },
# "type": {
# "type": "string",
# "default": "<string>"
# }
# }
# },
# "maxItems": 2
# }
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set v_Type [CkJsonObject_stringOf $jResp "definitions.type"]
set ActionsType [CkJsonObject_stringOf $jResp "definitions.properties.actions.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.type"]
set GroupType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.group.type"]
set Default [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.group.default"]
set NullableType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.nullable.type"]
set NullableDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.nullable.default"]
set RepeatableType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.repeatable.type"]
set RepeatableDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.repeatable.default"]
set SubjectType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.subject.type"]
set SubjectDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.subject.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.title.default"]
set TypeType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.type.type"]
set TypeDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.type.default"]
set ValuesType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.type"]
set EnabledType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.enabled.type"]
set EnabledDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.enabled.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.actions.items.properties.values.items.properties.value.default"]
set MaxItems [CkJsonObject_IntOf $jResp "definitions.properties.actions.items.properties.values.maxItems"]
set ActionsMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.actions.maxItems"]
set Conditions_allType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.type"]
set GroupType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.group.type"]
set GroupDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.group.default"]
set NullableType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.nullable.type"]
set NullableDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.nullable.default"]
set OperatorsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.type"]
set TerminalType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.type"]
set TerminalDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.terminal.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.operators.items.properties.value.default"]
set OperatorsMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.conditions_all.items.properties.operators.maxItems"]
set RepeatableType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.repeatable.type"]
set RepeatableDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.repeatable.default"]
set SubjectType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.subject.type"]
set SubjectDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.subject.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.title.default"]
set TypeType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.type.type"]
set TypeDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.type.default"]
set ValuesType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.type"]
set EnabledType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.type"]
set EnabledDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.enabled.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_all.items.properties.values.items.properties.value.default"]
set ValuesMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.conditions_all.items.properties.values.maxItems"]
set Conditions_allMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.conditions_all.maxItems"]
set Conditions_anyType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.type"]
set GroupType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.group.type"]
set GroupDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.group.default"]
set NullableType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.nullable.type"]
set NullableDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.nullable.default"]
set OperatorsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.type"]
set ItemsType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.type"]
set TerminalType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.type"]
set TerminalDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.terminal.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.title.default"]
set ValueType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.value.type"]
set ValueDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.operators.items.properties.value.default"]
set OperatorsMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.conditions_any.items.properties.operators.maxItems"]
set RepeatableType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.repeatable.type"]
set RepeatableDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.repeatable.default"]
set SubjectType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.subject.type"]
set SubjectDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.subject.default"]
set TitleType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.title.type"]
set TitleDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.title.default"]
set TypeType [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.type.type"]
set TypeDefault [CkJsonObject_stringOf $jResp "definitions.properties.conditions_any.items.properties.type.default"]
set Conditions_anyMaxItems [CkJsonObject_IntOf $jResp "definitions.properties.conditions_any.maxItems"]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/definitions
Postman Collection Item JSON
{
"name": "List Trigger Action and Condition Definitions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"definitions"
]
},
"description": "Returns the definitions of the actions a trigger can perform and the\ndefinitions of the conditions under which a trigger can execute. The\ndefinition of the action includes a title (\"Status\"), a type (\"list\"), and\npossible values. The definition of the condition includes the same fields\nas well as the possible operators.\n\nFor a list of supported actions, see the [Actions reference](/documentation/ticketing/reference-guides/actions-reference)\nFor a list of supported conditions, see the [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)\n\n#### Allowed For\n\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/triggers/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"actions\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n },\n \"maxItems\": 2\n },\n \"conditions_all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"values\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"enabled\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n },\n \"maxItems\": 2\n },\n \"conditions_any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"group\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"nullable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"operators\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"terminal\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"value\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"repeatable\": {\n \"type\": \"boolean\",\n \"default\": \"<boolean>\"\n },\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"type\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}