GET /api/dms/objects/{objectId}/contents/renditions​/text

Owned by Technische Redaktion
Last updated: Oct 05, 2021
1 min read
As of Versionproduct version 2020 Autumn | component version 2020 Autumn
Request MethodGET
Response Formatplain text
Required Permissionaction 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.

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:

TypesExtension

Microsoft Office and Excel file types

MS Office Word 97-2016

doc, docx
Rich Text Formatrtf

MS Office PowerPoint 97-2016

ppt, pptx
Plain Texttxt
Comma Separated Valuescsv

MS Office Excel 97-2016

xls, xlsx
OpenDocument Textodt
OpenDocument Presentationodp
OpenDocument Spreadsheetods
HyperText Markup Language (HTML)html
MS Outlookmsg
XMLxml
JavaScript Object Notationjson
Encapsulated Portable Document Formatepdf
Portable Document Formatpdf
Request Example
/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da/contents/renditions/text
Result Example
test-test-get-rendition-text