DMS Endpoints

POST
as of 1.0

Stores files and their metadata as DMS objects of a specified type.
Requires a multipart body with a metadata parameter (e.g., metadata.json), as well as a binary content parameter (any file). A successful POST returns the metadata of the stored object(s).
/api/dms/objects

Search for documents by search query

Returns a hit list according to the CMIS-based search query provided within the request body. Returns a JSON array of the DMS objects found and visible by read permission. Two parameters allow for paging.
/api/dms/objects/search

Retrieve document metadata by ID

Retrieves the metadata of a DMS object identified by objectId.
/api/dms/objects/{objectId}

Retrieve document content by ID

binary data

Gets the content file related to a DMS object identified by objectId.
/api/dms/objects/{objectId}/contents/file

Retrieve text rendition of content by ID

plain text

Gets the content file's full text rendition related to a DMS object identified by objectId.
/api/dms/objects/{objectId}/contents/renditions/text

POST
as of 2021 Summer

Retrieve PDF rendition of content by ID

PDF

Gets the content file's PDF rendition related to a DMS object identified by objectId.
/api/dms/objects/{objectId}/contents/renditions​/pdf

Update document metadata by ID

Updates all metadata of a DMS object, identified by objectId, with the metadata send within the request.
Changes the whole set of user controlled properties, i.e., properties missing in the new metadata sent will be removed. Implicitly creates a new version.
/api/dms/objects/{objectId}

JSON

Patch-updates metadata of a DMS object identified by objectId with the metadata send within the request.
Changes only properties that occur in the request body. Properties absent from the request body are left unchanged. A property value can be removed by sending null as its new value.
/api/dms/objects/{objectId}

Update document content by ID

Replaces the content file of an DMS object identified by objectId with the binary file provided in the request. Implicitly creates a new version.
/api/dms/objects/{objectId}/contents/file

Delete document by ID

Deletes a DMS object identified by objectId.
/api/dms/objects/{objectId}

Retrieves the metadata of all versions of a DMS object identified by objectId.
/api/dms/objects/{objectId}/versions

Retrieves the metadata of a given version of a DMS object identified by objectId and versionNr.
/api/dms/objects/{objectId}/versions/{versionNr}

Retrieve document content by ID (specified version)

Gets the content related to a version of a DMS object identified by objectId and versionNr.
/api/dms/objects/{objectId}/versions/{versionNr}/contents/file

Deletes a version of a DMS object identified by objectId and versionNr.
/api/dms/objects/{objectId}/versions/{versionNr}

Retrieves the history entries of a DMS object identified by objectId.
History entries document modifications of or actions performed on a DMS object.
/api/dms/objects/{objectId}/history

Validate content by ID

Validates the content of a DMS object identified by objectId.
A digest (SHA256) is calculated and compared against the one already generated and stored in the metadata upon import or update.
/api/dms/objects/{objectId}/actions/validate/digest

Validate content by ID (specified version)

Validates the content of a version of a DMS object identified by objectId and versionNr.
/api/dms/objects/{objectId}/versions/{versionNr}/actions/validate/digest

Moves the content of a DMS object, identified by objectId, to the target repository, identified by repositoryId. This allows for storage optimization.
/api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId}

Moves the content of a specific version of a DMS object, identified by objectId and versionNr, to the target repository, identified by repositoryId.
/api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId}

Retrieves all tags of a DMS object identified by objectId. The tags are displayed as a table with the values name, state, creationDate and traceId.
/api/dms/objects/{objectId}/tags

Adds a tag to a DMS object identified by objectId.
/api/dms/objects/{objectId}/tags/{name}/state/{state}

Updates a tag of a DMS object identified by objectId.
/api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true

Add/update document tag by search query

Returns a list of objects according to the CMIS-based search query provided with the query= parameter. For the first record returned, the tag and state of the request given will be added/updated. All other objects matched by the query remain unchanged.
/api/dms/objects/tags/{name}/state/{state}?query=<SQL>

Deletes a tag of a DMS object identified by objectId.
/api/dms/objects/{objectId}/tags/{name}

Gets the applied tenant schema in its native structure.
This schema contains all available DMS object types—system types, global types and tenant-specific types. The schema tells you which object types bearing which properties are defined and available.
/api/dms/schema/native

Gets the applied tenant schema. This ist similar to the GET /api/dms/schema/native. The result schema contains the same DMS object types, but it is structured in a different way.
/api/dms/schema

Retrieves the definition of the object type identified by localname. The definition contains attributes of the object type and definitions of all its fields.
/api/dms/schema/objecttype/{localname}

Retrieves all applications available in the tenant the currently logged-in user belongs to.
/api/dms/apps