Chilkat Online Tools

Swift3 / Support API / Reorder Triggers

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "login"
    http.password = "password"

    http.setRequestHeader("Accept", value: "application/json")

    var resp: CkoHttpResponse? = http.quickRequest("PUT", url: "https://example.zendesk.com/api/v2/triggers/reorder")
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var field: String?
    var operator: String?
    var value: String?

    var Title: String? = jResp.string(of: "trigger.title")
    var Active: String? = jResp.string(of: "trigger.active")
    var Category_id: String? = jResp.string(of: "trigger.category_id")
    var Created_at: String? = jResp.string(of: "trigger.created_at")
    var Default: String? = jResp.string(of: "trigger.default")
    var Description: String? = jResp.string(of: "trigger.description")
    var Id: String? = jResp.string(of: "trigger.id")
    var Position: String? = jResp.string(of: "trigger.position")
    var Raw_title: String? = jResp.string(of: "trigger.raw_title")
    var Updated_at: String? = jResp.string(of: "trigger.updated_at")
    var v_Url: String? = jResp.string(of: "trigger.url")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "trigger.conditions.all").intValue
    while i < count_i {
        jResp.i = i
        field = jResp.string(of: "trigger.conditions.all[i].field")
        operator = jResp.string(of: "trigger.conditions.all[i].operator")
        value = jResp.string(of: "trigger.conditions.all[i].value")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "trigger.conditions.any").intValue
    while i < count_i {
        jResp.i = i
        field = jResp.string(of: "trigger.conditions.any[i].field")
        operator = jResp.string(of: "trigger.conditions.any[i].operator")
        value = jResp.string(of: "trigger.conditions.any[i].value")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "trigger.actions").intValue
    while i < count_i {
        jResp.i = i
        field = jResp.string(of: "trigger.actions[i].field")
        value = jResp.string(of: "trigger.actions[i].value")
        i = i + 1
    }


}

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