Chilkat Online Tools

delphiAx / Support API / Incremental Instance Values Export

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
attribute_id: WideString;
id: WideString;
name: WideString;
time: WideString;
v_type: WideString;
attribute_value_id: WideString;
instance_id: WideString;
count: WideString;
end_time: WideString;
next_page: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

http.SetRequestHeader('Accept','application/json');

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/incremental/routing/instance_values',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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

count := jResp.StringOf('count');
end_time := jResp.StringOf('end_time');
next_page := jResp.StringOf('next_page');
i := 0;
count_i := jResp.SizeOfArray('attribute_values');
while i < count_i do
  begin
    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;
  end;

i := 0;
count_i := jResp.SizeOfArray('attributes');
while i < count_i do
  begin
    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;
  end;

i := 0;
count_i := jResp.SizeOfArray('instance_values');
while i < count_i do
  begin
    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;
  end;

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