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.

Core APIDescriptionConstantExplanationEndpoints triggering the entry
Import:
100Object createdOBJECT_CREATEDThe specified object was created by functions of the client or by an import.POST /api/dms/objects
101Document createdOBJECT_CREATED_WITH_CONTENTThe object was created using functions of the client or via an import operation.POST /api/dms/objects

110Object tag createdOBJECT_TAG_CREATEDA tag for the object was created.POST /api/dms/objects/{objectId}/tags/{name}/state/{state}
Deletion:
200Object irrevocably deletedOBJECT_DELETEDThe object was deleted and cannot be restored.

DELETE /api/dms/objects/{objectId}

DELETE /api/dms/objects/{objectId}/versions/{versionNr}

202Object marked for deletionOBJECT_FLAGGED_FOR_DELETEThe object was moved to the recycle bin.

DELETE /api/dms/objects/{objectId}


210Object tag deletedOBJECT_TAG_DELETEDA tag for the object was deleted.DELETE /api/dms/objects/{objectId}/tags/{name}
Update:
300Metadata modifiedOBJECT_METADATA_CHANGEDThe metadata of the object or its status was edited using functions of the client or via an update carried out during the import operation.

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

301Content changedOBJECT_DOCUMENT_CHANGEDThe document was edited using functions of the client or via an update carried out during the import operation.POST /api/dms/objects/{objectId}/contents/file
303Object updated and content movedOBJECT_UPDATE_CONTENT_MOVEDThe object was updated and the document was moved.

POST /api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId}

POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId}


310Object tag modifiedOBJECT_TAG_UPDATEDOne of the object's tags was changed.

POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

Retrieve:

400

Output contentDOCUMENT_ACCESSEDThe document content was read by the user, printed, or otherwise output. No changes were made.GET /api/dms/objects/{objectId}/contents/file
401Metadata retrievedMETADATA_ACCESSEDThe object's metadata were retrieved for viewing.

POST /api/dms/objects/search

GET /api/dms/objects/{objectId}

GET /api/dms/objects/{objectId}/versions

402Text preview downloadedRENDITION_TEXT_ACCESSEDThe text rendition of the object's document file was retrieved.GET /api/dms/objects/{objectId}/contents/renditions​/text

Read on

Retrieving Document History Entries 

This tutorial shows how we can use a Java application to make a request to the Core API of the yuuvis® API system to retrieve the history entries of a DMS document. In addition, it briefly describes which history entries are generated for a document. Keep reading

Endpoint for retrieving a document's history

This endpoint retrieves the history entries of a DMS object identified by objectIdHistory entries document modifications of or actions performed on a DMS object. Keep reading