REST API for Documents

Get Rendition Page Count

get

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

Get the number of renditions (pages) created for the specified file that has an image based preview (rendition) created image. 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.

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. It can be used as linkID or LinkID.

Response

Supported Media Types

application/octet-stream

200 Response

The request was fulfilled.

Root Schema : FilePagesResponse

Type: object

The response body includes information about the unreserve operation.

Show Source

errorCode(optional): number

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

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

Number of images created for the image based preview (rendition). Typically every page is one image. Note: if the file only has an HTML5 preview, this value is zero (0).
type(optional): string

Item type file.

{
    "description":"The response body includes information about the unreserve operation.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "pages":{
            "type":"string",
            "description":"Number of images created for the image based preview (rendition). Typically every page is one image. Note: if the file only has an HTML5 preview, this value is zero (0)."
        },
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Example Response (application/json)

{
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "pages":"22",
    "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 returns the number of pages with renditions in version 1 of the specified file.

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/pages?version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 2

The following example returns the number of pages in the specified file that have an associated rendition image. A rendition is a viewable representation of the file contents. 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/pages?version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 3

The following example returns the number of pages in the specified file that have an associated rendition image. A rendition is a viewable representation of the file contents. 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/pages?version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

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

Example 4

The following example requests the number of pages in the specified file that have an associated rendition image. 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/pages?version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

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

Example 5

The following example requests the number of pages in the specified file that have an associated rendition image. 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/pages?version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-18",
    "errorKey": "!csAccessCodeRequiredForLinkAccess",
    "errorMessage": "The access code must be provided to access the link.",
    "errorType": "file",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "pages": "0",
    "title": "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 returns the number of pages in the specified file that have an associated rendition image. A rendition is a viewable representation of the file contents. 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/pages?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

JSON Response

JSON Response
{
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "pages": "1",
    "type": "file",
    "version": "1"
}