[GET] /file

[GET] /file

/api/dms/objects/{objectId}/contents/file

Description

To retrieve all content files of the DMS object with the given {objectId}. If the DMS object has multiple files attached, a ZIP archive with all content files is returned. If there is only one content file, the file itself is returned. A special case are objects with multiple TIFF files attached. They are merged to one multipage TIFF file and not to a ZIP archive. If the download should have a predefined name, the query parameter filename could be attachted to the request without a file extension. The file extension is generated from the content files.

Request
Method

GET

Request optional
Query Parameter

None Core-API Query Parameters:

  • objectTypeId (String): The objectTypeId for the object to query. This speed up the query.

  • filename (String): If set the response header "Content-Disposition" is set to the file name with automatic suffix, otherwise the "Content-Disposition" is named with "file" and automatic suffix.

  • tiffViaServer (Boolean): If a object with multiple TIFF files is requested they are merged to one TIFF file. Is this query parameter added with the value "true" the enaio® server is used to merge them instead of the rendition. This might take longer but is directly available.

Response
Format

If it could be determined the mime type of the content.

If it could not be determined the response format is application/octet stream.

Minimum Version

3.0.0

Changelog

  • 5.3.1: Query Parameter "tiffViaServer" added. Improved determination of the Response Format.

Request
Example

/api/dms/objects/2563/contents/file
/api/dms/objects/2563/contents/file?filename=report

Result
Example

A byte sequence of the file or a ZIP archive if there are multiple content files attached to the object (e.g. image object types).