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
DECLARE @iTmp0 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
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'source', '{{auditSource}}'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, '_pageSize', 10
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, '_prettyPrint', 'true'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-api-secret', '{{logApiSecret}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-api-key', '{{logApiKey}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://<tenant-name>.forgeblocks.com/monitoring/logs', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
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 @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "result": [
-- {
-- "payload": "<object>",
-- "timestamp": "<dateTime>",
-- "type": "<string>"
-- },
-- {
-- "payload": "<object>",
-- "timestamp": "<dateTime>",
-- "type": "<string>"
-- }
-- ],
-- "resultCount": "<integer>",
-- "pagedResultsCookie": "<string>",
-- "totalPagedResultsPolicy": "<string>",
-- "totalPagedResults": "<integer>",
-- "remainingPagedResults": "<integer>"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @payload nvarchar(4000)
DECLARE @timestamp nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @resultCount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @resultCount OUT, 'resultCount'
DECLARE @pagedResultsCookie nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pagedResultsCookie OUT, 'pagedResultsCookie'
DECLARE @totalPagedResultsPolicy nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @totalPagedResultsPolicy OUT, 'totalPagedResultsPolicy'
DECLARE @totalPagedResults nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @totalPagedResults OUT, 'totalPagedResults'
DECLARE @remainingPagedResults nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @remainingPagedResults OUT, 'remainingPagedResults'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'result'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @payload OUT, 'result[i].payload'
EXEC sp_OAMethod @jResp, 'StringOf', @timestamp OUT, 'result[i].timestamp'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'result[i].type'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "source=%7B%7BauditSource%7D%7D"
-d "_pageSize=10"
-d "_prettyPrint=true"
-H "x-api-key: {{logApiKey}}"
-H "x-api-secret: {{logApiSecret}}"
https://<tenant-name>.forgeblocks.com/monitoring/logs
Postman Collection Item JSON
{
"name": "Step 2: Get Audit Logs for a Source",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const JSONResponse = pm.response.json();",
"",
"// Tests",
"",
"pm.test(\"Status code is 200.\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains resultCount or result\", function () {",
" pm.expect(JSONResponse).to.have.any.keys('resultCount', 'result');",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{logApiKey}}",
"type": "text"
},
{
"key": "x-api-secret",
"value": "{{logApiSecret}}",
"type": "text"
}
],
"url": {
"raw": "{{platformUrl}}/monitoring/logs?source={{auditSource}}&_pageSize=10&_prettyPrint=true",
"host": [
"{{platformUrl}}"
],
"path": [
"monitoring",
"logs"
],
"query": [
{
"key": "source",
"value": "{{auditSource}}"
},
{
"key": "beginTime",
"value": "2020-08-27T15:10:36.177Z",
"disabled": true
},
{
"key": "endTime",
"value": "{{$isoTimestamp}}",
"disabled": true
},
{
"key": "_pageSize",
"value": "10"
},
{
"key": "_prettyPrint",
"value": "true"
}
]
},
"description": "Get log events"
},
"response": [
{
"name": "List of log events",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/logs?source=<string>&beginTime=<dateTime>&endTime=<dateTime>&_pageSize=<integer>&_pagedResultsCookie=<string>&_prettyPrint=false&_sortKeys=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"logs"
],
"query": [
{
"key": "source",
"value": "<string>"
},
{
"key": "beginTime",
"value": "<dateTime>"
},
{
"key": "endTime",
"value": "<dateTime>"
},
{
"key": "_pageSize",
"value": "<integer>"
},
{
"key": "_pagedResultsCookie",
"value": "<string>"
},
{
"key": "_prettyPrint",
"value": "false"
},
{
"key": "_sortKeys",
"value": "<string>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"result\": [\n\t\t{\n\t\t\t\"payload\": \"<object>\",\n\t\t\t\"timestamp\": \"<dateTime>\",\n\t\t\t\"type\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"payload\": \"<object>\",\n\t\t\t\"timestamp\": \"<dateTime>\",\n\t\t\t\"type\": \"<string>\"\n\t\t}\n\t],\n\t\"resultCount\": \"<integer>\",\n\t\"pagedResultsCookie\": \"<string>\",\n\t\"totalPagedResultsPolicy\": \"<string>\",\n\t\"totalPagedResults\": \"<integer>\",\n\t\"remainingPagedResults\": \"<integer>\"\n}"
}
]
}
