Chilkat Online Tools

SQL Server / Support API / Reorder Triggers

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', 'login'
    EXEC sp_OASetProperty @http, 'Password', 'password'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'PUT', 'https://example.zendesk.com/api/v2/triggers/reorder'
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

    -- 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

    DECLARE @field nvarchar(4000)

    DECLARE @operator nvarchar(4000)

    DECLARE @value nvarchar(4000)

    DECLARE @Title nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'trigger.title'
    DECLARE @Active nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'trigger.active'
    DECLARE @Category_id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Category_id OUT, 'trigger.category_id'
    DECLARE @Created_at nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'trigger.created_at'
    DECLARE @Default nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Default OUT, 'trigger.default'
    DECLARE @Description nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'trigger.description'
    DECLARE @Id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'trigger.id'
    DECLARE @Position nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Position OUT, 'trigger.position'
    DECLARE @Raw_title nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Raw_title OUT, 'trigger.raw_title'
    DECLARE @Updated_at nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'trigger.updated_at'
    DECLARE @v_Url nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'trigger.url'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'trigger.conditions.all'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'trigger.conditions.all[i].field'
        EXEC sp_OAMethod @jResp, 'StringOf', @operator OUT, 'trigger.conditions.all[i].operator'
        EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'trigger.conditions.all[i].value'
        SELECT @i = @i + 1
      END
    SELECT @i = 0
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'trigger.conditions.any'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'trigger.conditions.any[i].field'
        EXEC sp_OAMethod @jResp, 'StringOf', @operator OUT, 'trigger.conditions.any[i].operator'
        EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'trigger.conditions.any[i].value'
        SELECT @i = @i + 1
      END
    SELECT @i = 0
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'trigger.actions'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @field OUT, 'trigger.actions[i].field'
        EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'trigger.actions[i].value'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}