Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateInt $queryParams "number" 3
CkJsonObject_UpdateString $queryParams "units" "MONTHS"
CkJsonObject_UpdateString $queryParams "searchString" "<string>"
CkJsonObject_UpdateInt $queryParams "start" 0
CkJsonObject_UpdateInt $queryParams "limit" 1000
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://your-domain.atlassian.net/wiki/rest/api/audit/since" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $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
set start [CkJsonObject_IntOf $jResp "start"]
set limit [CkJsonObject_IntOf $jResp "limit"]
set size [CkJsonObject_IntOf $jResp "size"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "results"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_Type [CkJsonObject_stringOf $jResp "results[i].author.type"]
set DisplayName [CkJsonObject_stringOf $jResp "results[i].author.displayName"]
set Operations [CkJsonObject_stringOf $jResp "results[i].author.operations"]
set Username [CkJsonObject_stringOf $jResp "results[i].author.username"]
set UserKey [CkJsonObject_stringOf $jResp "results[i].author.userKey"]
set remoteAddress [CkJsonObject_stringOf $jResp "results[i].remoteAddress"]
set creationDate [CkJsonObject_IntOf $jResp "results[i].creationDate"]
set summary [CkJsonObject_stringOf $jResp "results[i].summary"]
set description [CkJsonObject_stringOf $jResp "results[i].description"]
set category [CkJsonObject_stringOf $jResp "results[i].category"]
set sysAdmin [CkJsonObject_BoolOf $jResp "results[i].sysAdmin"]
set Name [CkJsonObject_stringOf $jResp "results[i].affectedObject.name"]
set ObjectType [CkJsonObject_stringOf $jResp "results[i].affectedObject.objectType"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].changedValues"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set name [CkJsonObject_stringOf $jResp "results[i].changedValues[j].name"]
set oldValue [CkJsonObject_stringOf $jResp "results[i].changedValues[j].oldValue"]
set newValue [CkJsonObject_stringOf $jResp "results[i].changedValues[j].newValue"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "results[i].associatedObjects"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set name [CkJsonObject_stringOf $jResp "results[i].associatedObjects[j].name"]
set objectType [CkJsonObject_stringOf $jResp "results[i].associatedObjects[j].objectType"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}
