Chilkat Online Tools

PureBasic / Support API / Incremental Instance Values Export

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/incremental/routing/instance_values",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; 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

    attribute_id.s
    id.s
    name.s
    time.s
    v_type.s
    attribute_value_id.s
    instance_id.s

    count.s = CkJsonObject::ckStringOf(jResp,"count")
    end_time.s = CkJsonObject::ckStringOf(jResp,"end_time")
    next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"attribute_values")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        attribute_id = CkJsonObject::ckStringOf(jResp,"attribute_values[i].attribute_id")
        id = CkJsonObject::ckStringOf(jResp,"attribute_values[i].id")
        name = CkJsonObject::ckStringOf(jResp,"attribute_values[i].name")
        time = CkJsonObject::ckStringOf(jResp,"attribute_values[i].time")
        v_type = CkJsonObject::ckStringOf(jResp,"attribute_values[i].type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"attributes")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        id = CkJsonObject::ckStringOf(jResp,"attributes[i].id")
        name = CkJsonObject::ckStringOf(jResp,"attributes[i].name")
        time = CkJsonObject::ckStringOf(jResp,"attributes[i].time")
        v_type = CkJsonObject::ckStringOf(jResp,"attributes[i].type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"instance_values")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        attribute_value_id = CkJsonObject::ckStringOf(jResp,"instance_values[i].attribute_value_id")
        id = CkJsonObject::ckStringOf(jResp,"instance_values[i].id")
        instance_id = CkJsonObject::ckStringOf(jResp,"instance_values[i].instance_id")
        time = CkJsonObject::ckStringOf(jResp,"instance_values[i].time")
        v_type = CkJsonObject::ckStringOf(jResp,"instance_values[i].type")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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