Chilkat Online Tools

SQL Server / Atlassian Confluence Cloud / Get audit records

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'startDate', '<string>'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'endDate', '<string>'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'searchString', '<string>'
    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'start', 0
    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 1000

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://your-domain.atlassian.net/wiki/rest/api/audit', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

    -- 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

    DECLARE @v_Type nvarchar(4000)

    DECLARE @DisplayName nvarchar(4000)

    DECLARE @Operations nvarchar(4000)

    DECLARE @Username nvarchar(4000)

    DECLARE @UserKey nvarchar(4000)

    DECLARE @remoteAddress nvarchar(4000)

    DECLARE @creationDate int

    DECLARE @summary nvarchar(4000)

    DECLARE @description nvarchar(4000)

    DECLARE @category nvarchar(4000)

    DECLARE @sysAdmin int

    DECLARE @Name nvarchar(4000)

    DECLARE @ObjectType nvarchar(4000)

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @name nvarchar(4000)

    DECLARE @oldValue nvarchar(4000)

    DECLARE @newValue nvarchar(4000)

    DECLARE @objectType nvarchar(4000)

    DECLARE @start int
    EXEC sp_OAMethod @jResp, 'IntOf', @start OUT, 'start'
    DECLARE @limit int
    EXEC sp_OAMethod @jResp, 'IntOf', @limit OUT, 'limit'
    DECLARE @size int
    EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'results'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'results[i].author.type'
        EXEC sp_OAMethod @jResp, 'StringOf', @DisplayName OUT, 'results[i].author.displayName'
        EXEC sp_OAMethod @jResp, 'StringOf', @Operations OUT, 'results[i].author.operations'
        EXEC sp_OAMethod @jResp, 'StringOf', @Username OUT, 'results[i].author.username'
        EXEC sp_OAMethod @jResp, 'StringOf', @UserKey OUT, 'results[i].author.userKey'
        EXEC sp_OAMethod @jResp, 'StringOf', @remoteAddress OUT, 'results[i].remoteAddress'
        EXEC sp_OAMethod @jResp, 'IntOf', @creationDate OUT, 'results[i].creationDate'
        EXEC sp_OAMethod @jResp, 'StringOf', @summary OUT, 'results[i].summary'
        EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'results[i].description'
        EXEC sp_OAMethod @jResp, 'StringOf', @category OUT, 'results[i].category'
        EXEC sp_OAMethod @jResp, 'BoolOf', @sysAdmin OUT, 'results[i].sysAdmin'
        EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'results[i].affectedObject.name'
        EXEC sp_OAMethod @jResp, 'StringOf', @ObjectType OUT, 'results[i].affectedObject.objectType'
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].changedValues'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'results[i].changedValues[j].name'
            EXEC sp_OAMethod @jResp, 'StringOf', @oldValue OUT, 'results[i].changedValues[j].oldValue'
            EXEC sp_OAMethod @jResp, 'StringOf', @newValue OUT, 'results[i].changedValues[j].newValue'
            SELECT @j = @j + 1
          END
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'results[i].associatedObjects'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'results[i].associatedObjects[j].name'
            EXEC sp_OAMethod @jResp, 'StringOf', @objectType OUT, 'results[i].associatedObjects[j].objectType'
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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": ""
    }
  ]
}