Chilkat Online Tools

Foxpro / Support API / Show Audit Log

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAction
LOCAL lcAction_label
LOCAL lcActor_id
LOCAL lcActor_name
LOCAL lcChange_description
LOCAL lcCreated_at
LOCAL lcId
LOCAL lcIp_address
LOCAL lcSource_id
LOCAL lcSource_label
LOCAL lcSource_type
LOCAL lcV_Url

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

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

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

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/audit_logs/:audit_log_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
ENDIF

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

* {
*   "audit_log": {
*     "action": "<string>",
*     "action_label": "<string>",
*     "actor_id": "<integer>",
*     "actor_name": "<string>",
*     "change_description": "<string>",
*     "created_at": "<dateTime>",
*     "id": "<integer>",
*     "ip_address": "<string>",
*     "source_id": "<integer>",
*     "source_label": "<string>",
*     "source_type": "<string>",
*     "url": "<string>"
*   }
* }

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

lcAction = loJResp.StringOf("audit_log.action")
lcAction_label = loJResp.StringOf("audit_log.action_label")
lcActor_id = loJResp.StringOf("audit_log.actor_id")
lcActor_name = loJResp.StringOf("audit_log.actor_name")
lcChange_description = loJResp.StringOf("audit_log.change_description")
lcCreated_at = loJResp.StringOf("audit_log.created_at")
lcId = loJResp.StringOf("audit_log.id")
lcIp_address = loJResp.StringOf("audit_log.ip_address")
lcSource_id = loJResp.StringOf("audit_log.source_id")
lcSource_label = loJResp.StringOf("audit_log.source_label")
lcSource_type = loJResp.StringOf("audit_log.source_type")
lcV_Url = loJResp.StringOf("audit_log.url")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/audit_logs/:audit_log_id

Postman Collection Item JSON

{
  "name": "Show Audit Log",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/audit_logs/:audit_log_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "audit_logs",
        ":audit_log_id"
      ],
      "variable": [
        {
          "key": "audit_log_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins on accounts that have audit-log access\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/audit_logs/:audit_log_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "audit_logs",
            ":audit_log_id"
          ],
          "variable": [
            {
              "key": "audit_log_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"audit_log\": {\n    \"action\": \"<string>\",\n    \"action_label\": \"<string>\",\n    \"actor_id\": \"<integer>\",\n    \"actor_name\": \"<string>\",\n    \"change_description\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"ip_address\": \"<string>\",\n    \"source_id\": \"<integer>\",\n    \"source_label\": \"<string>\",\n    \"source_type\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}