SQL Server / Support API / Show Audit
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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/tickets/:ticket_id/audits/:ticket_audit_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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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": {
-- "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
DECLARE @proidentb4 int
DECLARE @incididunt_dcf nvarchar(4000)
DECLARE @Author_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Author_id OUT, 'audit.author_id'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'audit.created_at'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'audit.id'
DECLARE @Aliquip_4 int
EXEC sp_OAMethod @jResp, 'BoolOf', @Aliquip_4 OUT, 'audit.metadata.aliquip_4'
DECLARE @Cillum_3 int
EXEC sp_OAMethod @jResp, 'IntOf', @Cillum_3 OUT, 'audit.metadata.cillum_3'
DECLARE @Fugiat_6 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fugiat_6 OUT, 'audit.metadata.fugiat_6'
DECLARE @Velit_3 int
EXEC sp_OAMethod @jResp, 'IntOf', @Velit_3 OUT, 'audit.metadata.velit_3'
DECLARE @Ticket_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Ticket_id OUT, 'audit.ticket_id'
DECLARE @Channel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Channel OUT, 'audit.via.channel'
DECLARE @Fugiatc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fugiatc OUT, 'audit.via.source.fugiatc'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'audit.events'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'BoolOf', @proidentb4 OUT, 'audit.events[i].proidentb4'
EXEC sp_OAMethod @jResp, 'StringOf', @incididunt_dcf OUT, 'audit.events[i].incididunt_dcf'
SELECT @i = @i + 1
END
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/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}"
}
]
}
