Chilkat Online Tools

autoit / Support API / Incremental Instance Values Export

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/incremental/routing/instance_values",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sAttribute_id
Local $sId
Local $sName
Local $sTime
Local $sV_type
Local $sAttribute_value_id
Local $sInstance_id

Local $sCount = $oJResp.StringOf("count")
Local $sEnd_time = $oJResp.StringOf("end_time")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("attribute_values")
While $i < $iCount_i
    $oJResp.I = $i
    $sAttribute_id = $oJResp.StringOf("attribute_values[i].attribute_id")
    $sId = $oJResp.StringOf("attribute_values[i].id")
    $sName = $oJResp.StringOf("attribute_values[i].name")
    $sTime = $oJResp.StringOf("attribute_values[i].time")
    $sV_type = $oJResp.StringOf("attribute_values[i].type")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("attributes")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("attributes[i].id")
    $sName = $oJResp.StringOf("attributes[i].name")
    $sTime = $oJResp.StringOf("attributes[i].time")
    $sV_type = $oJResp.StringOf("attributes[i].type")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("instance_values")
While $i < $iCount_i
    $oJResp.I = $i
    $sAttribute_value_id = $oJResp.StringOf("instance_values[i].attribute_value_id")
    $sId = $oJResp.StringOf("instance_values[i].id")
    $sInstance_id = $oJResp.StringOf("instance_values[i].instance_id")
    $sTime = $oJResp.StringOf("instance_values[i].time")
    $sV_type = $oJResp.StringOf("instance_values[i].type")
    $i = $i + 1
Wend

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