Get Document as a TIFF File

GET /ws/rest/service/v2/dm/files/view/<file_id>

Purpose

Retrieve documents in .TIFF file format.

Prerequisites

Ensure you have the required Document Manager integration permissions.

Request Format

Send a GET request in the format specified above.

Request Parameter

The following parameter must be specified in the request:

Request Parameter	Required?	Data Type	Description
file_Id	Yes	Integer

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [<list of messages>],

"status": <REST status code value>,

"rest_audit_id": <id from the audit table>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Success Response

A successful response generates a TIFF file with a status code 200, and the rest_audit_id.

Sample Failed Response

The following response is generated if the WebViewer server is down:

{

"data": [],

"message": ["Unable to connect to the server. Server Code: 0 - Code: APRYSE-WVSSRDWN1"],

"status": 14011,

"rest_audit_id": 719

}

Supported Validation Messages and Status Codes

The following validation messages and status codes display in the response when incorrect values are provided in the request:

Use-case Scenario	Status Code	Error Message
File is deleted or not available in the repository.	14004	.Base file is empty or not available in repo.
User does not have permission.	1041	User has no permission for this action.
Inactive shell or view shell can't fetch the document.	1325	This operation is not supported on Inactive or View-only Shell/Project/Program.
File is not scanned for virus.	1078	This file has not been scanned for threats.
File has a virus threat.	1077	The virus scanner found threat in the file.
blockscan value is incorrect.	11008	blockscanpendingfiles should be one of [true, false]
Error while initializing Apryse license.	14007	Unable to initialize license for Standard Viewer.
File conversion is in process.	14014	File conversion is in progress. Please wait until file conversion is over.
File is password-protected.	14008	Unable to convert document as the file is password protected.
Tiff file is not available.	14013	Tiff file is empty or not available in repo.
Server issue while connecting to the WebViewer server.	14011	Unable to connect to the server. Server Code: {0} - Code: {1}
Server-related issue or server is not reachable.	14009	Server Error, contact the system administrator referencing this error code.
Server-related issue or server is not reachable.	14010	Server Error, contact the system administrator referencing this error code: {0}
WebViewer server is not available.	14012	Apryse WebViewerServer is unavailable.
Uploaded file format is not supported for conversion.	14006	File Format is not supported: {0}.
File size limit exceeded and cannot be converted.	14005	File Size is not supported more than {0}.
Requested file does not exist.	1069	File does not exist.