Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 65 Next »

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 codeSubaction codeDescriptionDetailExplanationEndpoints triggering the entry
Import:
100-Object createdOBJECT_CREATEDThe specified object was created by functions of the client or by an import.POST /api/dms/objects
101-Document createdOBJECT_CREATED_WITH_CONTENTThe object was created using functions of the client or via an import operation.POST /api/dms/objects
110<state>Object tag createdOBJECT_TAG_CREATED: [<name>, <state>]A tag for the object was created.POST /api/dms/objects/{objectId}/tags/{name}/state/{state}
Deletion:
200-Object irrevocably deletedOBJECT_DELETEDThe object was deleted and cannot be restored.

DELETE /api/dms/objects/{objectId}

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

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

DELETE /api/dms/objects/{objectId}

210<state>Object tag deletedOBJECT_TAG_DELETED: [<name>, <state>]A tag for the object was deleted.DELETE /api/dms/objects/{objectId}/tags/{name}
Update:
300-Metadata 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}

301-Content changedOBJECT_DOCUMENT_CHANGEDThe document was edited using functions of the client or via an update carried out during the import operation.DELETE /api/dms/objects/{objectId}/tags/{name}
303-Object 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}

306 

(as of 2022 Winter)

Rendition  added/updatedRENDITION_CHANGEDA rendition of the binary content file of a DMS object was added or updated via endpoint. The subaction specifies the type of rendition.

1Text rendition added/updatedPOST /api/dms/objects/{objectId}/contents/renditions/text
310
Object tag modifiedOBJECT_TAG_UPDATED: [<name>, <state>]One 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>

325
Object restored from an old version

OBJECT_RESTORED_FROM_VERSION: [<versionNr>]

The data of the old object version were used to update the current object version.POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore
340
system:parentId property modifiedDOCUMENT_MOVEDThe value for the system:parentId property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created.

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

Retrieve:

400


Output contentDOCUMENT_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:

  • the first retrieval of a PDF rendition after the object creation

GET /api/dms/objects/{objectId}/contents/file

GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file

GET /api/dms/objects/{objectId}/contents/renditions​/pdf

401
Metadata retrievedMETADATA_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:

  • each retrieval of a PDF rendition 

POST /api/dms/objects/search

GET /api/dms/objects/{objectId}

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

GET /api/dms/objects/{objectId}/contents/renditions​/pdf

402Rendition of the binary content accessedRENDITION_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



1Text rendition accessedGET /api/dms/objects/{objectId}/contents/renditions​/text

2PDF rendition accessedGET /api/dms/objects/{objectId}/contents/renditions​/pdf

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

  • No labels