As of Version

product version 2021 Summer | component version 2021 Summer

Request Method POST

Response Format HTTP status code

Required Permission action write
>> Roles and Role Sets

Description

Updates the full-text rendition related to a DMS object identified by objectId.

If a content file is imported having one of the text rendition compatible formats and containing readable text, a full-text rendition will be created and stored in the Elasticsearch index.

The endpoint posts the plain text passed in the request body to the text rendition property in the Elasticsearch index replacing the current value if already filled before.

Note: A dbs-reindex Command via Commander Service will undo all text rendition updates.

Meaning of HTTP status codes:

HTTP status code	Meaning
200	Successful, text rendition of specified object was updated.
404	Not successful, specified `objectId` does not exist or user has no `write` permission.
422	Not successful, text rendition was not updated.

Request Header Content-Type: text/plain

Request Example

/api/dms/objects/100a1bc1-2def-100a-1234-56b789c01de/contents/renditions/text

With request body:

test-test-post-rendition-text

Response Example

200

no response body

Browser not supported