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 ComUpdateInt Of hoQueryParams "number" 3 To iSuccess
Get ComUpdateString Of hoQueryParams "units" "MONTHS" 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/since" 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": "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
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 "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": ""
}
]
}