Get audit records

v1.0.0

Returns a list of audit records. The list can be filtered to include items:

where each item in filter has at least one match in any of these fields:
- summary
- category
- eventSource
- objectItem.name If the object is a user, account ID is available to filter.
- objectItem.parentName
- objectItem.typeName
- changedValues.changedFrom
- changedValues.changedTo
- remoteAddress
For example, if filter contains man ed, an audit record containing summary": "User added to group" and "category": "group management" is returned.
created on or after a date and time.
created or or before a date and time.

required: Administer Jira .

Input

{
  "type": "object",
  "properties": {
    "filter": {
      "type": "string"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Container for a list of audit records.",
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int32",
      "description": "The requested or default limit on the number of audit items to be returned."
    },
    "offset": {
      "type": "integer",
      "format": "int32",
      "description": "The number of audit items skipped before the first item in this list."
    },
    "records": {
      "type": "array",
      "description": "The list of audit items.",
      "items": {
        "type": "object",
        "description": "An audit record.",
        "properties": {
          "associatedItems": {
            "type": "array",
            "description": "The list of items associated with the changed record.",
            "items": {
              "type": "object",
              "description": "Details of an item associated with the changed record.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The ID of the associated record."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the associated record."
                },
                "parentId": {
                  "type": "string",
                  "description": "The ID of the associated parent record."
                },
                "parentName": {
                  "type": "string",
                  "description": "The name of the associated parent record."
                },
                "typeName": {
                  "type": "string",
                  "description": "The type of the associated record."
                }
              },
              "additionalProperties": false
            }
          },
          "authorKey": {
            "type": "string",
            "description": "Deprecated, use `authorAccountId` instead. The key of the user who created the audit record."
          },
          "category": {
            "type": "string",
            "description": "The category of the audit record. For a list of these categories, see the help article [Auditing in Jira applications](https://confluence.atlassian.com/x/noXKM)."
          },
          "changedValues": {
            "type": "array",
            "description": "The list of values changed in the record event.",
            "items": {
              "type": "object",
              "description": "Details of names changed in the record event.",
              "properties": {
                "changedFrom": {
                  "type": "string",
                  "description": "The value of the field before the change."
                },
                "changedTo": {
                  "type": "string",
                  "description": "The value of the field after the change."
                },
                "fieldName": {
                  "type": "string",
                  "description": "The name of the field changed."
                }
              },
              "additionalProperties": false
            }
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time on which the audit record was created."
          },
          "description": {
            "type": "string",
            "description": "The description of the audit record."
          },
          "eventSource": {
            "type": "string",
            "description": "The event the audit record originated from."
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "The ID of the audit record."
          },
          "objectItem": {
            "type": "object",
            "description": "Details of an item associated with the changed record.",
            "properties": {
              "id": {
                "type": "string",
                "description": "The ID of the associated record."
              },
              "name": {
                "type": "string",
                "description": "The name of the associated record."
              },
              "parentId": {
                "type": "string",
                "description": "The ID of the associated parent record."
              },
              "parentName": {
                "type": "string",
                "description": "The name of the associated parent record."
              },
              "typeName": {
                "type": "string",
                "description": "The type of the associated record."
              }
            },
            "additionalProperties": false
          },
          "remoteAddress": {
            "type": "string",
            "description": "The URL of the computer where the creation of the audit record was initiated."
          },
          "summary": {
            "type": "string",
            "description": "The summary of the audit record."
          }
        },
        "additionalProperties": false
      }
    },
    "total": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of audit items returned."
    }
  },
  "additionalProperties": false
}