REST API for Documents

Get File Information

get

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

Get file information for the specified file.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: string

Globally unique identifier (GUID) for the file.

Query Parameters

includeOnlyExistingRenditions(optional): boolean

This parameter is ignored unless includeRenditions is true. By default, only information about existing renditions is returned. When false, detailed information about all supported renditions with the file is returned. The exists field will indicate if a rendition has been created. The default is true.
includeRenditions(optional): boolean

When true, detailed information about existing renditions associated with the file is returned. The default is false.
version(optional): string

Specify the version number of the file to query. 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/json
application/xml

200 Response

The request was fulfilled.

Root Schema : FileResponseWithConversation

Type: object

The response body includes information about the file.

Show Source

errorCode(optional): number

An error code of zero (0) indicates no errors.

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Match All

Show Source

object FileDefinitionWithConversation

File information

{
    "description":"The response body includes information about the file.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/FileDefinitionWithConversation"
        }
    ],
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

Nested Schema : FileDefinitionWithConversation

Type: object

File information

Show Source

conversationID(optional): string

Conversation ID associated with this file or a parent folder.
createdBy(optional): object User

User information
createdTime(optional): string

File creation date.
id(optional): string

Globally unique identifier (GUID) for the file.
isConversationInherited(optional): boolean

Flag indicating whether the conversation ID is associated with the current file (false) or if the conversation ID is associated with a parent folder (true).
items(optional): array items

If includeRenditions was true on the request, an array of rendition data is included in the response.
mimeType(optional): string

File format of the file.
modifiedBy(optional): object User

User information
modifiedTime(optional): string

File last modified date.
name(optional): string

File name.
ownedBy(optional): object User

User information
parentID(optional): string

Globally unique identifier (GUID) for the parent folder. If the parent folder is the user's home folder, the value for parentID is self.
reservationTime(optional): string

Time the file was reserved (excluded from response data if the file is not reserved).
reservedBy(optional): object User

User information
size(optional): string

Size of the file in bytes.
type(optional): string

Item type file.
version(optional): string

File version.

{
    "description":"File information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the file."
        },
        "parentID":{
            "type":"string",
            "description":"<p>Globally unique identifier (GUID) for the parent folder. If the parent folder is the user&#39;s home folder, the value for <code>parentID</code> is <code>self</code>.</p>"
        },
        "name":{
            "type":"string",
            "description":"File name."
        },
        "mimeType":{
            "type":"string",
            "description":"File format of the file."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>file</code>."
        },
        "size":{
            "type":"string",
            "description":"Size of the file in bytes."
        },
        "version":{
            "type":"string",
            "description":"File version."
        },
        "createdTime":{
            "type":"string",
            "description":"File creation date."
        },
        "modifiedTime":{
            "type":"string",
            "description":"File last modified date."
        },
        "reservationTime":{
            "type":"string",
            "description":"Time the file was reserved (excluded from response data if the file is not reserved)."
        },
        "createdBy":{
            "$ref":"#/definitions/User"
        },
        "ownedBy":{
            "$ref":"#/definitions/User"
        },
        "modifiedBy":{
            "$ref":"#/definitions/User"
        },
        "reservedBy":{
            "$ref":"#/definitions/User"
        },
        "conversationID":{
            "type":"string",
            "description":"Conversation ID associated with this file or a parent folder."
        },
        "isConversationInherited":{
            "type":"boolean",
            "description":"Flag indicating whether the conversation ID is associated with the current file (false) or if the conversation ID is associated with a parent folder (true)."
        },
        "items":{
            "type":"array",
            "description":"If <code>includeRenditions</code> was true on the request, an array of rendition data is included in the response.",
            "items":{
                "$ref":"#/definitions/RenditionDataDefinition"
            }
        }
    }
}

Nested Schema : User

Type: object

User information

Show Source

displayName(optional): string

The display name for the user.
id(optional): string

Globally unique identifier (GUID) for the user.
loginName(optional): string

The login name for the user.
type(optional): string

