Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_Type
String sDisplayName
String sOperations
String sUsername
String sUserKey
String sRemoteAddress
Integer iCreationDate
String sSummary
String sDescription
String sCategory
Boolean iSysAdmin
String sName
String sObjectType
Integer j
Integer iCount_j
String sName
String sOldValue
String sNewValue
String sObjectType
Integer iStart
Integer iLimit
Integer iSize
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "startDate" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "endDate" "<string>" To iSuccess
Get ComUpdateString Of hoQueryParams "searchString" "<string>" To iSuccess
Get ComUpdateInt Of hoQueryParams "start" 0 To iSuccess
Get ComUpdateInt Of hoQueryParams "limit" 1000 To iSuccess
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://your-domain.atlassian.net/wiki/rest/api/audit" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "results": [
// {
// "author": {
// "type": "user",
// "displayName": "ut qui occaecat",
// "operations": null,
// "username": "officia dolor",
// "userKey": "Ut Lorem"
// },
// "remoteAddress": "ullamco tempor id",
// "creationDate": 87607791,
// "summary": "ut laboris qui Ut",
// "description": "pariatur ut cillum id quis",
// "category": "pariatur et sunt enim dolor",
// "sysAdmin": true,
// "affectedObject": {
// "name": "pariatur ea eu",
// "objectType": "exerci"
// },
// "changedValues": [
// {
// "name": "voluptate Lorem nostrud",
// "oldValue": "exercitation dolor",
// "newValue": "nulla proident"
// },
// {
// "name": "proid",
// "oldValue": "sint eu",
// "newValue": "sed adipisicing irure"
// }
// ],
// "associatedObjects": [
// {
// "name": "eiusmod aliquip incididunt",
// "objectType": "laboris aute elit tempor"
// },
// {
// "name": "dolore adipisicing",
// "objectType": "eiusmod cillum sunt Ut cupidatat"
// }
// ]
// },
// {
// "author": {
// "type": "user",
// "displayName": "deserunt laboris voluptate cupidatat",
// "operations": null,
// "username": "et cillum ut cupidatat",
// "userKey": "qui magna eu deserunt"
// },
// "remoteAddress": "v",
// "creationDate": 42657177,
// "summary": "enim sit dolore cillum",
// "description": "Excepteur sit",
// "category": "exercitation in ea",
// "sysAdmin": true,
// "affectedObject": {
// "name": "ex cillum",
// "objectType": "eu officia veniam labore"
// },
// "changedValues": [
// {
// "name": "dolor laborum sed do sunt",
// "oldValue": "dolor eiusmod",
// "newValue": "nulla"
// },
// {
// "name": "consectetur eiusmod",
// "oldValue": "Except",
// "newValue": "culpa aliquip"
// }
// ],
// "associatedObjects": [
// {
// "name": "adipisicing aliquip",
// "objectType": "elit Ut laboris"
// },
// {
// "name": "anim",
// "objectType": "dolore in voluptate"
// }
// ]
// }
// ],
// "start": 48713254,
// "limit": 16739977,
// "size": -39928545,
// "_links": {}
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComIntOf Of hoJResp "start" To iStart
Get ComIntOf Of hoJResp "limit" To iLimit
Get ComIntOf Of hoJResp "size" To iSize
Move 0 To i
Get ComSizeOfArray Of hoJResp "results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "results[i].author.type" To sV_Type
Get ComStringOf Of hoJResp "results[i].author.displayName" To sDisplayName
Get ComStringOf Of hoJResp "results[i].author.operations" To sOperations
Get ComStringOf Of hoJResp "results[i].author.username" To sUsername
Get ComStringOf Of hoJResp "results[i].author.userKey" To sUserKey
Get ComStringOf Of hoJResp "results[i].remoteAddress" To sRemoteAddress
Get ComIntOf Of hoJResp "results[i].creationDate" To iCreationDate
Get ComStringOf Of hoJResp "results[i].summary" To sSummary
Get ComStringOf Of hoJResp "results[i].description" To sDescription
Get ComStringOf Of hoJResp "results[i].category" To sCategory
Get ComBoolOf Of hoJResp "results[i].sysAdmin" To iSysAdmin
Get ComStringOf Of hoJResp "results[i].affectedObject.name" To sName
Get ComStringOf Of hoJResp "results[i].affectedObject.objectType" To sObjectType
Move 0 To j
Get ComSizeOfArray Of hoJResp "results[i].changedValues" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "results[i].changedValues[j].name" To sName
Get ComStringOf Of hoJResp "results[i].changedValues[j].oldValue" To sOldValue
Get ComStringOf Of hoJResp "results[i].changedValues[j].newValue" To sNewValue
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "results[i].associatedObjects" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "results[i].associatedObjects[j].name" To sName
Get ComStringOf Of hoJResp "results[i].associatedObjects[j].objectType" To sObjectType
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "startDate=%3Cstring%3E"
-d "endDate=%3Cstring%3E"
-d "searchString=%3Cstring%3E"
-d "start=0"
-d "limit=1000"
https://your-domain.atlassian.net/wiki/rest/api/audit
Postman Collection Item JSON
{
"name": "Get audit records",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>",
"description": "Filters the results to the records on or after the `startDate`.\nThe `startDate` must be specified as a [timestamp](https://www.unixtimestamp.com/)."
},
{
"key": "endDate",
"value": "<string>",
"description": "Filters the results to the records on or before the `endDate`.\nThe `endDate` must be specified as a [timestamp](https://www.unixtimestamp.com/)."
},
{
"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 all records in the audit log, optionally for a certain date range.\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?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>"
},
{
"key": "endDate",
"value": "<string>"
},
{
"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\": \"ut qui occaecat\",\n \"operations\": null,\n \"username\": \"officia dolor\",\n \"userKey\": \"Ut Lorem\"\n },\n \"remoteAddress\": \"ullamco tempor id\",\n \"creationDate\": 87607791,\n \"summary\": \"ut laboris qui Ut\",\n \"description\": \"pariatur ut cillum id quis\",\n \"category\": \"pariatur et sunt enim dolor\",\n \"sysAdmin\": true,\n \"affectedObject\": {\n \"name\": \"pariatur ea eu\",\n \"objectType\": \"exerci\"\n },\n \"changedValues\": [\n {\n \"name\": \"voluptate Lorem nostrud\",\n \"oldValue\": \"exercitation dolor\",\n \"newValue\": \"nulla proident\"\n },\n {\n \"name\": \"proid\",\n \"oldValue\": \"sint eu\",\n \"newValue\": \"sed adipisicing irure\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"eiusmod aliquip incididunt\",\n \"objectType\": \"laboris aute elit tempor\"\n },\n {\n \"name\": \"dolore adipisicing\",\n \"objectType\": \"eiusmod cillum sunt Ut cupidatat\"\n }\n ]\n },\n {\n \"author\": {\n \"type\": \"user\",\n \"displayName\": \"deserunt laboris voluptate cupidatat\",\n \"operations\": null,\n \"username\": \"et cillum ut cupidatat\",\n \"userKey\": \"qui magna eu deserunt\"\n },\n \"remoteAddress\": \"v\",\n \"creationDate\": 42657177,\n \"summary\": \"enim sit dolore cillum\",\n \"description\": \"Excepteur sit\",\n \"category\": \"exercitation in ea\",\n \"sysAdmin\": true,\n \"affectedObject\": {\n \"name\": \"ex cillum\",\n \"objectType\": \"eu officia veniam labore\"\n },\n \"changedValues\": [\n {\n \"name\": \"dolor laborum sed do sunt\",\n \"oldValue\": \"dolor eiusmod\",\n \"newValue\": \"nulla\"\n },\n {\n \"name\": \"consectetur eiusmod\",\n \"oldValue\": \"Except\",\n \"newValue\": \"culpa aliquip\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"adipisicing aliquip\",\n \"objectType\": \"elit Ut laboris\"\n },\n {\n \"name\": \"anim\",\n \"objectType\": \"dolore in voluptate\"\n }\n ]\n }\n ],\n \"start\": 48713254,\n \"limit\": 16739977,\n \"size\": -39928545,\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?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>"
},
{
"key": "endDate",
"value": "<string>"
},
{
"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": ""
}
]
}
