Chilkat Online Tools

Swift / Atlassian Confluence Cloud / Get audit records for time period

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()
    var success: Bool

    let queryParams = CkoJsonObject()
    queryParams.UpdateInt("number", value: 3)
    queryParams.UpdateString("units", value: "MONTHS")
    queryParams.UpdateString("searchString", value: "<string>")
    queryParams.UpdateInt("start", value: 0)
    queryParams.UpdateInt("limit", value: 1000)

    var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://your-domain.atlassian.net/wiki/rest/api/audit/since", json: queryParams)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var v_Type: String?
    var DisplayName: String?
    var Operations: String?
    var Username: String?
    var UserKey: String?
    var remoteAddress: String?
    var creationDate: Int
    var summary: String?
    var description: String?
    var category: String?
    var sysAdmin: Bool
    var Name: String?
    var ObjectType: String?
    var j: Int
    var count_j: Int
    var name: String?
    var oldValue: String?
    var newValue: String?
    var objectType: String?

    var start: Int = jResp.IntOf("start").intValue
    var limit: Int = jResp.IntOf("limit").intValue
    var size: Int = jResp.IntOf("size").intValue
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("results").intValue
    while i < count_i {
        jResp.I = i
        v_Type = jResp.StringOf("results[i].author.type")
        DisplayName = jResp.StringOf("results[i].author.displayName")
        Operations = jResp.StringOf("results[i].author.operations")
        Username = jResp.StringOf("results[i].author.username")
        UserKey = jResp.StringOf("results[i].author.userKey")
        remoteAddress = jResp.StringOf("results[i].remoteAddress")
        creationDate = jResp.IntOf("results[i].creationDate").intValue
        summary = jResp.StringOf("results[i].summary")
        description = jResp.StringOf("results[i].description")
        category = jResp.StringOf("results[i].category")
        sysAdmin = jResp.BoolOf("results[i].sysAdmin")
        Name = jResp.StringOf("results[i].affectedObject.name")
        ObjectType = jResp.StringOf("results[i].affectedObject.objectType")
        j = 0
        count_j = jResp.SizeOfArray("results[i].changedValues").intValue
        while j < count_j {
            jResp.J = j
            name = jResp.StringOf("results[i].changedValues[j].name")
            oldValue = jResp.StringOf("results[i].changedValues[j].oldValue")
            newValue = jResp.StringOf("results[i].changedValues[j].newValue")
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("results[i].associatedObjects").intValue
        while j < count_j {
            jResp.J = j
            name = jResp.StringOf("results[i].associatedObjects[j].name")
            objectType = jResp.StringOf("results[i].associatedObjects[j].objectType")
            j = j + 1
        }

        i = i + 1
    }


}

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