Chilkat Online Tools

Swift3 / Support API / Update Many Macros

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"

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "macros": [
    //     {
    //       "id": "<integer>",
    //       "active": "<boolean>",
    //       "position": "<integer>"
    //     },
    //     {
    //       "id": "<integer>",
    //       "active": "<boolean>",
    //       "position": "<integer>"
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("macros[0].id", value: "<integer>")
    json.update("macros[0].active", value: "<boolean>")
    json.update("macros[0].position", value: "<integer>")
    json.update("macros[1].id", value: "<integer>")
    json.update("macros[1].active", value: "<boolean>")
    json.update("macros[1].position", value: "<integer>")

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

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://example.zendesk.com/api/v2/macros/update_many", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    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)

    // {
    //   "macros": [
    //     {
    //       "actions": [
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "title": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "restriction": {
    //         "proidentf9": true
    //       },
    //       "updated_at": "<dateTime>",
    //       "url": "<string>",
    //       "app_installation": "<string>",
    //       "categories": "<string>",
    //       "permissions": "<string>",
    //       "usage_1h": "<integer>",
    //       "usage_7d": "<integer>",
    //       "usage_24h": "<integer>",
    //       "usage_30d": "<integer>"
    //     },
    //     {
    //       "actions": [
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         },
    //         {
    //           "field": "<string>",
    //           "value": "<string>"
    //         }
    //       ],
    //       "title": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "default": "<boolean>",
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "restriction": {
    //         "deserunt_": false,
    //         "exercitation2": -75718943,
    //         "eiusmodeaf": 24563232.4790345,
    //         "estf5": "aute",
    //         "minim24": -78305859
    //       },
    //       "updated_at": "<dateTime>",
    //       "url": "<string>",
    //       "app_installation": "<string>",
    //       "categories": "<string>",
    //       "permissions": "<string>",
    //       "usage_1h": "<integer>",
    //       "usage_7d": "<integer>",
    //       "usage_24h": "<integer>",
    //       "usage_30d": "<integer>"
    //     }
    //   ],
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "previous_page": "<string>"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var title: String?
    var active: String?
    var created_at: String?
    var default: String?
    var description: String?
    var id: String?
    var position: String?
    var Proidentf9: Bool
    var updated_at: String?
    var url: String?
    var app_installation: String?
    var categories: String?
    var permissions: String?
    var usage_1h: String?
    var usage_7d: String?
    var usage_24h: String?
    var usage_30d: String?
    var Deserunt_: Bool
    var Exercitation2: Int
    var Eiusmodeaf: String?
    var Estf5: String?
    var Minim24: Int
    var j: Int
    var count_j: Int
    var field: String?
    var value: String?

    var count: String? = jResp.string(of: "count")
    var next_page: String? = jResp.string(of: "next_page")
    var previous_page: String? = jResp.string(of: "previous_page")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "macros").intValue
    while i < count_i {
        jResp.i = i
        title = jResp.string(of: "macros[i].title")
        active = jResp.string(of: "macros[i].active")
        created_at = jResp.string(of: "macros[i].created_at")
        default = jResp.string(of: "macros[i].default")
        description = jResp.string(of: "macros[i].description")
        id = jResp.string(of: "macros[i].id")
        position = jResp.string(of: "macros[i].position")
        Proidentf9 = jResp.bool(of: "macros[i].restriction.proidentf9")
        updated_at = jResp.string(of: "macros[i].updated_at")
        url = jResp.string(of: "macros[i].url")
        app_installation = jResp.string(of: "macros[i].app_installation")
        categories = jResp.string(of: "macros[i].categories")
        permissions = jResp.string(of: "macros[i].permissions")
        usage_1h = jResp.string(of: "macros[i].usage_1h")
        usage_7d = jResp.string(of: "macros[i].usage_7d")
        usage_24h = jResp.string(of: "macros[i].usage_24h")
        usage_30d = jResp.string(of: "macros[i].usage_30d")
        Deserunt_ = jResp.bool(of: "macros[i].restriction.deserunt_")
        Exercitation2 = jResp.int(of: "macros[i].restriction.exercitation2").intValue
        Eiusmodeaf = jResp.string(of: "macros[i].restriction.eiusmodeaf")
        Estf5 = jResp.string(of: "macros[i].restriction.estf5")
        Minim24 = jResp.int(of: "macros[i].restriction.minim24").intValue
        j = 0
        count_j = jResp.size(ofArray: "macros[i].actions").intValue
        while j < count_j {
            jResp.j = j
            field = jResp.string(of: "macros[i].actions[j].field")
            value = jResp.string(of: "macros[i].actions[j].value")
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl  -u login:password -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "macros": [
    {
      "id": "<integer>",
      "active": "<boolean>",
      "position": "<integer>"
    },
    {
      "id": "<integer>",
      "active": "<boolean>",
      "position": "<integer>"
    }
  ]
}'
https://example.zendesk.com/api/v2/macros/update_many

Postman Collection Item JSON

{
  "name": "Update Many Macros",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"macros\": [\n    {\n      \"id\": \"<integer>\",\n      \"active\": \"<boolean>\",\n      \"position\": \"<integer>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"active\": \"<boolean>\",\n      \"position\": \"<integer>\"\n    }\n  ]\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/macros/update_many",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "macros",
        "update_many"
      ]
    },
    "description": "Updates the provided macros with the specified changes.\n\n#### Allowed For\n* Agents\n"
  },
  "response": [
    {
      "name": "Success Response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"macros\": [\n    {\n      \"id\": \"<integer>\",\n      \"active\": \"<boolean>\",\n      \"position\": \"<integer>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"active\": \"<boolean>\",\n      \"position\": \"<integer>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/macros/update_many",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "macros",
            "update_many"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"macros\": [\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      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"restriction\": {\n        \"proidentf9\": true\n      },\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"app_installation\": \"<string>\",\n      \"categories\": \"<string>\",\n      \"permissions\": \"<string>\",\n      \"usage_1h\": \"<integer>\",\n      \"usage_7d\": \"<integer>\",\n      \"usage_24h\": \"<integer>\",\n      \"usage_30d\": \"<integer>\"\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      \"created_at\": \"<dateTime>\",\n      \"default\": \"<boolean>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"restriction\": {\n        \"deserunt_\": false,\n        \"exercitation2\": -75718943,\n        \"eiusmodeaf\": 24563232.4790345,\n        \"estf5\": \"aute\",\n        \"minim24\": -78305859\n      },\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"app_installation\": \"<string>\",\n      \"categories\": \"<string>\",\n      \"permissions\": \"<string>\",\n      \"usage_1h\": \"<integer>\",\n      \"usage_7d\": \"<integer>\",\n      \"usage_24h\": \"<integer>\",\n      \"usage_30d\": \"<integer>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}