Move File
/documents/api/1.2/files/{fileId}/move
Move a specified file and its versions to a specified destination folder. The moved file retains its globally unique identifier and all date and ownership information.
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. To work, this applink must have at least the contributor role granted. 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. To work, this public link must have the contributor role granted. It can be used as linkID or LinkID.
The request body defines details of the move file request. Bold indicates a required value.
object
The request body defines the details of the move file request. Bold indicates a required value.
-
destinationID:
string
(Required) Specify the globally unique identifier (GUID) of the destination folder.
-
duplicateResolution(optional):
string
(Optional) Specify the
TimeStampSuffix
option. The name of the moved file is given a 6-digit suffix from the system timestamp.
{
"destinationID":"FF4729683CD68C1AFB1AE87DT0000000000100000001"
}
Response
- application/json
- application/xml
200 Response
The request was fulfilled.
object
-
destinationID(optional):
string
Globally unique identifier (GUID) of the destination folder.
-
errorCode(optional):
number
An error code of zero (0) indicates no errors.
-
idList(optional):
string
Globally unique identifier (GUID) of the original file.
-
type(optional):
string
Item type
file
.
{
"destinationID":"FF4729683CD68C1AFB1AE87DT0000000000100000001",
"idList":"D574378400573ED9D62B3195T0000000000100000001",
"type":"file",
"errorCode":"0"
}
400 Response
Request parameters are not formatted correctly.
403 Response
Forbidden if the user does not have read permission for the moved file, or write permission for the destination folder.
404 Response
File ID is not found.
Examples
The following example moves the specified file to the specified destination.
POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move
Request Header
None.
Request Body
{ "destinationID": "FF4729683CD68C1AFB1AE87DT0000000000100000001" }
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "destinationID": "FF4729683CD68C1AFB1AE87DT0000000000100000001", "errorCode": "0", "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001", "type": "file" }
Example 2
The following example moves the specified file to the specified destination. The example uses a public link ID because this file is under a folder structure not owned by or shared with the current user.
POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move
Request Header
LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Request Body
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518" }
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518", "errorCode": "0", "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001", "type": "file" }
Example 3
The following example moves the specified file to the specified destination. 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.
POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move
Request Header
LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518 Cookie: dAccessCode-LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518=test12345
Request Body
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518" }
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518", "errorCode": "0", "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001", "type": "file" }
Example 4
The following example requests moving the specified file to the specified destination. Because this file is under a folder structure not owned by or shared with the current user, an access denied error message is returned.
POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move
Request Header
None.
Request Body
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518" }
HTTP Status Code
HTTP_STATUS = 403
JSON Response
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518", "errorCode": "-20", "errorKey": "!csFldUnableToMoveItems!csCloudItemInsufficientPrivileges,User BB,fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001,FLD_MOVE", "errorMessage": "Unable to move items. User 'User BB' has insufficient privilege to access fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001 with service FLD_MOVE.", "errorType": "file", "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001", "title": "Unable to move items. User 'User BB' has insufficient privilege to access fFileGUID:D4018B1EF3AC07D0A349DB8DT0000000000100000001 with service FLD_MOVE.", "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html" }
Example 5
The following example requests moving the specified file to the specified destination. 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.
POST .../files/D4018B1EF3AC07D0A349DB8DT0000000000100000001/move
Request Header
LinkID: LF8D36FAFAB4388BECEAC4AEB5D17B95F47087F4E518
Request Body
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518" }
HTTP Status Code
HTTP_STATUS = 403
JSON Response
{ "destinationID": "FBB72C3E28BBD1A7BCB264E1B5D17B95F47087F4E518", "errorCode": "-18", "errorKey": "!csFldUnableToMoveItems!csAccessCodeRequiredForLinkAccess", "errorMessage": "Unable to move items. The access code must be provided to access the link.", "errorType": "file", "idList": "D4018B1EF3AC07D0A349DB8DT0000000000100000001", "title": "Unable to move items. 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 moves the specified file to the specified destination. 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.
POST .../files/DABECC242E4FDCFB90C80FFBB5D17B95F47087F4E518/move
Request Header
appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg== accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ
Request Body
{ "destinationID": "FD1897615847AA802783B996B5D17B95F47087F4E518" }
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "destinationID": "FD1897615847AA802783B996B5D17B95F47087F4E518", "errorCode": "0", "idList": "DABECC242E4FDCFB90C80FFBB5D17B95F47087F4E518", "type": "file" }