Atlassian: Audit records schemas
4 Atlassian schemas with complete fields and constraints.
← Audit records operations · All schemas
Get audit records — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container for a list of audit records. |
limit | JSON | Optional | |
limit (anyOf 1) | JSON | Alternative | |
limit (anyOf 1) (anyOf 1) | integer | Alternative | The requested or default limit on the number of audit items to be returned. Format: int32 Read only: true |
limit (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
limit (anyOf 2) | null | Alternative | |
offset | JSON | Optional | |
offset (anyOf 1) | JSON | Alternative | |
offset (anyOf 1) (anyOf 1) | integer | Alternative | The number of audit items skipped before the first item in this list. Format: int32 Read only: true |
offset (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset (anyOf 2) | null | Alternative | |
records | JSON | Optional | |
records (anyOf 1) | array | Alternative | The list of audit items. Read only: true |
records (anyOf 1)[] | Model | Each item | Expand Get audit records — response body — records The list of audit items item |
records (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The total number of audit items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative |
Referenced models: Get audit records — response body — records The list of audit items item
Get audit records — response body — records The list of audit items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An audit record. |
associatedItems | JSON | Optional | |
associatedItems (anyOf 1) | array | Alternative | The list of items associated with the changed record. Read only: true |
associatedItems (anyOf 1)[] | Model | Each item | Expand Get audit records — response body — records The list of audit items item object Item id, name, parent Id, parent Name, type Name |
associatedItems (anyOf 2) | null | Alternative | |
authorKey | JSON | Optional | |
authorKey (anyOf 1) | string | Alternative | Deprecated, use `authorAccountId` instead. The key of the user who created the audit record. Read only: true |
authorKey (anyOf 2) | null | Alternative | |
category | JSON | Optional | |
category (anyOf 1) | string | Alternative | 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). Read only: true |
category (anyOf 2) | null | Alternative | |
changedValues | JSON | Optional | |
changedValues (anyOf 1) | array | Alternative | The list of values changed in the record event. Read only: true |
changedValues (anyOf 1)[] | Model | Each item | Expand Get audit records — response body — records The list of audit items item changed Values The list of values changed in the record event item |
changedValues (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | JSON | Alternative | |
created (anyOf 1) (anyOf 1) | string | Alternative | The date and time on which the audit record was created. Read only: true |
created (anyOf 1) (anyOf 2) | integer | Alternative | |
created (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the audit record. Read only: true |
description (anyOf 2) | null | Alternative | |
eventSource | JSON | Optional | |
eventSource (anyOf 1) | string | Alternative | The event the audit record originated from. Read only: true |
eventSource (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the audit record. Format: int64 Read only: true |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
objectItem | JSON | Optional | |
objectItem (anyOf 1) | Model | Alternative | Expand Get audit records — response body — records The list of audit items item object Item id, name, parent Id, parent Name, type Name |
objectItem (anyOf 2) | null | Alternative | |
remoteAddress | JSON | Optional | |
remoteAddress (anyOf 1) | string | Alternative | The URL of the computer where the creation of the audit record was initiated. Read only: true |
remoteAddress (anyOf 2) | null | Alternative | |
summary | JSON | Optional | |
summary (anyOf 1) | string | Alternative | The summary of the audit record. Read only: true |
summary (anyOf 2) | null | Alternative |
Referenced models: Get audit records — response body — records The list of audit items item object Item id, name, parent Id, parent Name, type Name, Get audit records — response body — records The list of audit items item changed Values The list of values changed in the record event item
Get audit records — response body — records The list of audit items item changed Values The list of values changed in the record event item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of names changed in the record event. |
changedFrom | JSON | Optional | |
changedFrom (anyOf 1) | string | Alternative | The value of the field before the change. Read only: true |
changedFrom (anyOf 2) | null | Alternative | |
changedTo | JSON | Optional | |
changedTo (anyOf 1) | string | Alternative | The value of the field after the change. Read only: true |
changedTo (anyOf 2) | null | Alternative | |
fieldName | JSON | Optional | |
fieldName (anyOf 1) | string | Alternative | The name of the field changed. Read only: true |
fieldName (anyOf 2) | null | Alternative |
Get audit records — response body — records The list of audit items item object Item id, name, parent Id, parent Name, type Name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an item associated with the changed record. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the associated record. Read only: true |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the associated record. Read only: true |
name (anyOf 2) | null | Alternative | |
parentId | JSON | Optional | |
parentId (anyOf 1) | string | Alternative | The ID of the associated parent record. Read only: true |
parentId (anyOf 2) | null | Alternative | |
parentName | JSON | Optional | |
parentName (anyOf 1) | string | Alternative | The name of the associated parent record. Read only: true |
parentName (anyOf 2) | null | Alternative | |
typeName | JSON | Optional | |
typeName (anyOf 1) | string | Alternative | The type of the associated record. Read only: true |
typeName (anyOf 2) | null | Alternative |