Item type user.

{
    "description":"User information",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

Nested Schema : items

Type: array

If includeRenditions was true on the request, an array of rendition data is included in the response.

Show Source

Array of: object RenditionDataDefinition

{
    "type":"array",
    "description":"If <code>includeRenditions</code> was true on the request, an array of rendition data is included in the response.",
    "items":{
        "$ref":"#/definitions/RenditionDataDefinition"
    }
}

Nested Schema : RenditionDataDefinition

Type: object

Show Source

exists(optional): string

The status of a rendition. If the rendition has been created the value is true otherwise the value is false.
format(optional): string

The file format of a rendition.
height(optional): string

The height of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set.
link(optional): string

REST url to access the rendition. For uithumbnail and responsiveimage types the REST url will create the rendition if it does not exist.
name(optional): string

The name of the rendition.
type(optional): string
Can be one of the following values:
- The value uithumbnail is used when describing a thumbnail rendition.
- The value imagepreview is used when describing preview renditions.
- The value responsiveimage is used when describing responsive images.
- The value native is used when describing the the parent file or asset.

customrendition

width(optional): string

The width of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set.

{
    "description":"",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the rendition."
        },
        "type":{
            "type":"string",
            "description":"Can be one of the following values:<ul><li> The value <code>uithumbnail</code> is used when describing a thumbnail rendition.</li> <li>The value <code>imagepreview</code> is used when describing preview renditions.</li> <li>The value <code>responsiveimage</code> is used when describing responsive images.</li> <li>The value <code>native</code> is used when describing the the parent file or asset.</li> </li>The value <code>customrendition</code> is used when describing ad-hoc renditions added by a user</li></ul>"
        },
        "format":{
            "type":"string",
            "description":"The file format of a rendition."
        },
        "exists":{
            "type":"string",
            "description":"The status of a rendition. If the rendition has been created the value is <code>true</code> otherwise the value is <code>false</code>."
        },
        "link":{
            "type":"string",
            "description":"REST url to access the rendition. For <code>uithumbnail</code> and <code>responsiveimage</code> types the REST url will create the rendition if it does not exist."
        },
        "width":{
            "type":"string",
            "description":"The width of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set."
        },
        "height":{
            "type":"string",
            "description":"The height of a rendition in pixels. The value of '-1' means the height is unknown, a value of '0' means height is not set."
        }
    }
}

Example Response (application/json)

{
    "count":"13",
    "createdBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "createdTime":"2018-02-28T20:00:22Z",
    "errorCode":"0",
    "id":"DFB10CF19A743BF1338CFF01AB7008277F375F0158F1",
    "mimeType":"image/jpeg",
    "modifiedBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "modifiedTime":"2018-02-28T20:00:22Z",
    "name":"BlueSquare.jpg",
    "ownedBy":{
        "displayName":"Tenant1 UserB",
        "id":"Service1.UserB",
        "loginName":"Service1.UserB",
        "type":"user"
    },
    "parentID":"F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
    "size":"24205",
    "type":"file",
    "version":"1",
    "items":[
        {
            "type":"uithumbnail",
            "name":"thumbnail",
            "format":"png",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnail?version=1",
            "size":"2478",
            "width":"300",
            "height":"180"
        },
        {
            "type":"imagepreview",
            "name":"page1",
            "format":"jpg",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=page1&version=1",
            "size":"0",
            "width":"0",
            "height":"0"
        },
        {
            "type":"imagepreview",
            "name":"thumbnail1",
            "format":"png",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=thumbnail1&version=1",
            "size":"0",
            "width":"0",
            "height":"0"
        },
        {
            "type":"native",
            "name":"asset",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageThumbnailjpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnailImage?version=1",
            "size":"2275",
            "width":"150",
            "height":"90"
        },
        {
            "type":"responsiveimage",
            "name":"ImageThumbnailwebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/thumbnailImage?format=webp&version=1",
            "size":"0",
            "width":"150",
            "height":"90"
        },
        {
            "type":"responsiveimage",
            "name":"ImageSmalljpg",
            "format":"jpg",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/smallImage?version=1",
            "size":"0",
            "width":"300",
            "height":"180"
        },
        {
            "type":"responsiveimage",
            "name":"ImageSmallwebp",
            "format":"webp",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/smallImage?format=webp&version=1",
            "size":"380",
            "width":"300",
            "height":"180"
        },
        {
            "type":"responsiveimage",
            "name":"ImageMediumjpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/mediumImage?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageMediumwebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/mediumImage?format=webp&version=1",
            "size":"0",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageLargejpg",
            "format":"jpg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/largeImage?version=1",
            "size":"24205",
            "width":"360",
            "height":"216"
        },
        {
            "type":"responsiveimage",
            "name":"ImageLargewebp",
            "format":"webp",
            "exists":"false",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/largeImage?format=webp&version=1",
            "size":"0",
            "width":"360",
            "height":"216"
        },
        {
            "type":"customrendition",
            "name":"Desert",
            "format":"jpeg",
            "exists":"true",
            "link":"http://service1-tenant1:8080/documents/api/1.2/files/DFB10CF19A743BF1338CFF01AB7008277F375F0158F1/data/rendition?rendition=Desert&renditionType=uploaded&version=1",
            "size":"845941",
            "width":"1024",
            "height":"768"
        }
    ]
}

