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::ckUpdateInt(queryParams,"number",3)
CkJsonObject::ckUpdateString(queryParams,"units","MONTHS")
CkJsonObject::ckUpdateString(queryParams,"searchString","<string>")
CkJsonObject::ckUpdateInt(queryParams,"start",0)
CkJsonObject::ckUpdateInt(queryParams,"limit",1000)
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://your-domain.atlassian.net/wiki/rest/api/audit/since",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)
; {
; "results": [
; {
; "author": {
; "type": "user",
; "displayName": "eu qui amet",
; "operations": null,
; "username": "ut",
; "userKey": "amet ut eu Ut"
; },
; "remoteAddress": "irure sed commodo tempor",
; "creationDate": -28489517,
; "summary": "reprehenderit occaecat",
; "description": "sed in occaecat",
; "category": "magna qui Lorem",
; "sysAdmin": false,
; "affectedObject": {
; "name": "Ut est ad eu anim",
; "objectType": "tempor Excepteur"
; },
; "changedValues": [
; {
; "name": "non anim sint qui",
; "oldValue": "amet est qui esse",
; "newValue": "tempor quis"
; },
; {
; "name": "sed ipsum aut",
; "oldValue": "culpa",
; "newValue": "occaecat ad"
; }
; ],
; "associatedObjects": [
; {
; "name": "Excepteur fugiat",
; "objectType": "aute sint quis eiusmod qui"
; },
; {
; "name": "esse laborum in",
; "objectType": "magna irure"
; }
; ]
; },
; {
; "author": {
; "type": "user",
; "displayName": "anim nisi occaecat ipsum",
; "operations": null,
; "username": "anim in proident ex et",
; "userKey": "dolore sunt"
; },
; "remoteAddress": "ipsum mollit est",
; "creationDate": -68787259,
; "summary": "labore cupidatat amet laborum",
; "description": "et ea dolore",
; "category": "consequat ex enim occaecat",
; "sysAdmin": true,
; "affectedObject": {
; "name": "irure occaecat proident dolor id",
; "objectType": "veniam Ut in magna"
; },
; "changedValues": [
; {
; "name": "proident sunt laboris",
; "oldValue": "ut sunt dolore ullamco",
; "newValue": "enim adipisicing"
; },
; {
; "name": "non cillum laborum reprehenderit",
; "oldValue": "in mollit consectetur",
; "newValue": "fugiat ut anim pariatur"
; }
; ],
; "associatedObjects": [
; {
; "name": "qui anim dolore",
; "objectType": ""
; },
; {
; "name": "enim pariatur in ut sed",
; "objectType": "nostrud"
; }
; ]
; }
; ],
; "start": -42437008,
; "limit": 95954729,
; "size": -54456786,
; "_links": {}
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Type.s
DisplayName.s
Operations.s
Username.s
UserKey.s
remoteAddress.s
creationDate.i
summary.s
description.s
category.s
sysAdmin.i
Name.s
ObjectType.s
j.i
count_j.i
name.s
oldValue.s
newValue.s
objectType.s
start.i = CkJsonObject::ckIntOf(jResp,"start")
limit.i = CkJsonObject::ckIntOf(jResp,"limit")
size.i = CkJsonObject::ckIntOf(jResp,"size")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_Type = CkJsonObject::ckStringOf(jResp,"results[i].author.type")
DisplayName = CkJsonObject::ckStringOf(jResp,"results[i].author.displayName")
Operations = CkJsonObject::ckStringOf(jResp,"results[i].author.operations")
Username = CkJsonObject::ckStringOf(jResp,"results[i].author.username")
UserKey = CkJsonObject::ckStringOf(jResp,"results[i].author.userKey")
remoteAddress = CkJsonObject::ckStringOf(jResp,"results[i].remoteAddress")
creationDate = CkJsonObject::ckIntOf(jResp,"results[i].creationDate")
summary = CkJsonObject::ckStringOf(jResp,"results[i].summary")
description = CkJsonObject::ckStringOf(jResp,"results[i].description")
category = CkJsonObject::ckStringOf(jResp,"results[i].category")
sysAdmin = CkJsonObject::ckBoolOf(jResp,"results[i].sysAdmin")
Name = CkJsonObject::ckStringOf(jResp,"results[i].affectedObject.name")
ObjectType = CkJsonObject::ckStringOf(jResp,"results[i].affectedObject.objectType")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].changedValues")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"results[i].changedValues[j].name")
oldValue = CkJsonObject::ckStringOf(jResp,"results[i].changedValues[j].oldValue")
newValue = CkJsonObject::ckStringOf(jResp,"results[i].changedValues[j].newValue")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"results[i].associatedObjects")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"results[i].associatedObjects[j].name")
objectType = CkJsonObject::ckStringOf(jResp,"results[i].associatedObjects[j].objectType")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "number=3"
-d "units=MONTHS"
-d "searchString=%3Cstring%3E"
-d "start=0"
-d "limit=1000"
https://your-domain.atlassian.net/wiki/rest/api/audit/since
Postman Collection Item JSON
{
"name": "Get audit records for time period",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit/since?number=3&units=MONTHS&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"since"
],
"query": [
{
"key": "number",
"value": "3",
"description": "The number of units for the time period."
},
{
"key": "units",
"value": "MONTHS",
"description": "The unit of time that the time period is measured in."
},
{
"key": "searchString",
"value": "<string>",
"description": "Filters the results to records that have string property values\nmatching the `searchString`."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the returned records."
},
{
"key": "limit",
"value": "1000",
"description": "The maximum number of records to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"description": "Returns records from the audit log, for a time period back from the current\ndate. For example, you can use this method to get the last 3 months of records.\n\nThis contains information about events like space exports, group membership\nchanges, app installations, etc. For more information, see\n[Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)\nin the Confluence administrator's guide.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
},
"response": [
{
"name": "Returned if the requested records are returned.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit/since?number=3&units=MONTHS&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"since"
],
"query": [
{
"key": "number",
"value": "3"
},
{
"key": "units",
"value": "MONTHS"
},
{
"key": "searchString",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "1000"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"author\": {\n \"type\": \"user\",\n \"displayName\": \"eu qui amet\",\n \"operations\": null,\n \"username\": \"ut\",\n \"userKey\": \"amet ut eu Ut\"\n },\n \"remoteAddress\": \"irure sed commodo tempor\",\n \"creationDate\": -28489517,\n \"summary\": \"reprehenderit occaecat\",\n \"description\": \"sed in occaecat\",\n \"category\": \"magna qui Lorem\",\n \"sysAdmin\": false,\n \"affectedObject\": {\n \"name\": \"Ut est ad eu anim\",\n \"objectType\": \"tempor Excepteur\"\n },\n \"changedValues\": [\n {\n \"name\": \"non anim sint qui\",\n \"oldValue\": \"amet est qui esse\",\n \"newValue\": \"tempor quis\"\n },\n {\n \"name\": \"sed ipsum aut\",\n \"oldValue\": \"culpa\",\n \"newValue\": \"occaecat ad\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"Excepteur fugiat\",\n \"objectType\": \"aute sint quis eiusmod qui\"\n },\n {\n \"name\": \"esse laborum in\",\n \"objectType\": \"magna irure\"\n }\n ]\n },\n {\n \"author\": {\n \"type\": \"user\",\n \"displayName\": \"anim nisi occaecat ipsum\",\n \"operations\": null,\n \"username\": \"anim in proident ex et\",\n \"userKey\": \"dolore sunt\"\n },\n \"remoteAddress\": \"ipsum mollit est\",\n \"creationDate\": -68787259,\n \"summary\": \"labore cupidatat amet laborum\",\n \"description\": \"et ea dolore\",\n \"category\": \"consequat ex enim occaecat\",\n \"sysAdmin\": true,\n \"affectedObject\": {\n \"name\": \"irure occaecat proident dolor id\",\n \"objectType\": \"veniam Ut in magna\"\n },\n \"changedValues\": [\n {\n \"name\": \"proident sunt laboris\",\n \"oldValue\": \"ut sunt dolore ullamco\",\n \"newValue\": \"enim adipisicing\"\n },\n {\n \"name\": \"non cillum laborum reprehenderit\",\n \"oldValue\": \"in mollit consectetur\",\n \"newValue\": \"fugiat ut anim pariatur\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"qui anim dolore\",\n \"objectType\": \"\"\n },\n {\n \"name\": \"enim pariatur in ut sed\",\n \"objectType\": \"nostrud\"\n }\n ]\n }\n ],\n \"start\": -42437008,\n \"limit\": 95954729,\n \"size\": -54456786,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user does not have permission to view the audit\nlog.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit/since?number=3&units=MONTHS&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit",
"since"
],
"query": [
{
"key": "number",
"value": "3"
},
{
"key": "units",
"value": "MONTHS"
},
{
"key": "searchString",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "1000"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
