Chilkat Online Tools

Powershell / Support API / Show Audit

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_id",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    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

$Author_id = $jResp.StringOf("audit.author_id")
$Created_at = $jResp.StringOf("audit.created_at")
$Id = $jResp.StringOf("audit.id")
$Aliquip_4 = $jResp.BoolOf("audit.metadata.aliquip_4")
$Cillum_3 = $jResp.IntOf("audit.metadata.cillum_3")
$Fugiat_6 = $jResp.StringOf("audit.metadata.fugiat_6")
$Velit_3 = $jResp.IntOf("audit.metadata.velit_3")
$Ticket_id = $jResp.StringOf("audit.ticket_id")
$Channel = $jResp.StringOf("audit.via.channel")
$Fugiatc = $jResp.StringOf("audit.via.source.fugiatc")
$i = 0
$count_i = $jResp.SizeOfArray("audit.events")
while ($i -lt $count_i) {
    $jResp.I = $i
    $proidentb4 = $jResp.BoolOf("audit.events[i].proidentb4")
    $incididunt_dcf = $jResp.StringOf("audit.events[i].incididunt_dcf")
    $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/: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}"
    }
  ]
}