PowerBuilder / Support API / Search Triggers
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Title
string ls_Active
string ls_Category_id
string ls_Created_at
string ls_Default
string ls_Description
string ls_Id
string ls_Position
string ls_Raw_title
string ls_Updated_at
string ls_Url
integer j
integer li_Count_j
string ls_Field
string ls_Operator
string ls_Value
string ls_Count
string ls_Next_page
string ls_Previous_page
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("query","<string>")
loo_QueryParams.UpdateString("json","[object Object]")
loo_QueryParams.UpdateString("active","<boolean>")
loo_QueryParams.UpdateString("sort_by","<string>")
loo_QueryParams.UpdateString("sort_order","<string>")
loo_QueryParams.UpdateString("include","<string>")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/triggers/search",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>",
// "triggers": [
// {
// "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>"
// }
// ]
// },
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "category_id": "<string>",
// "created_at": "<string>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// },
// {
// "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>"
// }
// ]
// },
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "category_id": "<string>",
// "created_at": "<string>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "raw_title": "<string>",
// "updated_at": "<string>",
// "url": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Count = loo_JResp.StringOf("count")
ls_Next_page = loo_JResp.StringOf("next_page")
ls_Previous_page = loo_JResp.StringOf("previous_page")
i = 0
li_Count_i = loo_JResp.SizeOfArray("triggers")
do while i < li_Count_i
loo_JResp.I = i
ls_Title = loo_JResp.StringOf("triggers[i].title")
ls_Active = loo_JResp.StringOf("triggers[i].active")
ls_Category_id = loo_JResp.StringOf("triggers[i].category_id")
ls_Created_at = loo_JResp.StringOf("triggers[i].created_at")
ls_Default = loo_JResp.StringOf("triggers[i].default")
ls_Description = loo_JResp.StringOf("triggers[i].description")
ls_Id = loo_JResp.StringOf("triggers[i].id")
ls_Position = loo_JResp.StringOf("triggers[i].position")
ls_Raw_title = loo_JResp.StringOf("triggers[i].raw_title")
ls_Updated_at = loo_JResp.StringOf("triggers[i].updated_at")
ls_Url = loo_JResp.StringOf("triggers[i].url")
j = 0
li_Count_j = loo_JResp.SizeOfArray("triggers[i].conditions.all")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("triggers[i].conditions.all[j].field")
ls_Operator = loo_JResp.StringOf("triggers[i].conditions.all[j].operator")
ls_Value = loo_JResp.StringOf("triggers[i].conditions.all[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("triggers[i].conditions.any")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("triggers[i].conditions.any[j].field")
ls_Operator = loo_JResp.StringOf("triggers[i].conditions.any[j].operator")
ls_Value = loo_JResp.StringOf("triggers[i].conditions.any[j].value")
j = j + 1
loop
j = 0
li_Count_j = loo_JResp.SizeOfArray("triggers[i].actions")
do while j < li_Count_j
loo_JResp.J = j
ls_Field = loo_JResp.StringOf("triggers[i].actions[j].field")
ls_Value = loo_JResp.StringOf("triggers[i].actions[j].value")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "json=%5Bobject%20Object%5D"
-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/triggers/search
Postman Collection Item JSON
{
"name": "Search Triggers",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/triggers/search?query=<string>&json=[object Object]&active=<boolean>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all triggers with matching title"
},
{
"key": "json",
"value": "[object Object]",
"description": "Trigger attribute filters for the search. See [Filter](#filter)"
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active triggers if true or inactive triggers if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\""
},
{
"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 trigger, if present\n| permissions | The permissions for each trigger\n| usage_1h | The number of times each trigger has been used in the past hour\n| usage_24h | The number of times each trigger has been used in the past day\n| usage_7d | The number of times each trigger has been used in the past week\n| usage_30d | The number of times each trigger has been used in the past thirty days\n\n#### Filter\n\nUse the `filter` query parameter to filter a trigger search by one or more attributes. For example, the following `filter` argument filters triggers by the `description` attribute:\n\n```json\n{\n \"json\": {\n \"description\": \"Close a ticket\"\n }\n}\n```\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/search?query=<string>&json=[object Object]&active=<boolean>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"triggers",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all triggers with matching title"
},
{
"key": "json",
"value": "[object Object]",
"description": "Trigger attribute filters for the search. See [Filter](#filter)"
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active triggers if true or inactive triggers if false"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\""
},
{
"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 \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"triggers\": [\n {\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 \"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 \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\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 \"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 \"category_id\": \"<string>\",\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_title\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
