Chilkat Online Tools

Foxpro / Support API / Reorder Triggers

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcField
LOCAL lcOperator
LOCAL lcValue
LOCAL lcTitle
LOCAL lcActive
LOCAL lcCategory_id
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcDescription
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_title
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loHttp = CreateObject('Chilkat_9_5_0.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/triggers/reorder")
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "trigger": {
*     "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

lcTitle = loJResp.StringOf("trigger.title")
lcActive = loJResp.StringOf("trigger.active")
lcCategory_id = loJResp.StringOf("trigger.category_id")
lcCreated_at = loJResp.StringOf("trigger.created_at")
lcDefault = loJResp.StringOf("trigger.default")
lcDescription = loJResp.StringOf("trigger.description")
lcId = loJResp.StringOf("trigger.id")
lcPosition = loJResp.StringOf("trigger.position")
lcRaw_title = loJResp.StringOf("trigger.raw_title")
lcUpdated_at = loJResp.StringOf("trigger.updated_at")
lcV_Url = loJResp.StringOf("trigger.url")
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.conditions.all")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.conditions.all[i].field")
    lcOperator = loJResp.StringOf("trigger.conditions.all[i].operator")
    lcValue = loJResp.StringOf("trigger.conditions.all[i].value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.conditions.any")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.conditions.any[i].field")
    lcOperator = loJResp.StringOf("trigger.conditions.any[i].operator")
    lcValue = loJResp.StringOf("trigger.conditions.any[i].value")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("trigger.actions")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcField = loJResp.StringOf("trigger.actions[i].field")
    lcValue = loJResp.StringOf("trigger.actions[i].value")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/triggers/reorder

Postman Collection Item JSON

{
  "name": "Reorder Triggers",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/triggers/reorder",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "triggers",
        "reorder"
      ]
    },
    "description": "Alters the firing order of triggers in the account. See\n[Reordering and sorting triggers](https://support.zendesk.com/hc/en-us/articles/115015696088)\nin the Zendesk Help Center. The firing order is set in a `trigger_ids` array in the request body.\n\nYou must include every trigger id in your account to reorder the triggers. If not, the endpoint will return 404 Forbidden.\n\nReordering triggers via the API is not permitted if you have more than one trigger category. If there is more than one\ntrigger category, the endpoint will return a `LimitOneCategory` error.\n\n#### Allowed For\n\n* Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/triggers/reorder",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "triggers",
            "reorder"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"trigger\": {\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}"
    }
  ]
}