Android / Support API / Incremental Sample Export
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
CkJsonObject queryParams = new CkJsonObject();
queryParams.UpdateString("start_time","<integer>");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample",queryParams);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// 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
String requester_id;
String allow_attachments;
String allow_channelback;
String assignee_email;
String assignee_id;
String attribute_value_ids;
String brand_id;
String collaborator_ids;
String created_at;
String custom_fields;
String custom_status_id;
String description;
String due_at;
String email_cc_ids;
String external_id;
String follower_ids;
String followup_ids;
String forum_topic_id;
String from_messaging_channel;
String group_id;
String has_incidents;
String id;
String is_public;
String macro_id;
String macro_ids;
String organization_id;
String priority;
String problem_id;
String raw_subject;
String recipient;
String safe_update;
boolean Aliquad0;
String sharing_agreement_ids;
String status;
String subject;
String submitter_id;
String tags;
String ticket_form_id;
String v_type;
String updated_at;
String updated_stamp;
String url;
String Channel;
String Elit2f;
String via_followup_source_id;
String via_id;
String Minim_01;
boolean Ipsum8c2;
String Nostrud_ee;
int j;
int count_j;
String email;
String name;
String count = jResp.stringOf("count");
String end_of_stream = jResp.stringOf("end_of_stream");
String end_time = jResp.stringOf("end_time");
String next_page = jResp.stringOf("next_page");
int i = 0;
int count_i = jResp.SizeOfArray("tickets");
while (i < count_i) {
jResp.put_I(i);
requester_id = jResp.stringOf("tickets[i].requester_id");
allow_attachments = jResp.stringOf("tickets[i].allow_attachments");
allow_channelback = jResp.stringOf("tickets[i].allow_channelback");
assignee_email = jResp.stringOf("tickets[i].assignee_email");
assignee_id = jResp.stringOf("tickets[i].assignee_id");
attribute_value_ids = jResp.stringOf("tickets[i].attribute_value_ids");
brand_id = jResp.stringOf("tickets[i].brand_id");
collaborator_ids = jResp.stringOf("tickets[i].collaborator_ids");
created_at = jResp.stringOf("tickets[i].created_at");
custom_fields = jResp.stringOf("tickets[i].custom_fields");
custom_status_id = jResp.stringOf("tickets[i].custom_status_id");
description = jResp.stringOf("tickets[i].description");
due_at = jResp.stringOf("tickets[i].due_at");
email_cc_ids = jResp.stringOf("tickets[i].email_cc_ids");
external_id = jResp.stringOf("tickets[i].external_id");
follower_ids = jResp.stringOf("tickets[i].follower_ids");
followup_ids = jResp.stringOf("tickets[i].followup_ids");
forum_topic_id = jResp.stringOf("tickets[i].forum_topic_id");
from_messaging_channel = jResp.stringOf("tickets[i].from_messaging_channel");
group_id = jResp.stringOf("tickets[i].group_id");
has_incidents = jResp.stringOf("tickets[i].has_incidents");
id = jResp.stringOf("tickets[i].id");
is_public = jResp.stringOf("tickets[i].is_public");
macro_id = jResp.stringOf("tickets[i].macro_id");
macro_ids = jResp.stringOf("tickets[i].macro_ids");
organization_id = jResp.stringOf("tickets[i].organization_id");
priority = jResp.stringOf("tickets[i].priority");
problem_id = jResp.stringOf("tickets[i].problem_id");
raw_subject = jResp.stringOf("tickets[i].raw_subject");
recipient = jResp.stringOf("tickets[i].recipient");
safe_update = jResp.stringOf("tickets[i].safe_update");
Aliquad0 = jResp.BoolOf("tickets[i].satisfaction_rating.aliquad0");
sharing_agreement_ids = jResp.stringOf("tickets[i].sharing_agreement_ids");
status = jResp.stringOf("tickets[i].status");
subject = jResp.stringOf("tickets[i].subject");
submitter_id = jResp.stringOf("tickets[i].submitter_id");
tags = jResp.stringOf("tickets[i].tags");
ticket_form_id = jResp.stringOf("tickets[i].ticket_form_id");
v_type = jResp.stringOf("tickets[i].type");
updated_at = jResp.stringOf("tickets[i].updated_at");
updated_stamp = jResp.stringOf("tickets[i].updated_stamp");
url = jResp.stringOf("tickets[i].url");
Channel = jResp.stringOf("tickets[i].via.channel");
Elit2f = jResp.stringOf("tickets[i].via.source.elit2f");
via_followup_source_id = jResp.stringOf("tickets[i].via_followup_source_id");
via_id = jResp.stringOf("tickets[i].via_id");
Minim_01 = jResp.stringOf("tickets[i].satisfaction_rating.minim_01");
Ipsum8c2 = jResp.BoolOf("tickets[i].satisfaction_rating.ipsum8c2");
Nostrud_ee = jResp.stringOf("tickets[i].via.source.nostrud_ee");
j = 0;
count_j = jResp.SizeOfArray("tickets[i].collaborators");
while (j < count_j) {
jResp.put_J(j);
email = jResp.stringOf("tickets[i].collaborators[j].email");
name = jResp.stringOf("tickets[i].collaborators[j].name");
j = j + 1;
}
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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}"
}
]
}
