These endpoints may be used by any kind of client, operating under an authorized user. For a quick try out without the need to install yuuvis® Momentum, consider our yuuvis® Ultimate SaaS (Software as a Service) offer. Keep in mind that you need to set up a (free) account.

HTTP Method as of product version	Purpose	Response Format	Description
	Basic CRUD Operations
POST as of 1.0	Store one or more documents as new DMS objects	JSON	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
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. /api/dms/objects/search
GET as of 1.0	Retrieve document metadata by ID	JSON	Retrieves the metadata of a DMS object identified by objectId. /api/dms/objects/{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. /api/dms/objects/{objectId}/contents/file
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. /api/dms/objects/{objectId}/contents/renditions/text
POST as of 2021 Summer	Update text rendition by ID	HTTP status code	Updates the full-text rendition related to a DMS object identified by `objectId`. /api/dms/objects/{objectId}/contents/renditions/text
GET as of 2020 Winter	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
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. 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}
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. 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}
PATCH as of 2021 Autumn	Patch-update document metadata by ID	JSON	Updates metadata in multiple objects specified by ID in the JSON request body. /api/dms/objects
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. /api/dms/objects/{objectId}/contents/file
DELETE as of 1.0	Delete document by ID	http status code	Deletes a DMS object identified by objectId. /api/dms/objects/{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. /api/dms/objects/{objectId}/versions
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. /api/dms/objects/{objectId}/versions/{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. /api/dms/objects/{objectId}/versions/{versionNr}/contents/file
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. /api/dms/objects/{objectId}/versions/{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. History entries document modifications of or actions performed on a DMS object. /api/dms/objects/{objectId}/history
	Content Validation
GET as of 1.0	Validate content by ID	JSON	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
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. /api/dms/objects/{objectId}/versions/{versionNr}/actions/validate/digest
	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. /api/dms/objects/{objectId}/actions/move/contents/repositories/{repositoryId}
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. /api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{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. /api/dms/objects/{objectId}/tags
POST as of 2020 Summer	Add document tag by ID	JSON	Adds a tag to a DMS object identified by objectId. /api/dms/objects/{objectId}/tags/{name}/state/{state}
POST as of 2020 Summer	Update document tag by ID	JSON	Updates a tag of a DMS object identified by objectId. /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true
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. /api/dms/objects/tags/{name}/state/{state}?query=<SQL>
DELETE as of 2020 Summer	Delete document tag by ID	http status code	Deletes a tag of a DMS object identified by objectId. /api/dms/objects/{objectId}/tags/{name}
	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. 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
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. /api/dms/schema
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. /api/dms/schema/objecttype/{localname}
	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. /api/dms/apps

Browser not supported