...
Page Properties |
---|
|
Product Version |
|
---|
Report Note | published, only the object history - rest of the concept is outstanding |
---|
Assignee |
|
---|
Resources & Remarks Remarks - Antje: page created
- Antje: table with history codes created
- Needs to be moved to the Document Lifecycle page as subpage - if the DLM page is ready to get published
- Heading 1 "Summary" deleted for now - needs to be added later on if the concept is written in detail
- Antje: Cleanup Section startet in the hidden part
- Antje: Cleanup Section moved to Commander tooling page
For a cleanup the audit trail, the commander service can be used as a tool to remove audit trail entries. >>> audit-cleanup Command
Modification History Name | Date | Product Version | Action |
---|
Antje | 08 FEB 2021 | 2.4 | New page properties macro. | Antje | 03 JAN 2022 | 2022 Spring | restoring added (325) | Antje | 23 NOV 2022 | 2022 Winter | post text rendition (306) added | Antje | 28 NOV 2022 | 2022 Winter | restructure table |
|
Excerpt |
---|
|
The audit trail is the history protocol of an object, serving to document its total lifecycle. There are many different actions that trigger the creation of a new entry in the respective object's audit trail. |
...
Anchor |
---|
| auditTrail_HistoryCodes |
---|
| auditTrail_HistoryCodes |
---|
|
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 | DescriptionExplanationSubaction code | Endpoints triggering the entry | Description | Explanation |
---|
Import: |
100 |
Object created101OBJECT_CREATED_WITH_CONTENT | The object was created using functions of the client or via an import operation. |
/api/dms/objects | Object tag created | OBJECT_TAG_CREATED: [<name >, <state >] |
A tag for the object was created. | Object irrevocably deletedThe object was deleted and cannot be restored. | Object marked for deletion | OBJECT_FLAGGED_FOR_DELETE |
The object was moved to the recycle bin. | Object tag deletedtagsname}versionNr} (as of 2023 Autumn) | Object version deleted. | The object version was deleted and cannot be restored. |
Update: |
300 |
Metadata modified | api/dmsobjects/objectId301 | 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 | Object updated and content moved | OBJECT_UPDATE_CONTENT_MOVED |
The object was updated and the document was moved. | 310 | Object tag modified | 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 >] |
One of the object's tags was changed. | Object restored from an old version | /versionsversionNr}/actions/restore340DOCUMENT_MOVED | The value for the system:parentId property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created. |
POST PATCH Retrieve: |
400 | 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. |
/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. | 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. | renditions403 | PDF preview downloaded | RENDITION_PDF_ACCESSED | As of 2022 Summer: The PDF rendition of the object's binary content file was retrievedText rendition accessed | Rendition of the binary content accessed. If a user retrieves the |
PDF of Info |
---|
|
Read on
Section |
---|
Column |
---|
| Insert excerpt |
---|
| Retrieving Document History Entries |
---|
| Retrieving Document History Entries |
---|
nopanel | true |
---|
| Keep reading
|
Column |
---|
| This endpoint retrieves the history entries of a DMS object identified by objectId. History entries document modifications of or actions performed on a DMS object. Keep reading
|
|
|
...