Chilkat Online Tools

autoit / 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.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $bProidentb4
Local $sIncididunt_dcf

Local $sAuthor_id = $oJResp.StringOf("audit.author_id")
Local $sCreated_at = $oJResp.StringOf("audit.created_at")
Local $sId = $oJResp.StringOf("audit.id")
Local $bAliquip_4 = $oJResp.BoolOf("audit.metadata.aliquip_4")
Local $iCillum_3 = $oJResp.IntOf("audit.metadata.cillum_3")
Local $sFugiat_6 = $oJResp.StringOf("audit.metadata.fugiat_6")
Local $iVelit_3 = $oJResp.IntOf("audit.metadata.velit_3")
Local $sTicket_id = $oJResp.StringOf("audit.ticket_id")
Local $sChannel = $oJResp.StringOf("audit.via.channel")
Local $sFugiatc = $oJResp.StringOf("audit.via.source.fugiatc")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("audit.events")
While $i < $iCount_i
    $oJResp.I = $i
    $bProidentb4 = $oJResp.BoolOf("audit.events[i].proidentb4")
    $sIncididunt_dcf = $oJResp.StringOf("audit.events[i].incididunt_dcf")
    $i = $i + 1
Wend

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