1. REST API for Documents
  2. Tasks
  3. Files

Get Rendition

get

/documents/api/1.2/files/{fileId}/data/rendition

Get the thumbnail or page rendition for a specified file and page. You can also get any custom uploaded rendition for a specified file. A rendition is a viewable representation of the file contents.

Request

Supported Media Types
Path Parameters
Query Parameters

  • Specify the thumbnail number or page number in the following format.

    • page<#> 
      For example: rendition=page3
    • thumbnail<#> 
      For example: rendition=thumbnail3
    • uploaded rendition name 
      For example: rendition=small

  • Specify the rendition type to retrieve. This parameter needs to be used together with a rendition parameter: thumbnails or page renditions require renditionType=system; custom uploaded renditions require renditionType=uploaded. If renditionType is not specified, the system rendition type will be assumed.

  • Specify the version number of the file to use. If the version is not specified, the latest version is used. It is important to notice that system renditions and custom renditions can exist for a specific file version only.

Header Parameters

  • The standard HTTP Range header allows clients to stream parts of the file rather than the entire file. The value of the Range header can be one of the following formats:

    • bytes=startByte - endByte
      For example to receive the first 500 bytes use bytes=0-500
    • bytes=skipBytes-
      For example to skip the first 500 bytes use bytes=500-
    • bytes=-lastBytes
      For example to receive the last 500 bytes use bytes=-500

  • Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.

  • Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. It can be used as appLinkID or AppLinkID.

  • Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>

  • Public link ID of a public link authorizing the current user to access this file. It can be used as linkID or LinkID.

Back to Top

Response

Supported Media Types

200 Response

Complete data stream of the page rendition image, or custom rendition file uploaded.

206 Response

Partial data stream of the page rendition image, or custom rendition file uploaded.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

416 Response

Requested range cannot be satisfied.

Back to Top

Examples

The following example retrieves the page rendition for page 3 of version 2 of the specified file. If the status code indicates success (200), the response includes a data stream that contains the rendition image. Also, an optional parameter can be used to retrieve this system-generated rendition, renditionType=system. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=page3&version=2

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

Example 2

The following example retrieves the page rendition for page 1 of version 1 of the specified file. If the status code indicates success (200), the response includes a data stream that contains the rendition image. The example uses a public link ID because this file is under a folder structure not owned by or shared with the current user. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=page1&version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

Example 3

The following example retrieves the page rendition for page 1 of version 1 of the specified file. If the status code indicates success (200), the response includes a data stream that contains the rendition image. The example uses a public link ID protected by an access code because this file is under a folder structure not owned by or shared with the current user. An access code (test12345) is submitted as part of a Cookie in the request header. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=page1&version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

Example 4

The following example requests a rendition for page 1 of version 1 of the specified file. Because this file is under a folder structure not owned by or shared with the current user, an access denied error message is returned. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=page1&version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-20",
    "errorKey": "!csUnableToDownloadFile!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001,GET_RENDITION",
    "errorMessage": "Unable to download file. User 'User BB' has insufficient privilege to access fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001 with service GET_RENDITION.",
    "errorType": "file",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "rendition": "page1",
    "title": "Unable to download file. User 'User BB' has insufficient privilege to access fFileGUID:D3C1C1F319CFE6B102095C5DT0000000000100000001 with service GET_RENDITION.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "1"
}

Example 5

The following example requests a rendition for page 1 of version 1 of the specified file. This file is under a folder structure not owned by or shared with the current user, and only a public link protected by an access code is available. An error is returned because the access code was not submitted as part of the request. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=page1&version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-18",
    "errorKey": "!csUnableToDownloadFile!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "Unable to download file. The access code must be provided to access the link.",
    "errorType": "file",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "rendition": "page1",
    "title": "Unable to download file. The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "version": "1"
}

Example 6

The following example retrieves the custom rendition named small uploaded for revision 2 of the given file GUID. If the status code indicates success (200), the response includes a data stream that contains the rendition image. 

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=small&version=2&renditionType=uploaded

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

Example 7

The following example retrieves the page rendition for page 1 of version 1 of the specified file. If the status code indicates success (200), the response includes a data stream that contains the rendition image. The example uses an applink ID because this file is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header. 

GET .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/data/rendition?rendition=page1&version=1

Request Header

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200
Back to Top