Chilkat Online Tools

delphiDll / Support API / List All Ticket Audits

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
author_id: PWideChar;
created_at: PWideChar;
id: PWideChar;
Aute__: PWideChar;
Ex_ae: PWideChar;
ticket_id: PWideChar;
Channel: PWideChar;
Et_c59: Integer;
Veniam_689: PWideChar;
Elit_2ab: PWideChar;
Sint490: PWideChar;
j: Integer;
count_j: Integer;
voluptate_edf: PWideChar;
dolor0: Integer;
sedb2: Boolean;
nostrud_fd6: PWideChar;
ullamcoe: PWideChar;
adipisicing_1: Boolean;
after_cursor: PWideChar;
after_url: PWideChar;
before_cursor: PWideChar;
before_url: 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,'limit','<integer>');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://example.zendesk.com/api/v2/ticket_audits',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)

// {
//   "after_cursor": "<string>",
//   "after_url": "<string>",
//   "audits": [
//     {
//       "author_id": "<integer>",
//       "created_at": "<dateTime>",
//       "events": [
//         {
//           "voluptate_edf": 37194901.82832828,
//           "dolor0": 61753613
//         },
//         {
//           "sedb2": false
//         }
//       ],
//       "id": "<integer>",
//       "metadata": {
//         "aute__": "proident aute qui culpa",
//         "ex_ae": "dolore Lorem labore ut"
//       },
//       "ticket_id": "<integer>",
//       "via": {
//         "channel": "<string>",
//         "source": {
//           "et_c59": 68912889
//         }
//       }
//     },
//     {
//       "author_id": "<integer>",
//       "created_at": "<dateTime>",
//       "events": [
//         {
//           "nostrud_fd6": -68241256.05178377
//         },
//         {
//           "ullamcoe": "ad",
//           "adipisicing_1": false
//         }
//       ],
//       "id": "<integer>",
//       "metadata": {
//         "veniam_689": -18333948.100650415,
//         "elit_2ab": "eu dolor deserunt consequat dolore"
//       },
//       "ticket_id": "<integer>",
//       "via": {
//         "channel": "<string>",
//         "source": {
//           "sint490": -68016605.99205834
//         }
//       }
//     }
//   ],
//   "before_cursor": "<string>",
//   "before_url": "<string>"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

after_cursor := CkJsonObject__stringOf(jResp,'after_cursor');
after_url := CkJsonObject__stringOf(jResp,'after_url');
before_cursor := CkJsonObject__stringOf(jResp,'before_cursor');
before_url := CkJsonObject__stringOf(jResp,'before_url');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'audits');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    author_id := CkJsonObject__stringOf(jResp,'audits[i].author_id');
    created_at := CkJsonObject__stringOf(jResp,'audits[i].created_at');
    id := CkJsonObject__stringOf(jResp,'audits[i].id');
    Aute__ := CkJsonObject__stringOf(jResp,'audits[i].metadata.aute__');
    Ex_ae := CkJsonObject__stringOf(jResp,'audits[i].metadata.ex_ae');
    ticket_id := CkJsonObject__stringOf(jResp,'audits[i].ticket_id');
    Channel := CkJsonObject__stringOf(jResp,'audits[i].via.channel');
    Et_c59 := CkJsonObject_IntOf(jResp,'audits[i].via.source.et_c59');
    Veniam_689 := CkJsonObject__stringOf(jResp,'audits[i].metadata.veniam_689');
    Elit_2ab := CkJsonObject__stringOf(jResp,'audits[i].metadata.elit_2ab');
    Sint490 := CkJsonObject__stringOf(jResp,'audits[i].via.source.sint490');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'audits[i].events');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        voluptate_edf := CkJsonObject__stringOf(jResp,'audits[i].events[j].voluptate_edf');
        dolor0 := CkJsonObject_IntOf(jResp,'audits[i].events[j].dolor0');
        sedb2 := CkJsonObject_BoolOf(jResp,'audits[i].events[j].sedb2');
        nostrud_fd6 := CkJsonObject__stringOf(jResp,'audits[i].events[j].nostrud_fd6');
        ullamcoe := CkJsonObject__stringOf(jResp,'audits[i].events[j].ullamcoe');
        adipisicing_1 := CkJsonObject_BoolOf(jResp,'audits[i].events[j].adipisicing_1');
        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 "limit=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_audits

Postman Collection Item JSON

{
  "name": "List All Ticket Audits",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/ticket_audits?limit=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "ticket_audits"
      ],
      "query": [
        {
          "key": "limit",
          "value": "<integer>",
          "description": "Maximum number of results returned"
        }
      ]
    },
    "description": "Returns ticket audits. Archived tickets are not included in the response. Use the [List Audits for a Ticket](#list-audits-for-a-ticket) endpoint to \nretrieve audit records for an archived ticket. To learn more about archived tickets, see [About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756).\n\nThis endpoint should not be used for capturing change data. When continually chasing the tail of a cursor, some records will be skipped. For this use case, use the [Incremental Ticket Event Export API](/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-event-export).\n\n#### Pagination\n\n- Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins\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/ticket_audits?limit=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "ticket_audits"
          ],
          "query": [
            {
              "key": "limit",
              "value": "<integer>",
              "description": "Maximum number of results returned"
            }
          ]
        }
      },
      "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  \"audits\": [\n    {\n      \"author_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"events\": [\n        {\n          \"voluptate_edf\": 37194901.82832828,\n          \"dolor0\": 61753613\n        },\n        {\n          \"sedb2\": false\n        }\n      ],\n      \"id\": \"<integer>\",\n      \"metadata\": {\n        \"aute__\": \"proident aute qui culpa\",\n        \"ex_ae\": \"dolore Lorem labore ut\"\n      },\n      \"ticket_id\": \"<integer>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"et_c59\": 68912889\n        }\n      }\n    },\n    {\n      \"author_id\": \"<integer>\",\n      \"created_at\": \"<dateTime>\",\n      \"events\": [\n        {\n          \"nostrud_fd6\": -68241256.05178377\n        },\n        {\n          \"ullamcoe\": \"ad\",\n          \"adipisicing_1\": false\n        }\n      ],\n      \"id\": \"<integer>\",\n      \"metadata\": {\n        \"veniam_689\": -18333948.100650415,\n        \"elit_2ab\": \"eu dolor deserunt consequat dolore\"\n      },\n      \"ticket_id\": \"<integer>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"sint490\": -68016605.99205834\n        }\n      }\n    }\n  ],\n  \"before_cursor\": \"<string>\",\n  \"before_url\": \"<string>\"\n}"
    }
  ]
}