Chilkat Online Tools

Delphi (DLL) / Support API / Incremental Ticket Export, Cursor Based

Back to Collection Items

var

begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(queryParams,'start_time','<integer>');CkJsonObject_UpdateString(queryParams,'cursor','<string>');CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);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');Non9 := CkJsonObject_IntOf(jResp,'tickets[i].satisfaction_rating.non9');Eiusmod_3 := CkJsonObject__stringOf(jResp,'tickets[i].satisfaction_rating.eiusmod_3');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');In4 := CkJsonObject_IntOf(jResp,'tickets[i].via.source.in4');In57 := CkJsonObject__stringOf(jResp,'tickets[i].via.source.in57');via_followup_source_id := CkJsonObject__stringOf(jResp,'tickets[i].via_followup_source_id');via_id := CkJsonObject__stringOf(jResp,'tickets[i].via_id');Id_b := CkJsonObject__stringOf(jResp,'tickets[i].satisfaction_rating.id_b');Ea___9 := CkJsonObject_IntOf(jResp,'tickets[i].via.source.ea___9');j := 0;count_j := CkJsonObject_SizeOfArray(jResp,'tickets[i].collaborators');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;i := i + 1;

Curl Command

curl  -u login:password -G -d "start_time=%3Cinteger%3E"
	-d "cursor=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/tickets/cursor

Postman Collection Item JSON

{
  "name": "Incremental Ticket Export, Cursor Based",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/tickets/cursor?start_time=<integer>&cursor=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "tickets",
        "cursor"
      ],
      "query": [
        {
          "key": "start_time",
          "value": "<integer>",
          "description": "(Required) The time to start the incremental export from"
        },
        {
          "key": "cursor",
          "value": "<string>",
          "description": "The cursor pointer to work with for all subsequent exports after the initial request"
        }
      ]
    },
    "description": "Returns the tickets that changed since the start time. For more information,\nsee [Exporting tickets](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#exporting-tickets) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\nThis endpoint supports cursor-based incremental exports.\nCursor-based exports are highly encouraged because they provide more consistent performance and\nresponse body sizes. For more information, see [Cursor-based incremental exports](/documentation/ticketing/managing-tickets/using-the-incremental-export-api#cursor-based-incremental-exports) in [Using the Incremental Exports API](/documentation/ticketing/managing-tickets/using-the-incremental-export-api).\n\n\n\n#### Allowed For\n\n * Admins\n\n#### Sideloading\n\nSee [Tickets sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints). For performance reasons,\n`last_audits` sideloads aren't supported.\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/tickets/cursor?start_time=<integer>&cursor=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "tickets",
            "cursor"
          ],
          "query": [
            {
              "key": "start_time",
              "value": "<integer>",
              "description": "(Required) The time to start the incremental export from"
            },
            {
              "key": "cursor",
              "value": "<string>",
              "description": "The cursor pointer to work with for all subsequent exports after the initial request"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"after_cursor\": \"<string>\",\n  \"after_url\": \"<string>\",\n  \"before_cursor\": \"<string>\",\n  \"before_url\": \"<string>\",\n  \"end_of_stream\": \"<boolean>\",\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\": \"urgent\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"non9\": 3831085,\n        \"eiusmod_3\": 57077767.014250696\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"solved\",\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          \"in4\": 87803065,\n          \"in57\": \"velit ipsum\"\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\": \"low\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"id_b\": \"qui dolore\"\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          \"ea___9\": -17544125\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    }\n  ]\n}"
    }
  ]
}