SQL Server / Support API / Show Audit Log
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/audit_logs/:audit_log_id', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @Action nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Action OUT, 'audit_log.action'
DECLARE @Action_label nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Action_label OUT, 'audit_log.action_label'
DECLARE @Actor_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Actor_id OUT, 'audit_log.actor_id'
DECLARE @Actor_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Actor_name OUT, 'audit_log.actor_name'
DECLARE @Change_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Change_description OUT, 'audit_log.change_description'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'audit_log.created_at'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'audit_log.id'
DECLARE @Ip_address nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Ip_address OUT, 'audit_log.ip_address'
DECLARE @Source_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Source_id OUT, 'audit_log.source_id'
DECLARE @Source_label nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Source_label OUT, 'audit_log.source_label'
DECLARE @Source_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Source_type OUT, 'audit_log.source_type'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'audit_log.url'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
