REST API for Content Management 1.1

List Renditions

get

/documents/api/1.1/files/{fileId}/data/renditions

List system-generated renditions or user-uploaded renditions for a file version.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: Type: string

Required: true

Globally unique identifier (GUID) for the file.

Query Parameters

renditionType: Type: string

Specify the rendition type to retrieve. Use renditionType=system for thumbnail and page renditions; use renditionType=uploaded for custom uploaded renditions.
version: Type: string

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

accessToken: Type: 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: Type: 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: Type: 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: Type: 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/json
application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about the list of renditions.

Root Schema : FileListCustomRenditionResponse

The response body includes information about the list of renditions.

Properties

errorCode: Type: number

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

Globally unique identifier (GUID) for the file.
items: Type: array items

Additional Properties Allowed:

List of renditions.
type: Type: string

Item type file.

Nested Schema : items

Type: array

List of renditions.

Items

Type: object FileCustomRenditionDefinition

Additional Properties Allowed:

Rendition information

Nested Schema : FileCustomRenditionDefinition

Rendition information

Properties

description: Type: string

Rendition description.
name: Type: string

Rendition name.
originalName: Type: string

Rendition original file name.
path: Type: string

Rendition path.
type: Type: string

Item type rendition.

Example application/json


{
    "errorCode":"0",
    "id":"D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type":"file",
    "items":[
        {
            "type":"rendition",
            "name":"small",
            "description":"jellyfish small custom rendition",
            "path":"small.jpg",
            "originalName":"Jellyfish_small.jpg"
        },
        {
            "type":"rendition",
            "name":"crop",
            "description":"jellyfish crop custom rendition",
            "path":"crop.jpg",
            "originalName":"Jellyfish_crop.jpg"
        }
    ]
}

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example lists custom renditions uploaded to revision 1 of the given file.

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/renditions?renditionType=uploaded&version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "small",
            "description": "jellyfish_small_custom_rendition",
            "path": "small.jpg",
            "originalName": "Jellyfish_small.jpg"
        },
        {
            "type": "rendition",
            "name": "crop",
            "description": "jellyfish_crop_custom_rendition",
            "path": "crop.jpg",
            "originalName": "Jellyfish_crop.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv2",
            "description": "jellyfish small custom rendition v2",
            "path": "smallv2.jpg",
            "originalName": "smallJellyfish.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv3",
            "description": "jellyfish small custom rendition v3",
            "path": "smallv3.jpg",
            "originalName": "smallJellyfish.jpg"
        },
        {
            "type": "rendition",
            "name": "smallv4",
            "description": "jellyfish small custom rendition v4",
            "path": "smallv4.jpg",
            "originalName": "smallJellyfish.jpg"
        }
    ]
}

Example 2

The following example lists system renditions uploaded to revision 1 of the given file.

GET .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/renditions?renditionType=system&version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "page1",
            "description": "image for page1",
            "path": "pages.jpg",
            "originalName": "SOMETHING00004370530000003400-page1.jpg"
        },
        {
            "type": "rendition",
            "name": "thumbnail1",
            "description": "image for thumbnail1",
            "path": "thumbnails.png",
            "originalName": "SOMETHING00004370530000003400-thumbnail1.jpg"
        },
        {
            "type": "rendition",
            "name": "PageInfo",
            "description": "image for PageInfo",
            "path": "pageinfo.hda",
            "originalName": "SOMETHING00004370530000003400-PageInfo.jpg"
        }
    ]
}

Example 3

The following example lists custom renditions uploaded to revision 1 of the given file. 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/renditions?renditionType=uploaded&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

{
    "errorCode": "0",
    "id": "D68C8A7282DA5F389E3B009F98503556E71E89DE95CC",
    "type": "file",
    "items": [
        {
            "type": "rendition",
            "name": "applinkRendition",
            "description": "custom rendition via applink",
            "path": "applinkRendition.txt",
            "originalName": "appLinkCustomRendition.txt"
        }
    ]