Swift3 / Support API / List Audits for a Ticket
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "login"
http.password = "password"
http.setRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()!
success = http.quickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits", sbContent: sbResponseBody)
if success == false {
print("\(http.lastErrorText!)")
return
}
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = http.lastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.lastHeader!)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "audits": [
// {
// "author_id": "<integer>",
// "created_at": "<dateTime>",
// "events": [
// {
// "in14": 98255426.2140105,
// "consequat_b9": false,
// "Lorem4": -18718960,
// "incididunt_a": 91476803.94307658
// },
// {
// "ipsume1": -99329065,
// "laboris_8c": 89859673.3933256,
// "consectetur6": true
// }
// ],
// "id": "<integer>",
// "metadata": {
// "fugiat2_": 32930402.342455566,
// "aliqua4f": false
// },
// "ticket_id": "<integer>",
// "via": {
// "channel": "<string>",
// "source": {
// "amet29d": "veniam",
// "aliqua_b0": -53884767.66002053,
// "amet_24": 77146472.24303994,
// "non_b8": 30237848
// }
// }
// },
// {
// "author_id": "<integer>",
// "created_at": "<dateTime>",
// "events": [
// {
// "officia1": true
// },
// {
// "minim_27": true,
// "Ut7_2": -37549201.88334068
// }
// ],
// "id": "<integer>",
// "metadata": {
// "in_3a": 96878618,
// "occaecat_d98": 24309571
// },
// "ticket_id": "<integer>",
// "via": {
// "channel": "<string>",
// "source": {
// "commodo_60e": true
// }
// }
// }
// ],
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var author_id: String?
var created_at: String?
var id: String?
var Fugiat2_: String?
var Aliqua4f: Bool
var ticket_id: String?
var Channel: String?
var Amet29d: String?
var Aliqua_b0: String?
var Amet_24: String?
var Non_b8: Int
var In_3a: Int
var Occaecat_d98: Int
var Commodo_60e: Bool
var j: Int
var count_j: Int
var in14: String?
var consequat_b9: Bool
var Lorem4: Int
var incididunt_a: String?
var ipsume1: Int
var laboris_8c: String?
var consectetur6: Bool
var officia1: Bool
var minim_27: Bool
var Ut7_2: String?
var count: String? = jResp.string(of: "count")
var next_page: String? = jResp.string(of: "next_page")
var previous_page: String? = jResp.string(of: "previous_page")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "audits").intValue
while i < count_i {
jResp.i = i
author_id = jResp.string(of: "audits[i].author_id")
created_at = jResp.string(of: "audits[i].created_at")
id = jResp.string(of: "audits[i].id")
Fugiat2_ = jResp.string(of: "audits[i].metadata.fugiat2_")
Aliqua4f = jResp.bool(of: "audits[i].metadata.aliqua4f")
ticket_id = jResp.string(of: "audits[i].ticket_id")
Channel = jResp.string(of: "audits[i].via.channel")
Amet29d = jResp.string(of: "audits[i].via.source.amet29d")
Aliqua_b0 = jResp.string(of: "audits[i].via.source.aliqua_b0")
Amet_24 = jResp.string(of: "audits[i].via.source.amet_24")
Non_b8 = jResp.int(of: "audits[i].via.source.non_b8").intValue
In_3a = jResp.int(of: "audits[i].metadata.in_3a").intValue
Occaecat_d98 = jResp.int(of: "audits[i].metadata.occaecat_d98").intValue
Commodo_60e = jResp.bool(of: "audits[i].via.source.commodo_60e")
j = 0
count_j = jResp.size(ofArray: "audits[i].events").intValue
while j < count_j {
jResp.j = j
in14 = jResp.string(of: "audits[i].events[j].in14")
consequat_b9 = jResp.bool(of: "audits[i].events[j].consequat_b9")
Lorem4 = jResp.int(of: "audits[i].events[j].Lorem4").intValue
incididunt_a = jResp.string(of: "audits[i].events[j].incididunt_a")
ipsume1 = jResp.int(of: "audits[i].events[j].ipsume1").intValue
laboris_8c = jResp.string(of: "audits[i].events[j].laboris_8c")
consectetur6 = jResp.bool(of: "audits[i].events[j].consectetur6")
officia1 = jResp.bool(of: "audits[i].events[j].officia1")
minim_27 = jResp.bool(of: "audits[i].events[j].minim_27")
Ut7_2 = jResp.string(of: "audits[i].events[j].Ut7_2")
j = j + 1
}
i = i + 1
}
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/audits
Postman Collection Item JSON
{
"name": "List Audits for a Ticket",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Lists the audits for a specified ticket.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n**Note**: Audits for [Archived Tickets](https://support.zendesk.com/hc/en-us/articles/4408887617050) do not support pagination for this endpoint.\n\n#### Allowed for\n\n* Agents\n"
},
"response": [
{
"name": "OK response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"audits\": [\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"in14\": 98255426.2140105,\n \"consequat_b9\": false,\n \"Lorem4\": -18718960,\n \"incididunt_a\": 91476803.94307658\n },\n {\n \"ipsume1\": -99329065,\n \"laboris_8c\": 89859673.3933256,\n \"consectetur6\": true\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"fugiat2_\": 32930402.342455566,\n \"aliqua4f\": false\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"amet29d\": \"veniam\",\n \"aliqua_b0\": -53884767.66002053,\n \"amet_24\": 77146472.24303994,\n \"non_b8\": 30237848\n }\n }\n },\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"officia1\": true\n },\n {\n \"minim_27\": true,\n \"Ut7_2\": -37549201.88334068\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"in_3a\": 96878618,\n \"occaecat_d98\": 24309571\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"commodo_60e\": true\n }\n }\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
