delphiDll / Support API / Incremental Sample Export
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
requester_id: PWideChar;
allow_attachments: PWideChar;
allow_channelback: PWideChar;
assignee_email: PWideChar;
assignee_id: PWideChar;
attribute_value_ids: PWideChar;
brand_id: PWideChar;
collaborator_ids: PWideChar;
created_at: PWideChar;
custom_fields: PWideChar;
custom_status_id: PWideChar;
description: PWideChar;
due_at: PWideChar;
email_cc_ids: PWideChar;
external_id: PWideChar;
follower_ids: PWideChar;
followup_ids: PWideChar;
forum_topic_id: PWideChar;
from_messaging_channel: PWideChar;
group_id: PWideChar;
has_incidents: PWideChar;
id: PWideChar;
is_public: PWideChar;
macro_id: PWideChar;
macro_ids: PWideChar;
organization_id: PWideChar;
priority: PWideChar;
problem_id: PWideChar;
raw_subject: PWideChar;
recipient: PWideChar;
safe_update: PWideChar;
Aliquad0: Boolean;
sharing_agreement_ids: PWideChar;
status: PWideChar;
subject: PWideChar;
submitter_id: PWideChar;
tags: PWideChar;
ticket_form_id: PWideChar;
v_type: PWideChar;
updated_at: PWideChar;
updated_stamp: PWideChar;
url: PWideChar;
Channel: PWideChar;
Elit2f: PWideChar;
via_followup_source_id: PWideChar;
via_id: PWideChar;
Minim_01: PWideChar;
Ipsum8c2: Boolean;
Nostrud_ee: PWideChar;
j: Integer;
count_j: Integer;
email: PWideChar;
name: PWideChar;
count: PWideChar;
end_of_stream: PWideChar;
end_time: PWideChar;
next_page: PWideChar;
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 := CkHttp_Create();
CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'start_time','<integer>');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "end_of_stream": "<boolean>",
// "end_time": "<integer>",
// "next_page": "<string>",
// "tickets": [
// {
// "requester_id": "<integer>",
// "allow_attachments": "<boolean>",
// "allow_channelback": "<boolean>",
// "assignee_email": "<string>",
// "assignee_id": "<integer>",
// "attribute_value_ids": "<array>",
// "brand_id": "<integer>",
// "collaborator_ids": "<array>",
// "collaborators": [
// {
// "email": "<email>",
// "name": "<string>"
// },
// {
// "email": "<email>",
// "name": "<string>"
// }
// ],
// "comment": {},
// "created_at": "<dateTime>",
// "custom_fields": "<array>",
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": "<array>",
// "email_ccs": {},
// "external_id": "<string>",
// "follower_ids": "<array>",
// "followers": {},
// "followup_ids": "<array>",
// "forum_topic_id": "<integer>",
// "from_messaging_channel": "<boolean>",
// "group_id": "<integer>",
// "has_incidents": "<boolean>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "macro_id": "<integer>",
// "macro_ids": "<array>",
// "metadata": {},
// "organization_id": "<integer>",
// "priority": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "aliquad0": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "pending",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "question",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "elit2f": -86657295.30733354
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// },
// {
// "requester_id": "<integer>",
// "allow_attachments": "<boolean>",
// "allow_channelback": "<boolean>",
// "assignee_email": "<string>",
// "assignee_id": "<integer>",
// "attribute_value_ids": "<array>",
// "brand_id": "<integer>",
// "collaborator_ids": "<array>",
// "collaborators": [
// {
// "email": "<email>",
// "name": "<string>"
// },
// {
// "email": "<email>",
// "name": "<string>"
// }
// ],
// "comment": {},
// "created_at": "<dateTime>",
// "custom_fields": "<array>",
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": "<array>",
// "email_ccs": {},
// "external_id": "<string>",
// "follower_ids": "<array>",
// "followers": {},
// "followup_ids": "<array>",
// "forum_topic_id": "<integer>",
// "from_messaging_channel": "<boolean>",
// "group_id": "<integer>",
// "has_incidents": "<boolean>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "macro_id": "<integer>",
// "macro_ids": "<array>",
// "metadata": {},
// "organization_id": "<integer>",
// "priority": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "minim_01": "minim tempor",
// "ipsum8c2": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "open",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "task",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "nostrud_ee": "dolore veniam consequat"
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
count := CkJsonObject__stringOf(jResp,'count');
end_of_stream := CkJsonObject__stringOf(jResp,'end_of_stream');
end_time := CkJsonObject__stringOf(jResp,'end_time');
next_page := CkJsonObject__stringOf(jResp,'next_page');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'tickets');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
requester_id := CkJsonObject__stringOf(jResp,'tickets[i].requester_id');
allow_attachments := CkJsonObject__stringOf(jResp,'tickets[i].allow_attachments');
allow_channelback := CkJsonObject__stringOf(jResp,'tickets[i].allow_channelback');
assignee_email := CkJsonObject__stringOf(jResp,'tickets[i].assignee_email');
assignee_id := CkJsonObject__stringOf(jResp,'tickets[i].assignee_id');
attribute_value_ids := CkJsonObject__stringOf(jResp,'tickets[i].attribute_value_ids');
brand_id := CkJsonObject__stringOf(jResp,'tickets[i].brand_id');
collaborator_ids := CkJsonObject__stringOf(jResp,'tickets[i].collaborator_ids');
created_at := CkJsonObject__stringOf(jResp,'tickets[i].created_at');
custom_fields := CkJsonObject__stringOf(jResp,'tickets[i].custom_fields');
custom_status_id := CkJsonObject__stringOf(jResp,'tickets[i].custom_status_id');
description := CkJsonObject__stringOf(jResp,'tickets[i].description');
due_at := CkJsonObject__stringOf(jResp,'tickets[i].due_at');
email_cc_ids := CkJsonObject__stringOf(jResp,'tickets[i].email_cc_ids');
external_id := CkJsonObject__stringOf(jResp,'tickets[i].external_id');
follower_ids := CkJsonObject__stringOf(jResp,'tickets[i].follower_ids');
followup_ids := CkJsonObject__stringOf(jResp,'tickets[i].followup_ids');
forum_topic_id := CkJsonObject__stringOf(jResp,'tickets[i].forum_topic_id');
from_messaging_channel := CkJsonObject__stringOf(jResp,'tickets[i].from_messaging_channel');
group_id := CkJsonObject__stringOf(jResp,'tickets[i].group_id');
has_incidents := CkJsonObject__stringOf(jResp,'tickets[i].has_incidents');
id := CkJsonObject__stringOf(jResp,'tickets[i].id');
is_public := CkJsonObject__stringOf(jResp,'tickets[i].is_public');
macro_id := CkJsonObject__stringOf(jResp,'tickets[i].macro_id');
macro_ids := CkJsonObject__stringOf(jResp,'tickets[i].macro_ids');
organization_id := CkJsonObject__stringOf(jResp,'tickets[i].organization_id');
priority := CkJsonObject__stringOf(jResp,'tickets[i].priority');
problem_id := CkJsonObject__stringOf(jResp,'tickets[i].problem_id');
raw_subject := CkJsonObject__stringOf(jResp,'tickets[i].raw_subject');
recipient := CkJsonObject__stringOf(jResp,'tickets[i].recipient');
safe_update := CkJsonObject__stringOf(jResp,'tickets[i].safe_update');
Aliquad0 := CkJsonObject_BoolOf(jResp,'tickets[i].satisfaction_rating.aliquad0');
sharing_agreement_ids := CkJsonObject__stringOf(jResp,'tickets[i].sharing_agreement_ids');
status := CkJsonObject__stringOf(jResp,'tickets[i].status');
subject := CkJsonObject__stringOf(jResp,'tickets[i].subject');
submitter_id := CkJsonObject__stringOf(jResp,'tickets[i].submitter_id');
tags := CkJsonObject__stringOf(jResp,'tickets[i].tags');
ticket_form_id := CkJsonObject__stringOf(jResp,'tickets[i].ticket_form_id');
v_type := CkJsonObject__stringOf(jResp,'tickets[i].type');
updated_at := CkJsonObject__stringOf(jResp,'tickets[i].updated_at');
updated_stamp := CkJsonObject__stringOf(jResp,'tickets[i].updated_stamp');
url := CkJsonObject__stringOf(jResp,'tickets[i].url');
Channel := CkJsonObject__stringOf(jResp,'tickets[i].via.channel');
Elit2f := CkJsonObject__stringOf(jResp,'tickets[i].via.source.elit2f');
via_followup_source_id := CkJsonObject__stringOf(jResp,'tickets[i].via_followup_source_id');
via_id := CkJsonObject__stringOf(jResp,'tickets[i].via_id');
Minim_01 := CkJsonObject__stringOf(jResp,'tickets[i].satisfaction_rating.minim_01');
Ipsum8c2 := CkJsonObject_BoolOf(jResp,'tickets[i].satisfaction_rating.ipsum8c2');
Nostrud_ee := CkJsonObject__stringOf(jResp,'tickets[i].via.source.nostrud_ee');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'tickets[i].collaborators');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
email := CkJsonObject__stringOf(jResp,'tickets[i].collaborators[j].email');
name := CkJsonObject__stringOf(jResp,'tickets[i].collaborators[j].name');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample
Postman Collection Item JSON
{
"name": "Incremental Sample Export",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource",
"value": "<string>"
}
]
},
"description": "Use this endpoint to test the incremental export format. It's more strict in terms of rate limiting,\nat 10 requests per 20 minutes instead of 10 requests per minute. It also returns only up to 50\nresults per request. Otherwise, it's identical to the above APIs.\n\nUse the `incremental_resource` parameter to specify the resource. Possible values are \"tickets\", \"ticket_events\", \"users\", or \"organizations\".\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/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"tickets\": [\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"aliquad0\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"pending\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"question\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"elit2f\": -86657295.30733354\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"minim_01\": \"minim tempor\",\n \"ipsum8c2\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"open\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"nostrud_ee\": \"dolore veniam consequat\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n ]\n}"
}
]
}
