REST API for Documents

Generate File Renditions

post

/documents/api/1.2/files/{fileId}/pages

Generate an image based preview (page renditions) for a specified file that does not have an image based preview (page renditions). An image based preview (or rendition) is a viewable representation of the file contents where each page of the file is converted to an image. Not all file types support image based preview (page renditions).

The types of files that can have renditions include (similar formats may also be supported):

Most images (bmp,jpg,tif,gif,png)
Office files (doc, docx, dot, dotx, xls, xlsx, xls, xlst, pot, potx, ppt, pptx)
Text files (txt, scripts, source code)
AutoCAD drawings
Adobe PDF files
Internet files (html, email)

Note that previews (page renditions) cannot be generated for video formats.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: string

Globally unique identifier (GUID) for the file.

Query Parameters

version(optional): string

Specify the version number of the file to use. If the version is not specified, the latest version is used.

Header Parameters

accessToken(optional): string

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.
appLinkID(optional): string

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.
dAccessCode(optional): string

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>
linkID(optional): string

Public link ID of a public link authorizing the current user to access this file. To work, this public link must have the contributor role granted. It can be used as linkID or LinkID.

Response

Supported Media Types

application/octet-stream

200 Response

The request was fulfilled.

Root Schema : FileGenPagesResponse

Type: object

The response body includes information about creating an image base preview (page renditions).

Show Source

errorCode(optional): number

An error code of zero (0) indicates no errors.
id(optional): string

Globally unique identifier (GUID) for the file.
type(optional): string

Item type file.

{
    "description":"The response body includes information about creating an image base preview (page renditions).",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Example Response (application/json)

{
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "errorCode":"0"
}

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example generates page renditions for a specified file that does not have page renditions. A rendition is a viewable representation of the file contents. Not all file types support page renditions. The example uses a public link ID because this file is under a folder structure not owned by or shared with the current user.

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "version": "1"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

Example 2

The following example generates page renditions for a specified file that does not have page renditions. A rendition is a viewable representation of the file contents. Not all file types support page renditions. 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.

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

{
    "version": "1"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

Example 3

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

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/page

Request Header

None.

Request Body

{
    "version": "1"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

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

Example 4

The following example requests generation of page renditions for a specified file version that does not have page renditions. 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.

POST .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

{
    "version": "1"
}

HTTP Status Code

HTTP_STATUS = 403

JSON Response

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

Example 5

The following example generates page renditions for a specified file that does not have page renditions. A rendition is a viewable representation of the file contents. Not all file types support page renditions. 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.

POST .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/pages

Request Header

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

Request Body

{
    "version": "1"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}