Audit Trail - an "Object's History"
Table of Contents
Introduction
The audit trail is the history protocol of an object, serving to document its entire lifecycle. There are many different actions that trigger the creation of a new entry in the respective object's audit trail. In this article, an overview of the different history codes is provided that can occur in the audit trail.
History Codes
The GET "/dms/objects/{id}/history” REST endpoint returns a list of changes made to the object with the ID {objectId}. The meanings of the individual history codes are listed in the table below.
| Action code | Detail | Subaction code | Endpoints triggering the entry | Description | Explanation |
|---|---|---|---|---|---|
| Import: | |||||
| 100 | OBJECT_CREATED | - | POST /api/dms/objects | Object created | The specified object was created by functions of the client or by an import. |
| 101 | OBJECT_CREATED_WITH_CONTENT | - | POST /api/dms/objects | Document created | The object was created using functions of the client or via an import operation. |
| 110 | OBJECT_TAG_CREATED: [<name>, <state>] | <state> | POST /api/dms/objects/{objectId}/tags/{name}/state/{state} | Object tag created | A tag for the object was created. |
| Deletion: | |||||
| 200 | OBJECT_DELETED | - | DELETE /api/dms/objects/{objectId} DELETE /api/dms/objects/{objectId}/versions/{versionNr} (up to 2023 Summer) | Object irrevocably deleted | The object was deleted and cannot be restored. |
| 201 (as of 2023 Summer) | OBJECT_CONTENT_DELETED | - | DELETE /api/dms/objects/{objectId}/contents/file | Binary content of the object is removed. | A new object version was created that has no contentStreams section anymore. |
| 202 | OBJECT_FLAGGED_FOR_DELETE | - | Object marked for deletion | The object was moved to the recycle bin. | |
| 210 | OBJECT_TAG_DELETED: [<name>, <state>] | <state> | DELETE /api/dms/objects/{objectId}/tags/{name} | Object tag deleted | A tag for the object was deleted. |
| 220 | VERSION_DELETED: [<versionNr>] | - | DELETE /api/dms/objects/{objectId}/versions/{versionNr} (as of 2023 Autumn) | Object version deleted. | The object version was deleted and cannot be restored. |
| Update: | |||||
| 300 | OBJECT_METADATA_CHANGED | - | Metadata modified | The metadata of the object or its status was edited using functions of the client or via an update carried out during the import operation. | |
| 301 | OBJECT_DOCUMENT_CHANGED | - | DELETE /api/dms/objects/{objectId}/tags/{name} | Content changed | The document was edited using functions of the client or via an update carried out during the import operation. |
| 303 | OBJECT_UPDATE_CONTENT_MOVED | - | POST /api/dms/objects/{objectId}/actions/move/ | Object updated and content moved | The object was updated and the document was moved. |
306 (as of 2022 Winter) | RENDITION_CHANGED | 1 | POST /api/dms/objects/{objectId}/contents/renditions/text | Text rendition added/updated. | A rendition of the binary content file of a DMS object was added or updated via endpoint. The subaction specifies the type of rendition. |
| 310 | OBJECT_TAG_UPDATED: [<name>, <state>] | - | POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true | Object tag modified | One of the object's tags was changed. |
| 325 | OBJECT_RESTORED_FROM_VERSION: [< | - | POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore | Object restored from an old version | The data of the old object version were used to update the current object version. |
| 340 | DOCUMENT_MOVED | - | system:parentId property modified | The value for the system:parentId property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created. | |
| Retrieve: | |||||
400 | DOCUMENT_ACCESSED | - | GET /api/dms/objects/{objectId}/contents/file GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file | Output content | The document content was read by the user, printed, or otherwise output. No changes were made. As of 2022 Summer: If a user retrieves the binary content file of the same object version multiple times within 10 minutes, only the first retrieval is documented in the audit trail. The following processes internally retrieve the object's binary content file and thus trigger the creation of an audit entry as well:
|
| 401 | METADATA_ACCESSED | - | GET /api/dms/objects/{objectId} | Metadata retrieved | The object's metadata were retrieved for viewing. The following processes internally retrieve the object's metadata and thus trigger the creation of an audit entry as well:
|
| 402 | RENDITION_ACCESSED | 1 | GET /api/dms/objects/{objectId}/contents/renditions/text | Text rendition accessed | Rendition of the binary content accessed. If a user retrieves the same type of rendition for the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail. The subaction specifies the type of rendition |
| 2 | GET /api/dms/objects/{objectId}/contents/renditions/pdf | PDF rendition accessed | |||