Enhancement request for the output of the audit log REST API "/rest/auditing/1.0/events"

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Unresolved
    • None
    • Component/s: REST API
    • None
    • 1

      The deprecated REST API "/rest/api/2/auditing/record" was removed in Jira 10.0, and users need to use "/rest/auditing/1.0/events" instead. It's nice if we have the following information in the output of the new API when users migrate from the old API.

      • Unique ID number for each entry (ex. '"id": 95' in the following example)
      • Information for the child objects in affectedObjects to know the parent object

       

      The output example of both APIs:

      • /rest/api/2/auditing/record
            {
              "id": 95,
              "summary": "Filter created",
              "remoteAddress": "xxx.xxx.xxx.xxx",
              "authorKey": "admin",
              "created": "2025-05-01T01:36:46.173+0000",
              "category": "filters",
              "eventSource": "Browser",
              "objectItem": {
                "id": "10100",
                "name": "XXXXX",
                "typeName": "FILTER"
              },
              "changedValues": [
                {
                  "fieldName": "Description",
                  "changedFrom": ""
                },
                {
                  "fieldName": "JQL Query",
                  "changedFrom": "",
                  "changedTo": "{project = \"XXXXX\"} order by Rank ASC"
                },
                {
                  "fieldName": "Name",
                  "changedFrom": "",
                  "changedTo": "XXXXX"
                },
                {
                  "fieldName": "Owner",
                  "changedFrom": "",
                  "changedTo": "admin"
                },
                {
                  "fieldName": "Shared with",
                  "changedFrom": "[]",
                  "changedTo": "[Project: XXXXX (VIEW)]"
                }
              ],
              "associatedItems": [
                {
                  "id": "admin",
                  "name": "admin",
                  "typeName": "USER"
                },
                {
                  "id": "10000",
                  "name": "XXXXX",
                  "typeName": "PROJECT"
                }
              ]
            },
        
      • /rest/auditing/1.0/events
            {
              "timestamp": "2025-05-01T01:36:46.173Z",
              "author": {
                "name": "admin",
                "type": "ApplicationUser",
                "id": "10000",
                "uri": "http://xxx.xxx.xxx.xxx:8080/jira/secure/ViewProfile.jspa?name=admin",
                "avatarUri": ""
              },
              "type": {
                "categoryI18nKey": "jira.auditing.category.filters",
                "category": "filters",
                "actionI18nKey": "jira.auditing.filter.created",
                "action": "Filter created"
              },
              "affectedObjects": [
                {
                  "name": "XXXXX",
                  "type": "FILTER",
                  "uri": "http://xxx.xxx.xxx.xxx:8080/jira/issues/?filter=10100",
                  "id": "10100"
                },
                {
                  "name": "admin",
                  "type": "USER",
                  "uri": "http://xxx.xxx.xxx.xxx:8080/jira/secure/ViewProfile.jspa?name=admin",
                  "id": "admin"
                },
                {
                  "name": "XXXXX",
                  "type": "PROJECT",
                  "uri": "http://xxx.xxx.xxx.xxx:8080/jira/secure/ViewProject.jspa?pid=10000",
                  "id": "10000"
                }
              ],
              "changedValues": [
        ...
        

            Assignee:
            Unassigned
            Reporter:
            Yukinobu Moriya
            Votes:
            8 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: