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.
| Core API | Description | Detail | Explanation | Endpoints triggering the entry |
|---|---|---|---|---|
| Import: | ||||
| 100 | Object created | OBJECT_CREATED | The specified object was created by functions of the client or by an import. | /api/dms/objects |
| 101 | Document created | OBJECT_CREATED_WITH_CONTENT | The object was created using functions of the client or via an import operation. | /api/dms/objects |
| 110 | Object tag created | OBJECT_TAG_CREATED: [<name>, <state>] | A tag for the object was created. | /api/dms/objects/{objectId}/tags/{name}/state/{state} |
| Deletion: | ||||
| 200 | Object irrevocably deleted | OBJECT_DELETED | The object was deleted and cannot be restored. | |
| 202 | Object marked for deletion | OBJECT_FLAGGED_FOR_DELETE | The object was moved to the recycle bin. | |
| 210 | Object tag deleted | OBJECT_TAG_DELETED: [<name>, <state>] | A tag for the object was deleted. | /api/dms/objects/{objectId}/tags/{name} |
| Update: | ||||
| 300 | Metadata modified | OBJECT_METADATA_CHANGED | 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 | Content changed | OBJECT_DOCUMENT_CHANGED | The document was edited using functions of the client or via an update carried out during the import operation. | /api/dms/objects/{objectId}/contents/file |
| 303 | Object updated and content moved | OBJECT_UPDATE_CONTENT_MOVED | The object was updated and the document was moved. | /api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId} /api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId} |
| 310 | Object tag modified | OBJECT_TAG_UPDATED: [<name>, <state>] | One of the object's tags was changed. | /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true |
| 325 | Object restored from an old version | OBJECT_RESTORED_FROM_VERSION: [< | The data of the old object version were used to update the current object version. | /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore |
| 340 | system:parentId property modified | DOCUMENT_MOVED | The value for the system:parentId property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created. | |
| Retrieve: | ||||
400 | Output content | DOCUMENT_ACCESSED | 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:
| /api/dms/objects/{objectId}/contents/file /api/dms/objects/{objectId}/versions/{versionNr}/contents/file |
| 401 | Metadata retrieved | METADATA_ACCESSED | 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 | Text preview downloaded | RENDITION_TEXT_ACCESSED | The text rendition of the object's binary content file was retrieved. As of 2022 Summer: If a user retrieves the text rendition of the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail. | /api/dms/objects/{objectId}/contents/renditions/text |
| 403 | PDF preview downloaded | RENDITION_PDF_ACCESSED | As of 2022 Summer: The PDF rendition of the object's binary content file was retrieved. If a user retrieves the PDF rendition of the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail. | /api/dms/objects/{objectId}/contents/renditions/pdf |