Chilkat Online Tools

TCL / Support API / Show Audit

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set Author_id [CkJsonObject_stringOf $jResp "audit.author_id"]
set Created_at [CkJsonObject_stringOf $jResp "audit.created_at"]
set Id [CkJsonObject_stringOf $jResp "audit.id"]
set Aliquip_4 [CkJsonObject_BoolOf $jResp "audit.metadata.aliquip_4"]
set Cillum_3 [CkJsonObject_IntOf $jResp "audit.metadata.cillum_3"]
set Fugiat_6 [CkJsonObject_stringOf $jResp "audit.metadata.fugiat_6"]
set Velit_3 [CkJsonObject_IntOf $jResp "audit.metadata.velit_3"]
set Ticket_id [CkJsonObject_stringOf $jResp "audit.ticket_id"]
set Channel [CkJsonObject_stringOf $jResp "audit.via.channel"]
set Fugiatc [CkJsonObject_stringOf $jResp "audit.via.source.fugiatc"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "audit.events"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set proidentb4 [CkJsonObject_BoolOf $jResp "audit.events[i].proidentb4"]
    set incididunt_dcf [CkJsonObject_stringOf $jResp "audit.events[i].incididunt_dcf"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}