Chilkat Online Tools

Swift / Support API / Incremental Instance Values Export

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

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/incremental/routing/instance_values", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    // {
    //   "attribute_values": [
    //     {
    //       "attribute_id": "<string>",
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "attribute_id": "<string>",
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "attributes": [
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "count": "<integer>",
    //   "end_time": "<integer>",
    //   "instance_values": [
    //     {
    //       "attribute_value_id": "<string>",
    //       "id": "<string>",
    //       "instance_id": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "attribute_value_id": "<string>",
    //       "id": "<string>",
    //       "instance_id": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "next_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 attribute_id: String?
    var id: String?
    var name: String?
    var time: String?
    var v_type: String?
    var attribute_value_id: String?
    var instance_id: String?

    var count: String? = jResp.StringOf("count")
    var end_time: String? = jResp.StringOf("end_time")
    var next_page: String? = jResp.StringOf("next_page")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("attribute_values").intValue
    while i < count_i {
        jResp.I = i
        attribute_id = jResp.StringOf("attribute_values[i].attribute_id")
        id = jResp.StringOf("attribute_values[i].id")
        name = jResp.StringOf("attribute_values[i].name")
        time = jResp.StringOf("attribute_values[i].time")
        v_type = jResp.StringOf("attribute_values[i].type")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("attributes").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("attributes[i].id")
        name = jResp.StringOf("attributes[i].name")
        time = jResp.StringOf("attributes[i].time")
        v_type = jResp.StringOf("attributes[i].type")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("instance_values").intValue
    while i < count_i {
        jResp.I = i
        attribute_value_id = jResp.StringOf("instance_values[i].attribute_value_id")
        id = jResp.StringOf("instance_values[i].id")
        instance_id = jResp.StringOf("instance_values[i].instance_id")
        time = jResp.StringOf("instance_values[i].time")
        v_type = jResp.StringOf("instance_values[i].type")
        i = i + 1
    }


}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/routing/instance_values

Postman Collection Item JSON

{
  "name": "Incremental Instance Values Export",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/routing/instance_values",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "routing",
        "instance_values"
      ]
    },
    "description": "Returns a stream of changes that occurred on routing instance values. Changes are grouped by `attribute_value_id`,\nwith unassociate type events listed with associate type events by the associate event’s timestamp.\n\n#### Allowed For\n\n* Admins\n\n#### Parameters\n\nOptional\n\n| Name   | Type   | Comment\n| ------ | ------ | -------\n| cursor | string | The `cursor` parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter that's only available in API responses. See [Pagination](#pagination).\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/incremental/routing/instance_values",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "routing",
            "instance_values"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attribute_values\": [\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"attributes\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"end_time\": \"<integer>\",\n  \"instance_values\": [\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"next_page\": \"<string>\"\n}"
    }
  ]
}