Versions Compared

Key

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

...

Action codeDetailSubaction codeEndpoints triggering the entryDescriptionExplanation
Import:
100OBJECT_CREATED-POST /api/dms/objectsObject createdThe specified object was created by functions of the client or by an import.
101OBJECT_CREATED_WITH_CONTENT-POST /api/dms/objectsDocument createdThe object was created using functions of the client or via an import operation.
110OBJECT_TAG_CREATED: [<name>, <state>]<state>POST /api/dms/objects/{objectId}/tags/{name}/state/{state}Object tag createdA tag for the object was created.
Deletion:
200OBJECT_DELETED-

DELETE /api/dms/objects/{objectId}

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

Object irrevocably deletedThe object was deleted and cannot be restored.
201 (as of 2023 Summer)OBJECT_CONTENT_DELETED-DELETE /api/dms/objects/{objectId}/contents/fileBinary content of the object is removed.A new object version was created that has no contentStreams section anymore.
202OBJECT_FLAGGED_FOR_DELETE-

DELETE /api/dms/objects/{objectId}

Object marked for deletionThe object was moved to the recycle bin.
210OBJECT_TAG_DELETED: [<name>, <state>]<state>DELETE /api/dms/objects/{objectId}/tags/{name}Object tag deletedA tag for the object was deleted.
Update:
300OBJECT_METADATA_CHANGED-

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

Metadata modifiedThe metadata of the object or its status was edited using functions of the client or via an update carried out during the import operation.
301OBJECT_DOCUMENT_CHANGED-DELETE /api/dms/objects/{objectId}/tags/{name}Content changedThe document was edited using functions of the client or via an update carried out during the import operation.
303OBJECT_UPDATE_CONTENT_MOVED-

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

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

Object updated and content movedThe object was updated and the document was moved.

306 

(as of 2022 Winter)

RENDITION_CHANGED

1

POST /api/dms/objects/{objectId}/contents/renditions/textText 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.
310OBJECT_TAG_UPDATED: [<name>, <state>]-

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

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

Object tag modifiedOne of the object's tags was changed.
325

OBJECT_RESTORED_FROM_VERSION: [<versionNr>]

-POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restoreObject restored from an old versionThe data of the old object version were used to update the current object version.
340DOCUMENT_MOVED-

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

system:parentId property modifiedThe value for the system:parentId property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created.
Retrieve:

400

DOCUMENT_ACCESSED-

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

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

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

Output content

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
401METADATA_ACCESSED-

POST /api/dms/objects/search

GET /api/dms/objects/{objectId}

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

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

Metadata retrieved

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 
402RENDITION_ACCESSED1GET /api/dms/objects/{objectId}/contents/renditions​/textText rendition accessed

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

2GET /api/dms/objects/{objectId}/contents/renditions​/pdfPDF rendition accessed

...