Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue

Status

Status
colourYellow
titlePROGRESS

Priority2.3
Note
AssigneeAntje + glossary entry "Audit trail"

Resources

Remarks

  • Antje: page created
  • Antje: table with history codes created
  • (warning)(warning) Heading 1 "Summary" deleted for now - needs to be added later on if the concept is written in detail

...

The GET "/dms/objects/{id}/history” REST endpoint returns a list of changes made to the object with the id {id}. The meanings of the individual history codes are listed in the table below.

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





110Object tag createdOBJECT_TAG_CREATEDA tag for the object was created./api/dms/objects/{objectId}/tags/{name}/state/{state}





200Object irrevocably deletedOBJECT_DELETEDThe object was deleted and cannot be restored.

/api/dms/objects/{objectId}

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

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

/api/dms/objects/{objectId}






210Object tag deletedOBJECT_TAG_DELETEDA tag for the object was deleted./api/dms/objects/{objectId}/tags/{name}





300Index data modifiedOBJECT_METADATA_CHANGEDThe index data of the object or its status was edited using functions of the client or via an update carried out during the import operation.

/api/dms/objects/{objectId}

/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./api/dms/objects/{objectId}/contents/file
303Object updated and content movedOBJECT_UPDATE_CONTENT_MOVEDThe 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}






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

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

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






400

Output contentDOCUMENT_ACCESSEDThe document content was read by the user, printed, or otherwise output. No changes were made./api/dms/objects/{objectId}/contents/file
401Index data retrievedMETADATA_ACCESSEDDie Indexdaten des Objektes wurden zur Ansicht abgerufen.

/api/dms/objects/search

/api/dms/objects/{objectId}

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

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

Info
iconfalse

Read on

Section


Column
width45%

Retrieving Document History Entries 

Insert excerpt
Retrieving Document History Entries
Retrieving Document History Entries
nopaneltrue
 Keep reading


Column
width45%

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



...