...
| HTTP Method as of product version | Purpose | Response Format | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
Basic CRUD Operations | |||||||||
POST | Store one or more documents as new DMS objects | JSON | Stores files and their metadata as DMS objects of a specified type. | ||||||
| POST as of 1.0 | Search for documents by search query | JSON | 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. | ||||||
| GET as of 1.0 | Retrieve document metadata by ID | JSON | Retrieves the metadata of a DMS object identified by objectId. | ||||||
| GET as of 1.0 | Retrieve document content by ID | binary data | Gets the content file related to a DMS object identified by objectId. | ||||||
| GET as of 2020 Autumn | 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. | POST | Update text rendition by ID | HTTP status code | |||
| Insert excerpt | POST /api/dms/objects/{objectId}/contents/renditions/text | POST /api/dms/objects/{objectId}/contents/renditions/text | |||||||
| nopanel | true | ||||||||
| GET as of 2020 Winter | Retrieve PDF rendition of content by ID | Gets the content file's PDF rendition related to a DMS object identified by objectId. | |||||||
| POST as of 1.0 | Update document metadata by ID | JSON | Updates all metadata of a DMS object, identified by objectId, with the metadata send within the request. | ||||||
| PATCH as of 2019 Winter | Patch-Update document metadata by ID | JSON | Patch-updates metadata of a DMS object identified by objectId with the metadata send within the request. | ||||||
| PATCH as of 2021 Autumn | Patch-update document metadata by ID | JSON | |||||||
| POST as of 1.0 | Update document content by ID | JSON | Replaces the content file of an DMS object identified by objectId with the binary file provided in the request. Implicitly creates a new version. | ||||||
| DELETE as of 1.0 | Delete document by ID | http status code | Deletes a DMS object identified by objectId. | ||||||
Retrieve and Delete on Versions | |||||||||
| GET as of 1.0 | Retrieve document metadata by ID (all versions) | JSON | Retrieves the metadata of all versions of a DMS object identified by objectId. | ||||||
| GET as of 1.0 | Retrieve document metadata by ID (specified version) | JSON | Retrieves the metadata of a given version of a DMS object identified by objectId and versionNr. | ||||||
| GET as of 1.0 | Retrieve document content by ID (specified version) | binary data | Gets the content related to a version of a DMS object identified by objectId and versionNr. | ||||||
| DELETE as of 1.0 | Delete document by ID (specified version) | http status code | Deletes a version of a DMS object identified by objectId and versionNr. | ||||||
History Access | |||||||||
| GET as of 1.0 | Retrieve a document's list of history entries | JSON | Retrieves the history entries of a DMS object identified by objectId. | ||||||
Content Validation | |||||||||
| GET as of 1.0 | Validate content by ID | JSON | Validates the content of a DMS object identified by objectId. | ||||||
| GET as of 1.0 | Validate content by ID (specified version) | JSON | Validates the content of a version of a DMS object identified by objectId and versionNr. | ||||||
Repository Operations | |||||||||
| POST as of 2019 Winter | Move document content by ID to specified repository | JSON | Moves the content of a DMS object, identified by objectId, to the target repository, identified by repositoryId. This allows for storage optimization. | ||||||
| POST as of 2019 Winter | Move document content by ID (specified version) to specified repository | JSON | Moves the content of a specific version of a DMS object, identified by objectId and versionNr, to the target repository, identified by repositoryId. | ||||||
Document Lifecycle Management - Tagging | |||||||||
| GET as of 2020 Summer | Retrieve document tags by ID | JSON | 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. | ||||||
| POST as of 2020 Summer | Add document tag by ID | JSON | Adds a tag to a DMS object identified by objectId. | ||||||
| POST as of 2020 Summer | Update document tag by ID | JSON | Updates a tag of a DMS object identified by objectId. | ||||||
| POST as of 2020 Summer | Add/update document tag by search query | JSON | 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. | ||||||
| DELETE as of 2020 Summer | Delete document tag by ID | http status code | Deletes a tag of a DMS object identified by objectId. | ||||||
Schema Retrieval - Object Type Information | |||||||||
| GET as of 1.0 | Retrieve applied tenant schema | XML / JSON | Gets the applied tenant schema in its native structure. | ||||||
| GET as of 1.0 | Retrieve applied tenant schema with an alternative structure | JSON | 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. | ||||||
| GET as of 1.0 | Retrieve an object type's definition by its local name | JSON | Retrieves the definition of the object type identified by localname. The definition contains attributes of the object type and definitions of all its fields. | ||||||
App Information | |||||||||
| GET as of 2021 Summer | Retrieve all applications for the tenant | JSON | Retrieves all applications available in the tenant the currently logged-in user belongs to. | ||||||
...