PowerBuilder / Support API / Incremental Sample Export
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Requester_id
string ls_Allow_attachments
string ls_Allow_channelback
string ls_Assignee_email
string ls_Assignee_id
string ls_Attribute_value_ids
string ls_Brand_id
string ls_Collaborator_ids
string ls_Created_at
string ls_Custom_fields
string ls_Custom_status_id
string ls_Description
string ls_Due_at
string ls_Email_cc_ids
string ls_External_id
string ls_Follower_ids
string ls_Followup_ids
string ls_Forum_topic_id
string ls_From_messaging_channel
string ls_Group_id
string ls_Has_incidents
string ls_Id
string ls_Is_public
string ls_Macro_id
string ls_Macro_ids
string ls_Organization_id
string ls_Priority
string ls_Problem_id
string ls_Raw_subject
string ls_Recipient
string ls_Safe_update
integer li_Aliquad0
string ls_Sharing_agreement_ids
string ls_Status
string ls_Subject
string ls_Submitter_id
string ls_Tags
string ls_Ticket_form_id
string ls_V_type
string ls_Updated_at
string ls_Updated_stamp
string ls_Url
string ls_Channel
string ls_Elit2f
string ls_Via_followup_source_id
string ls_Via_id
string ls_Minim_01
integer li_Ipsum8c2
string ls_Nostrud_ee
integer j
integer li_Count_j
string ls_Email
string ls_Name
string ls_Count
string ls_End_of_stream
string ls_End_time
string ls_Next_page
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("start_time","<integer>")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Count = loo_JResp.StringOf("count")
ls_End_of_stream = loo_JResp.StringOf("end_of_stream")
ls_End_time = loo_JResp.StringOf("end_time")
ls_Next_page = loo_JResp.StringOf("next_page")
i = 0
li_Count_i = loo_JResp.SizeOfArray("tickets")
do while i < li_Count_i
loo_JResp.I = i
ls_Requester_id = loo_JResp.StringOf("tickets[i].requester_id")
ls_Allow_attachments = loo_JResp.StringOf("tickets[i].allow_attachments")
ls_Allow_channelback = loo_JResp.StringOf("tickets[i].allow_channelback")
ls_Assignee_email = loo_JResp.StringOf("tickets[i].assignee_email")
ls_Assignee_id = loo_JResp.StringOf("tickets[i].assignee_id")
ls_Attribute_value_ids = loo_JResp.StringOf("tickets[i].attribute_value_ids")
ls_Brand_id = loo_JResp.StringOf("tickets[i].brand_id")
ls_Collaborator_ids = loo_JResp.StringOf("tickets[i].collaborator_ids")
ls_Created_at = loo_JResp.StringOf("tickets[i].created_at")
ls_Custom_fields = loo_JResp.StringOf("tickets[i].custom_fields")
ls_Custom_status_id = loo_JResp.StringOf("tickets[i].custom_status_id")
ls_Description = loo_JResp.StringOf("tickets[i].description")
ls_Due_at = loo_JResp.StringOf("tickets[i].due_at")
ls_Email_cc_ids = loo_JResp.StringOf("tickets[i].email_cc_ids")
ls_External_id = loo_JResp.StringOf("tickets[i].external_id")
ls_Follower_ids = loo_JResp.StringOf("tickets[i].follower_ids")
ls_Followup_ids = loo_JResp.StringOf("tickets[i].followup_ids")
ls_Forum_topic_id = loo_JResp.StringOf("tickets[i].forum_topic_id")
ls_From_messaging_channel = loo_JResp.StringOf("tickets[i].from_messaging_channel")
ls_Group_id = loo_JResp.StringOf("tickets[i].group_id")
ls_Has_incidents = loo_JResp.StringOf("tickets[i].has_incidents")
ls_Id = loo_JResp.StringOf("tickets[i].id")
ls_Is_public = loo_JResp.StringOf("tickets[i].is_public")
ls_Macro_id = loo_JResp.StringOf("tickets[i].macro_id")
ls_Macro_ids = loo_JResp.StringOf("tickets[i].macro_ids")
ls_Organization_id = loo_JResp.StringOf("tickets[i].organization_id")
ls_Priority = loo_JResp.StringOf("tickets[i].priority")
ls_Problem_id = loo_JResp.StringOf("tickets[i].problem_id")
ls_Raw_subject = loo_JResp.StringOf("tickets[i].raw_subject")
ls_Recipient = loo_JResp.StringOf("tickets[i].recipient")
ls_Safe_update = loo_JResp.StringOf("tickets[i].safe_update")
li_Aliquad0 = loo_JResp.BoolOf("tickets[i].satisfaction_rating.aliquad0")
ls_Sharing_agreement_ids = loo_JResp.StringOf("tickets[i].sharing_agreement_ids")
ls_Status = loo_JResp.StringOf("tickets[i].status")
ls_Subject = loo_JResp.StringOf("tickets[i].subject")
ls_Submitter_id = loo_JResp.StringOf("tickets[i].submitter_id")
ls_Tags = loo_JResp.StringOf("tickets[i].tags")
ls_Ticket_form_id = loo_JResp.StringOf("tickets[i].ticket_form_id")
ls_V_type = loo_JResp.StringOf("tickets[i].type")
ls_Updated_at = loo_JResp.StringOf("tickets[i].updated_at")
ls_Updated_stamp = loo_JResp.StringOf("tickets[i].updated_stamp")
ls_Url = loo_JResp.StringOf("tickets[i].url")
ls_Channel = loo_JResp.StringOf("tickets[i].via.channel")
ls_Elit2f = loo_JResp.StringOf("tickets[i].via.source.elit2f")
ls_Via_followup_source_id = loo_JResp.StringOf("tickets[i].via_followup_source_id")
ls_Via_id = loo_JResp.StringOf("tickets[i].via_id")
ls_Minim_01 = loo_JResp.StringOf("tickets[i].satisfaction_rating.minim_01")
li_Ipsum8c2 = loo_JResp.BoolOf("tickets[i].satisfaction_rating.ipsum8c2")
ls_Nostrud_ee = loo_JResp.StringOf("tickets[i].via.source.nostrud_ee")
j = 0
li_Count_j = loo_JResp.SizeOfArray("tickets[i].collaborators")
do while j < li_Count_j
loo_JResp.J = j
ls_Email = loo_JResp.StringOf("tickets[i].collaborators[j].email")
ls_Name = loo_JResp.StringOf("tickets[i].collaborators[j].name")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