400 Response

Request parameters are not formatted correctly.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID is not found.

Examples

The following example returns file-definition information for version 2 of the specified file.

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=2

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "2"
}

Example 2

The following example returns file-definition information for version 1 of the specified file. 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/D574378400573ED9D62B3195T0000000000100000001?version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "1"
}

Example 3

The following example returns file-definition information for version 1 of the specified file. 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/D574378400573ED9D62B3195T0000000000100000001?version=1

Request Header

LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "size": "13",
    "type": "file",
    "version": "1"
}

Example 4

The following example requests file-definition information for 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/DBFC40982617C949CA373B08B5D17B95F47087F4E518?version=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 403

JSON Response

{
    "errorCode": "-20",
    "errorKey": "!csCloudItemInsufficientPrivileges,Tenant2.UserB,fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518,FLD_INFO",
    "errorMessage": "User 'User BB' has insufficient privilege to access fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518 with service FLD_INFO.",
    "errorType": "file",
    "id": "DBFC40982617C949CA373B08B5D17B95F47087F4E518",
    "title": "User 'User BB' has insufficient privilege to access fFileGUID:DBFC40982617C949CA373B08B5D17B95F47087F4E518 with service FLD_INFO.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 5

The following example requests file-definition information for 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/DBFC40982617C949CA373B08B5D17B95F47087F4E518?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": "DBFC40982617C949CA373B08B5D17B95F47087F4E518",
    "title": "The access code must be provided to access the link.",
    "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Example 6

The following example returns file-definition information for version 2 of the specified file. This file has a conversation associated with it, so two additional fields, conversationID and isConversationInherited, are returned as well.

GET .../files/D574378400573ED9D62B3195T0000000000100000001?version=2

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "createdBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "createdTime": "2014-02-21T21:15:57Z",
    "errorCode": "0",
    "id": "D574378400573ED9D62B3195T0000000000100000001",
    "modifiedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "modifiedTime": "2014-02-21T21:22:19Z",
    "name": "example.txt",
    "ownedBy": {
        "displayName": "User AA",
        "loginName": "userAALoginName",
        "id": "U0EAA20910FAF3052ACB79E4T00000000001",
        "type": "user"
    },
    "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001",
    "conversationID": "39911",
    "isConversationInherited": "false",
    "size": "13",
    "type": "file",
    "version": "2"
}

Example 7

The following example returns file-definition information for version 1 of the specified file. The example uses an applink 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/D574378400573ED9D62B3195T0000000000100000001?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

