Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"source","{{auditSource}}")
CkJsonObject::ckUpdateInt(queryParams,"_pageSize",10)
CkJsonObject::ckUpdateString(queryParams,"_prettyPrint","true")
CkHttp::ckSetRequestHeader(http,"x-api-secret","{{logApiSecret}}")
CkHttp::ckSetRequestHeader(http,"x-api-key","{{logApiKey}}")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://<tenant-name>.forgeblocks.com/monitoring/logs",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
payload.s
timestamp.s
v_type.s
resultCount.s = CkJsonObject::ckStringOf(jResp,"resultCount")
pagedResultsCookie.s = CkJsonObject::ckStringOf(jResp,"pagedResultsCookie")
totalPagedResultsPolicy.s = CkJsonObject::ckStringOf(jResp,"totalPagedResultsPolicy")
totalPagedResults.s = CkJsonObject::ckStringOf(jResp,"totalPagedResults")
remainingPagedResults.s = CkJsonObject::ckStringOf(jResp,"remainingPagedResults")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"result")
While i < count_i
CkJsonObject::setCkI(jResp, i)
payload = CkJsonObject::ckStringOf(jResp,"result[i].payload")
timestamp = CkJsonObject::ckStringOf(jResp,"result[i].timestamp")
v_type = CkJsonObject::ckStringOf(jResp,"result[i].type")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
