As of Version product version 2020 Autumn | component version 2020 Autumn

Request Method GET

Response Format plain text

Required Permission action read
>> Roles and Role Sets

Description

To return the content file's full-text rendition of the DMS object, send the request with the ID of the DMS object as objectId.

If no full-text rendition is stored in the Elsticsearch index for the specified object, the request results in error "404 - not found."

If a content file is imported having one of the formats listed below and containing readable text, a full-text rendition will be created and stored in the Elasticsearch index. The full-text rendition can be overwritten via POST /api/dms/objects/{objectId}/contents/renditions/text.

A read permission is required (otherwise results in error "404 - not found").

The endpoint accepts the the following target file types for the text extraction:

Types	Extension
Microsoft Office and Excel file types
MS Office Word 97-2016	doc, docx
Rich Text Format	rtf
MS Office PowerPoint 97-2016	ppt, pptx
Plain Text	txt
Comma Separated Values	csv
MS Office Excel 97-2016	xls, xlsx
OpenDocument Text	odt
OpenDocument Presentation	odp
OpenDocument Spreadsheet	ods
HyperText Markup Language (HTML)	html
MS Outlook	msg
XML	xml
JavaScript Object Notation	json
Encapsulated Portable Document Format	epdf
Portable Document Format	pdf

Request Example

/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da/contents/renditions/text

Result Example

test-test-get-rendition-text

Microsoft Office and Excel file types

Browser not supported