Chilkat Online Tools

lianja / Support API / Show Audit

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loHttp.SetRequestHeader("Accept","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "audit": {
//     "author_id": "<integer>",
//     "created_at": "<dateTime>",
//     "events": [
//       {
//         "proidentb4": true
//       },
//       {
//         "incididunt_dcf": "commodo est mollit laborum"
//       }
//     ],
//     "id": "<integer>",
//     "metadata": {
//       "aliquip_4": true,
//       "cillum_3": 38133397,
//       "fugiat_6": "magna",
//       "velit_3": -35308847
//     },
//     "ticket_id": "<integer>",
//     "via": {
//       "channel": "<string>",
//       "source": {
//         "fugiatc": 39106364.288705826
//       }
//     }
//   }
// }

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

lcAuthor_id = loJResp.StringOf("audit.author_id")
lcCreated_at = loJResp.StringOf("audit.created_at")
lcId = loJResp.StringOf("audit.id")
llAliquip_4 = loJResp.BoolOf("audit.metadata.aliquip_4")
lnCillum_3 = loJResp.IntOf("audit.metadata.cillum_3")
lcFugiat_6 = loJResp.StringOf("audit.metadata.fugiat_6")
lnVelit_3 = loJResp.IntOf("audit.metadata.velit_3")
lcTicket_id = loJResp.StringOf("audit.ticket_id")
lcChannel = loJResp.StringOf("audit.via.channel")
lcFugiatc = loJResp.StringOf("audit.via.source.fugiatc")
i = 0
lnCount_i = loJResp.SizeOfArray("audit.events")
do while i < lnCount_i
    loJResp.I = i
    llProidentb4 = loJResp.BoolOf("audit.events[i].proidentb4")
    lcIncididunt_dcf = loJResp.StringOf("audit.events[i].incididunt_dcf")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id

Postman Collection Item JSON

{
  "name": "Show Audit",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets",
        ":ticket_id",
        "audits",
        ":ticket_audit_id"
      ],
      "variable": [
        {
          "key": "ticket_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_audit_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/:ticket_audit_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets",
            ":ticket_id",
            "audits",
            ":ticket_audit_id"
          ],
          "variable": [
            {
              "key": "ticket_id"
            },
            {
              "key": "ticket_audit_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"audit\": {\n    \"author_id\": \"<integer>\",\n    \"created_at\": \"<dateTime>\",\n    \"events\": [\n      {\n        \"proidentb4\": true\n      },\n      {\n        \"incididunt_dcf\": \"commodo est mollit laborum\"\n      }\n    ],\n    \"id\": \"<integer>\",\n    \"metadata\": {\n      \"aliquip_4\": true,\n      \"cillum_3\": 38133397,\n      \"fugiat_6\": \"magna\",\n      \"velit_3\": -35308847\n    },\n    \"ticket_id\": \"<integer>\",\n    \"via\": {\n      \"channel\": \"<string>\",\n      \"source\": {\n        \"fugiatc\": 39106364.288705826\n      }\n    }\n  }\n}"
    }
  ]
}