{
    "createdBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-26T15:29:00Z",
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "mimeType": "text/plain",
    "modifiedBy": {
        "displayName": "User BB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-26T15:29:07Z",
    "name": "fileViaApplink.txt",
    "ownedBy": {
        "displayName": "User AA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "userAALoginName",
        "type": "user"
    },
    "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
    "size": "29",
    "type": "file",
    "version": "1"
}

Example 8

The following example returns file-definition information and an items array listing renditions for the latest version of a jpeg image that is 360 pixels wide.

The uithumbnail rendition was created when the item was uploaded, and it is the only rendition listed.

The <code>responsiveimage</code> renditions are listed because the uploaded jpeg image can be used for these images.

GET ../files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43?includeRenditions=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "count": "4",
    "createdBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "createdTime": "2018-06-27T19:43:57Z",
    "errorCode": "0",
    "id": "D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43",
    "mimeType": "image/jpeg",
    "modifiedBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "modifiedTime": "2018-06-27T19:59:40Z",
    "name": "BlueSquare.jpg",
    "ownedBy": {
        "displayName": "UserB",
        "id": "Service1.UserB",
        "loginName": "Service1.UserB",
        "type": "user"
    },
    "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
    "size": "24205",
    "type": "file",
    "version": "2",
    "items": [
        {
            "type": "uithumbnail",
            "name": "thumbnail",
            "format": "png",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnail?version=2",
            "size": "2478",
            "width": "300",
            "height": "180"
        },
	{
	    "type": "native",
	    "name": "asset",
	    "format": "jpg",
	    "exists": "true",
	    "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data?version=2",
	    "size": "24205",
	    "width": "360",
	    "height": "216"
        },
        {
            "type": "responsiveimage",
            "name": "ImageMediumjpg",
            "format": "jpg",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?version=2",
            "size": "24205",
            "width": "360",
            "height": "216"
        },
        {
            "type": "responsiveimage",
            "name": "ImageLargejpg",
            "format": "jpg",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?version=2",
            "size": "24205",
            "width": "360",
            "height": "216"
        }
    ]
}

Example 9

The following example returns file-definition information and an items array listing renditions for the latest version of a jpeg image that is 360 pixels wide.

The uithumbnail rendition was created when the item was uploaded.

The includeOnlyExistingRenditions parameter is false, so other supported renditions are returned.

The imagepreview renditions have not been created, but two are listed because the item can have imagepreview renditions.

The responsiveimage renditions not been created, but eight are listed because the item can have responsiveimage renditions.

GET ../files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43?includeRenditions=1&includeOnlyExistingRenditions=0

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T19:43:57Z",
     "errorCode": "0",
     "id": "D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43",
     "mimeType": "image/jpeg",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T19:59:40Z",
     "name": "BlueSquare.jpg",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "24205",
     "type": "file",
     "version": "2",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnail?version=2",
             "size": "2478",
             "width": "300",
             "height": "180"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/rendition?rendition=page1&version=2",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/rendition?rendition=thumbnail1&version=2",
             "size": "0",
             "width": "0",
             "height": "0"
         },
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data?version=2",
	     "size": "24205",
	     "width": "360",
	     "height": "216"
        },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailjpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnailImage?version=2",
             "size": "0",
             "width": "150",
             "height": "90"
         },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/thumbnailImage?format=webp&version=2",
             "size": "0",
             "width": "150",
             "height": "90"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmalljpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/smallImage?version=2",
             "size": "0",
             "width": "300",
             "height": "180"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmallwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/smallImage?format=webp&version=2",
             "size": "0",
             "width": "300",
             "height": "180"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumjpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?version=2",
             "size": "24205",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/mediumImage?format=webp&version=2",
             "size": "0",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargejpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?version=2",
             "size": "24205",
             "width": "360",
             "height": "216"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargewebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D3ACC67B205DDDBF08649EFBEC9A27D3EBF39003CD43/data/largeImage?format=webp&version=2",
             "size": "0",
             "width": "360",
             "height": "216"
         }
     ]
 }

Example 10

The following example returns file-definition information and an items array listing renditions for the latest version of a png image.

