Chilkat Online Tools

Foxpro / Support API / Incremental Instance Values Export

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAttribute_id
LOCAL lcId
LOCAL lcName
LOCAL lcTime
LOCAL lcV_type
LOCAL lcAttribute_value_id
LOCAL lcInstance_id
LOCAL lcCount
LOCAL lcEnd_time
LOCAL lcNext_page
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/incremental/routing/instance_values",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
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

lcCount = loJResp.StringOf("count")
lcEnd_time = loJResp.StringOf("end_time")
lcNext_page = loJResp.StringOf("next_page")
i = 0
lnCount_i = loJResp.SizeOfArray("attribute_values")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAttribute_id = loJResp.StringOf("attribute_values[i].attribute_id")
    lcId = loJResp.StringOf("attribute_values[i].id")
    lcName = loJResp.StringOf("attribute_values[i].name")
    lcTime = loJResp.StringOf("attribute_values[i].time")
    lcV_type = loJResp.StringOf("attribute_values[i].type")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("attributes")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("attributes[i].id")
    lcName = loJResp.StringOf("attributes[i].name")
    lcTime = loJResp.StringOf("attributes[i].time")
    lcV_type = loJResp.StringOf("attributes[i].type")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("instance_values")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcAttribute_value_id = loJResp.StringOf("instance_values[i].attribute_value_id")
    lcId = loJResp.StringOf("instance_values[i].id")
    lcInstance_id = loJResp.StringOf("instance_values[i].instance_id")
    lcTime = loJResp.StringOf("instance_values[i].time")
    lcV_type = loJResp.StringOf("instance_values[i].type")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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