Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version	2021 Summer
Report Note
Assignee	Antje

Resources & Remarks

INGA - v. 2.2 - added the new tagging endpoints
INGA - v. 2020 Autumn - added "GET /api/dms/objects/{objectId}/contents/renditions/text" endpoint
Antje - Links inserted for tagging endpoints

Modification History

Add a new line to this table and fill it whenever you edit the page.

Name	Date	Product Version	Action
Antje	08 FEB 2021	2020 Winter	New page properties macro.
Antje	09 MAR 2021	2021 Summer	New endpoint POST .../{objectId}/contents/renditions/text.
Antje	13 JUL 2021	2021 Autumn	new endpoint PATCH /api/dms/objects
Antje	03 JAN 2022	2022 Spring	restoring old object version added
Antje	01 FEB 2022	2022 Spring	product version endpoint added
Agnieszka	06 SEP 2022	2022 Autumn	rLANG
Antje	27 FEB 2023	2023 Spring	slide rendition endpoints added

Manage DMS objects in yuuvis® Momentum or retrieve structural information for the tenant that are relevant for all its users.

In the default configuration, any logged-in user has access to the endpoints. However, the creation, retrieval, update and deletion of DMS objects require corresponding roles.

As of version 2022 Autumn, some processes that lead to an update of the index of the search engine can be called with the query parameter waitForSearchConsistency.
>> find details below

HTTP Method as of product version	Purpose	Response Format	Description
	Basic CRUD Operations
POST as of 1.0	Store one or more 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 objects 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 object 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	/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
GET as of 2023 Spring	Retrieve slide rendition of content by ID	PNG	/api/dms/objects/{objectId}/contents/renditions/slide
POST as of 1.0	Update object 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 object 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 object metadata by ID	JSON	/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 object by ID	http status code	Deletes a DMS object identified by objectId. /api/dms/objects/{objectId}
DELETE as of 2021 Winter	Delete multiple objects by ID	http status code	/api/dms/objects
	Operations on old Versions
GET as of 1.0	Retrieve object 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 object 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
GET as of 2022 Winter	Retrieve PDF rendition of content by ID (specified version)	PDF	/api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf
GET as of 2023 Spring	Retrieve slide rendition of content by ID (specified version)	PNG	/api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/slide
POST as of 2022 Spring	Restore specified version.	JSON	/api/dms/objects/{objectId}/versions/{versionNr}/actions/restore
DELETE as of 1.0	Delete object 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 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	/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	/api/dms/objects/{objectId}/versions/{versionNr}/actions/move/contents/repositories/{repositoryId}
	Document Lifecycle Management - Tagging
GET as of 2020 Summer	Retrieve object 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 object 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 object 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 object 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 object 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}
	Version and App Information
GET as of 2022 Spring	Retrieves installed product version	JSON	/api/dms/info
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

Parameter 'waitForSearchConsistency' for Endpoints with Effect on the Search Index

As of version 2022 Autumn, some processes that lead to an update of the index of the search engine can be called with the query parameter waitForSearchConsistency.

Value of 'waitForSearchConcistency'	Processing	Description	Advantage	Disadvantage
`true`	synchronous	The success response of the corresponding endpoint is returned after the successful update of the search index.	The changes are available even for search requests that are sent immediately after the synchronous processing.	The waiting time before the response is rather long.
`false`	asynchronous	The success response of the corresponding endpoint does not wait for the update of the search index.	The waiting time for the response is far shorter.	Search requests sent immediately after the change request may be processed before the search index is updated.

The update and import endpoints listed below accept an optional query parameter waitForSearchConsistency.

Endpoints	Default for `waitForSearchConsistency`
Import: POST /api/dms/objects	`false`
Metadata update: POST /api/dms/objects/{objectId} PATCH /api/dms/objects/{objectId} PATCH /api/dms/objects	`true`
Content update: POST /api/dms/objects/{objectId}/contents/file	`true`
Restore: POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore	`true`
Deletion: DELETE /api/dms/objects/{objectId} (as of 2023 Summer) DELETE /api/dms/objects (as of 2023 Summer)	`true`
Tagging: POST /api/dms/objects/{objectId}/tags/{name}/state/{state} POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL> DELETE /api/dms/objects/{objectId}/tags/{name}	`true`
Text rendition: POST /api/dms/objects/{objectId}/contents/renditions/text	`true`

Basic CRUD Operations

Operations on old Versions

History Access

Content Validation

Repository Operations

Document Lifecycle Management - Tagging

Schema Retrieval - Object Type Information

Version and App Information

Parameter 'waitForSearchConsistency' for Endpoints with Effect on the Search Index