The uithumbnail rendition was created when the item was uploaded.

The imagepreview renditions have been created.

GET ../files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E?includeRenditions=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "6",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T20:17:14Z",
     "errorCode": "0",
     "id": "D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E",
     "mimeType": "image/png",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T20:17:14Z",
     "name": "Mugs.png",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "226620",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnail?version=1",
             "size": "168743",
             "width": "300",
             "height": "300"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=page1&version=1",
             "size": "359897",
             "width": "475",
             "height": "475"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=thumbnail1&version=1",
             "size": "81040",
             "width": "200",
             "height": "200"
         }
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },
	 {
	     "type": "responsiveimage",
	     "name": "ImageMediumjpg",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },
	 {
	     "type": "responsiveimage",
	     "name": "ImageLargejpg",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
        }
     ]
 }

Example 11

The following example returns file-definition information and an items array listing renditions for the latest version of a png image.

The uithumbnail rendition was created when the item was uploaded.

The imagepreview renditions have been created.

The includeOnlyExistingRenditions parameter is false, so other supported renditions are returned.

The responsiveimage renditions have not been created.

GET ../files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E?includeRenditions=1&includeOnlyExistingRenditions=0

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-06-27T20:17:14Z",
     "errorCode": "0",
     "id": "D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E",
     "mimeType": "image/png",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-06-27T20:17:14Z",
     "name": "Mugs.png",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F58C9C0DC02C049077861CCC2D4215B40039AC067D9F",
     "size": "226620",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnail?version=1",
             "size": "168743",
             "width": "300",
             "height": "300"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=page1&version=1",
             "size": "359897",
             "width": "475",
             "height": "475"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/rendition?rendition=thumbnail1&version=1",
             "size": "81040",
             "width": "200",
             "height": "200"
         },
	 {
	     "type": "native",
	     "name": "asset",
	     "format": "jpg",
	     "exists": "true",
	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data?version=1",
	     "size": "53834",
	     "width": "475",
	     "height": "475"
	 },         
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailjpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnailImage?version=1",
             "size": "0",
             "width": "150",
             "height": "150"
         },
         {
             "type": "responsiveimage",
             "name": "ImageThumbnailwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/thumbnailImage?format=webp&version=1",
             "size": "0",
             "width": "150",
             "height": "150"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmalljpg",
             "format": "jpg",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/smallImage?version=1",
             "size": "0",
             "width": "300",
             "height": "300"
         },
         {
             "type": "responsiveimage",
             "name": "ImageSmallwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/smallImage?format=webp&version=1",
             "size": "0",
             "width": "300",
             "height": "300"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumjpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?version=1",
             "size": "53834",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageMediumwebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/mediumImage?format=webp&version=1",
             "size": "0",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargejpg",
             "format": "jpg",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?version=1",
             "size": "53834",
             "width": "475",
             "height": "475"
         },
         {
             "type": "responsiveimage",
             "name": "ImageLargewebp",
             "format": "webp",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D75D38F72006EBEAE69D446DE2DCE0D90FEE470F7A3E/data/largeImage?format=webp&version=1",
             "size": "0",
             "width": "475",
             "height": "475"
         }
     ]
 }

Example 12

The following example returns file-definition information for the latest version of a document file. No other renditions have been created. The data about the uploaded file is always returned.

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "1",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }
     ]
 }

Example 13

The following example returns file-definition information and an items array listing renditions for the latest version of a document file.

The includeOnlyExistingRenditions parameter is false, so other supported renditions are returned.

The uithumbnail rendition has not been created, but is listed because the item can have a uithumbnail rendition.

The imagepreview rendition has not been created, but two are listed because the item can have imagepreview renditions.

The responsiveimage renditions are not listed because this type of file does not have these renditions.

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1&includeOnlyExistingRenditions=0

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "4",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "false",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "0",
             "width": "0",
             "height": "0"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }
     ]
 }

Example 14

The following example returns file-definition information and an items array listing renditions for the latest version of a document file.

