Versions Compared

Key

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

...

Core APIDescriptionDetailExplanationEndpoints triggering the entry
Import:
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_CREATED: [<name>, <state>]A tag for the object was created./api/dms/objects/{objectId}/tags/{name}/state/{state}
Deletion:
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_DELETED: [<name>, <state>]A tag for the object was deleted./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.

/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_UPDATED: [<name>, <state>]One 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>

325Object 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./api/dms/objects/{objectId}/versions/{versionNr}/actions/restore
340system: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.

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

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

401Metadata retrievedMETADATA_ACCESSEDThe object's metadata were retrieved for viewing.

/api/dms/objects/search

/api/dms/objects/{objectId}

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

402Text preview downloadedRENDITION_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
403PDF preview downloadedRENDITION_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

...