REST API for Content Management 1.1

Get File Information

get

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

Get file information for the specified file.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: Type: string

Required: true

Globally unique identifier (GUID) for the file.

Query Parameters

version: Type: string

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

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 file.

Root Schema : FileResponseWithConversation

Type: object

The response body includes information about the file.

Properties

errorCode: Type: number

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

Match All

Type: object FileDefinitionWithConversation

Additional Properties Allowed:

File information

Nested Schema : FileDefinitionWithConversation

File information

Properties

conversationID: Type: string

Conversation ID associated with this file or a parent folder.
createdBy: Type: object User

Additional Properties Allowed:

User information
createdTime: Type: string

File creation date.
id: Type: string

Globally unique identifier (GUID) for the file.
isConversationInherited: Type: 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).
mimeType: Type: string

File format of the file.
modifiedBy: Type: object User

Additional Properties Allowed:

User information
modifiedTime: Type: string

File last modified date.
name: Type: string

File name.
ownedBy: Type: object User

Additional Properties Allowed:

User information
parentID: Type: 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: Type: string

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

Additional Properties Allowed:

User information
size: Type: string

Size of the file in bytes.
type: Type: string

Item type file.
version: Type: string

File version.

Nested Schema : User

User information

Properties

displayName: Type: string

The display name for the user.
id: Type: string

Globally unique identifier (GUID) for the user.
type: Type: string

Item type user.

Example application/json


{
    "id":"DB1C5AF480FFE61C588027A8T0000000000100000001",
    "parentID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
    "name":"example.txt",
    "type":"file",
    "size":"13",
    "version":"1",
    "createdTime":"2014-02-21T21:32:37Z",
    "modifiedTime":"2014-02-21T21:32:37Z",
    "conversationID":"13865",
    "isConversationInherited":"false",
    "createdBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "ownedBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "modifiedBy":{
        "id":"U0EAA20910FAF3052ACB79E4T00000000001",
        "displayName":"User AA",
        "type":"user"
    },
    "errorCode":"0"
}

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 new 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": "Tenant2.UserB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "createdTime": "2017-06-26T15:29:00Z",
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "mimeType": "text/plain",
    "modifiedBy": {
        "displayName": "Tenant2.UserB",
        "id": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470",
        "type": "user"
    },
    "modifiedTime": "2017-06-29T22:00:33Z",
    "name": "fileViaApplink.txt",
    "ownedBy": {
        "displayName": "Tenant2.UserA",
        "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470",
        "loginName": "Tenant2.UserA",
        "type": "user"
    },
    "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518",
    "size": "29",
    "type": "file",
    "version": "3"
}