The uithumbnail rendition has been created.

The imagepreview renditions have been created.

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "10",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "4pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "1773",
             "width": "300",
             "height": "388"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "21547",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page2&version=1",
             "size": "21190",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page3&version=1",
             "size": "21419",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page4&version=1",
             "size": "22144",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "1138",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail2&version=1",
             "size": "1933",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail3&version=1",
             "size": "1989",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail4&version=1",
             "size": "1468",
             "width": "200",
             "height": "258"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }         
     ]
 }

Example 15

The following example returns file-definition information and an items array listing renditions for the latest version of a document file.

The uithumbnail rendition has been created.

The imagepreview renditions have been created.

The includeOnlyExistingRenditions parameter is false, but no other renditions are supported or returned.

GET ../files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313?includeRenditions=1&includeOnlyExistingRenditions=0

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "12",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-02-28T21:13:22Z",
     "errorCode": "0",
     "id": "D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313",
     "mimeType": "application/msword",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-02-28T21:13:22Z",
     "name": "5pages.DOC",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F26D598E507E96F9B41C98BA36219C7DA83E60B83105",
     "size": "19968",
     "type": "file",
     "version": "1",
     "items": [
         {
             "type": "uithumbnail",
             "name": "thumbnail",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/thumbnail?version=1",
             "size": "1773",
             "width": "300",
             "height": "388"
         },
         {
             "type": "imagepreview",
             "name": "page1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page1&version=1",
             "size": "21547",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page2&version=1",
             "size": "21190",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page3&version=1",
             "size": "21419",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page4&version=1",
             "size": "22144",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "page5",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=page5&version=1",
             "size": "21225",
             "width": "1856",
             "height": "2402"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail1",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail1&version=1",
             "size": "1138",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail2",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail2&version=1",
             "size": "1933",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail3",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail3&version=1",
             "size": "1989",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail4",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail4&version=1",
             "size": "1468",
             "width": "200",
             "height": "258"
         },
         {
             "type": "imagepreview",
             "name": "thumbnail5",
             "format": "png",
             "exists": "true",
             "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data/rendition?rendition=thumbnail5&version=1",
             "size": "1871",
             "width": "200",
             "height": "258"
         },
     	 {
     	     "type": "native",
     	     "name": "asset",
     	     "format": "doc",
     	     "exists": "true",
     	     "link": "http://service1-tenant1:8080/documents/api/1.2/files/D6DCA56024CD685252FC63D8898D1B9BD9CCD89FD313/data?version=1",
     	     "size": "19968",
     	     "width": "-1",
     	     "height": "-1"
	 }       
     ]
 }

Example 16

The following example returns file-definition information a file. The includeRenditions parameter is passed, but this file cannot have uithumbnail or imagepreview or responsiveimage renditions. The data about the uploaded file is always returned.

GET ../files/DAF3997E4E00AF180598C34DD394A94AF203799A93B9?includeRenditions=1

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
     "count": "1",
     "createdBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "createdTime": "2018-01-26T21:56:28Z",
     "errorCode": "0",
     "id": "DAF3997E4E00AF180598C34DD394A94AF203799A93B9",
     "mimeType": "Application/patch",
     "modifiedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "modifiedTime": "2018-01-26T21:56:28Z",
     "name": "HeaderRsetPatch.patch",
     "ownedBy": {
         "displayName": "UserB",
         "id": "Service1.UserB",
         "loginName": "Service1.UserB",
         "type": "user"
     },
     "parentID": "F62C1A59C7E759FD515C8F00D394A94AF203799A93B9",
     "size": "1585",
     "type": "file",
     "version": "1"
    "items": [
        {
            "type": "native",
            "name": "asset",
            "format": "patch",
            "exists": "true",
            "link": "http://service1-tenant1:8080/documents/api/1.2/files/DAF3997E4E00AF180598C34DD394A94AF203799A93B9/data?version=1",
            "size": "1585",
            "width": "-1",
            "height": "-1"
        }
    ]
}