Get File Versions
/documents/api/1.2/files/{fileId}/versions
Get version information for the specified file.
Request
- application/json
- application/xml
-
fileId: string
Globally unique identifier (GUID) for the file.
-
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 parameteraccessToken
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
- application/json
- application/xml
200 Response
The request was fulfilled.
object
-
errorCode(optional):
number
An error code of zero (0) indicates no errors.
-
id(optional):
string
Globally unique identifier (GUID) for the file.
-
items(optional):
array items
List of File Versions.
-
name(optional):
string
File name.
-
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
isself
. -
type(optional):
string
Item type
file
.
array
-
Array of:
object FileDefinition
File information
object
-
createdBy(optional):
object User
User information
-
createdTime(optional):
string
File creation date.
-
id(optional):
string
Globally unique identifier (GUID) for the file.
-
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
isself
. -
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.
object
-
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
.
{
"id":"D574378400573ED9D62B3195T0000000000100000001",
"parentID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
"name":"example2.txt",
"type":"file",
"errorCode":"0",
"items":[
{
"id":"D574378400573ED9D62B3195T0000000000100000001",
"parentID":"FB4CD874EF94CD2CC1B60B72T0000000000100000001",
"name":"example2.txt",
"type":"file",
"size":"13",
"version":"1",
"createdTime":"2014-02-21T21:15:57Z",
"modifiedTime":"2014-02-21T21:18:49Z",
"createdBy":{
"displayName":"User AA",
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"loginName":"userAALoginName",
"type":"user"
},
"ownedBy":{
"displayName":"User AA",
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"loginName":"userAALoginName",
"type":"user"
},
"modifiedBy":{
"displayName":"User AA",
"id":"U0EAA20910FAF3052ACB79E4T00000000001",
"loginName":"userAALoginName",
"type":"user"
}
}
]
}
403 Response
Forbidden if the user does not have read permission.
404 Response
File ID is not found.
Examples
The following example returns a file definition for each version of the specified file.
GET .../files/D574378400573ED9D62B3195T0000000000100000001/versions
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "id": "D574378400573ED9D62B3195T0000000000100000001", "name": "example2.txt", "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001", "type": "file", "items": [ { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001", "name": "example2.txt", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedTime": "2014-02-21T21:18:49Z", "createdBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "version": "1", "createdTime": "2014-02-21T21:15:57Z", "size": "13" }, { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001", "name": "example2.txt", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedBy": "{ "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedTime": "2014-02-21T21:18:49Z", "createdBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "version": "2", "createdTime": "2014-02-21T21:17:13Z", "size": "13" }, { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001", "name": "example2.txt", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedTime": "2014-02-21T21:18:49Z", "createdBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "version": "3", "createdTime": "2014-02-21T21:18:20Z", "size": "13" }, { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "FB4CD874EF94CD2CC1B60B72T0000000000100000001", "name": "example2.txt", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "modifiedTime": "2014-02-21T21:18:49Z", "createdBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "U0EAA20910FAF3052ACB79E4T00000000001", "type": "user" }, "version": "4", "createdTime": "2014-02-21T21:18:48Z", "size": "13" } ] }
Example 2
The following example returns a file definition for each version 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/versions
Request Header
LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "id": "D574378400573ED9D62B3195T0000000000100000001", "name": "idcTestNewFile1KB.txt", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "type": "file", "items": [ { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "type": "user" }, "modifiedBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "modifiedTime": "2016-06-30T21:06:49Z", "name": "idcTestNewFile1KB.txt", "createdBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "version": "8", "createdTime": "2016-06-30T21:06:49Z", "mimeType": "text/plain", "size": "33" }, { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "type": "user" }, "modifiedBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "modifiedTime": "2016-06-30T21:06:45Z", "name": "idcTestNewFile1KB.txt", "createdBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "version": "7", "createdTime": "2016-06-30T21:06:45Z", "mimeType": "text/plain", "size": "33" } ] }
Example 3
The following example returns a file definition for each version 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/versions
Request Header
LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518 Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "errorCode": "0", "id": "D574378400573ED9D62B3195T0000000000100000001", "name": "idcTestNewFile1KB.txt", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "type": "file", "items": [ { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "type": "user" }, "modifiedBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "modifiedTime": "2016-06-30T21:06:49Z", "name": "idcTestNewFile1KB.txt", "createdBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "version": "8", "createdTime": "2016-06-30T21:06:49Z", "mimeType": "text/plain", "size": "33" }, { "type": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "parentID": "F4AB9FC75860ECB429D36BA2B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "loginName": "userAALoginName", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "type": "user" }, "modifiedBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "modifiedTime": "2016-06-30T21:06:45Z", "name": "idcTestNewFile1KB.txt", "createdBy": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U6A0B35B0548F250914D18FDB5D17B95F470", "type": "user" }, "version": "7", "createdTime": "2016-06-30T21:06:45Z", "mimeType": "text/plain", "size": "33" } ] }
Example 4
The following example requests a file definition for each version 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/D574378400573ED9D62B3195T0000000000100000001/versions
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 403
JSON Response
{ "errorCode": "-20", "errorKey": "!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D574378400573ED9D62B3195T0000000000100000001,FLD_FILE_REVISIONS", "errorMessage": "User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_FILE_REVISIONS.", "errorType": "file", "id": "D574378400573ED9D62B3195T0000000000100000001", "title": "User 'User BB' has insufficient privilege to access fFileGUID:D574378400573ED9D62B3195T0000000000100000001 with service FLD_FILE_REVISIONS.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html" }
Example 5
The following example requests a file definition for each version 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/D574378400573ED9D62B3195T0000000000100000001/versions
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": "D574378400573ED9D62B3195T0000000000100000001", "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 a file definition for each version of the specified 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/versions
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": "DED694950C14AFF280419F9AB5D17B95F47087F4E518", "name": "fileViaApplink-renamed.txt", "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518", "type": "file", "items": [ { "type": "file", "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518", "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "loginName": "userAALoginName", "type": "user" }, "modifiedBy": { "displayName": "User BB", "id": "U5083EA1954687218BA6C3D9B5D17B95F470", "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470", "type": "user" }, "modifiedTime": "2017-06-26T15:29:07Z", "name": "fileViaApplink-renamed.txt", "createdBy": { "displayName": "User BB", "id": "U5083EA1954687218BA6C3D9B5D17B95F470", "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470", "type": "user" }, "version": "2", "createdTime": "2017-06-26T15:29:07Z", "mimeType": "text/plain", "size": "29" }, { "type": "file", "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518", "parentID": "FDC22B65E850730CAA60AF83B5D17B95F47087F4E518", "ownedBy": { "displayName": "User AA", "id": "UEB6AD431E4357AE752CE3F2B5D17B95F470", "loginName": "userAALoginName", "type": "user" }, "modifiedBy": { "displayName": "User BB", "id": "U5083EA1954687218BA6C3D9B5D17B95F470", "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470", "type": "user" }, "modifiedTime": "2017-06-26T15:29:00Z", "name": "fileViaApplink.txt", "createdBy": { "displayName": "User BB", "id": "U5083EA1954687218BA6C3D9B5D17B95F470", "loginName": "U5083EA1954687218BA6C3D9B5D17B95F470", "type": "user" }, "version": "1", "createdTime": "2017-06-26T15:29:00Z", "mimeType": "text/plain", "size": "29" } ] }