Chilkat Online Tools

phpExt / Support API / Incremental Attributes Values Export

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('login');
$http->put_Password('password');

$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/incremental/routing/attribute_values',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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) {
    $jResp->put_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');
while ($i < $count_i) {
    $jResp->put_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');
while ($i < $count_i) {
    $jResp->put_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/attribute_values

Postman Collection Item JSON

{
  "name": "Incremental Attributes Values Export",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/routing/attribute_values",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "routing",
        "attribute_values"
      ]
    },
    "description": "Returns a stream of changes that occurred on routing attribute values.\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/attribute_values",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "routing",
            "attribute_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}"
    }
  ]
}