Move to a folder

PUT /api/2.0/files/fileops/move

Request

Moves all the selected files and folders to the folder with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json, text/json, text/plain.
Content-Typeenum of string: Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for copying/moving files

folderIdsarray of any of

List of folder IDs

.integer
.string

fileIdsarray of any of

List of file IDs

.integer
.string

destFolderIdone of

Destination folder ID

.integer
.string

conflictResolveTypeone of

.enum of string

[Skip - Skip, Overwrite - Overwrite, Duplicate - Duplicate]

Can be one of: Skip, Overwrite, Duplicate.

.enum of integer

[0 - Skip, 1 - Overwrite, 2 - Duplicate]

Can be one of: 0, 1, 2.

deleteAfterboolean

Specifies whether to delete a folder after the editing session is finished or not

contentboolean

Content

Examples

PUT /api/2.0/files/fileops/move HTTP/1.1
Accept: application/json
Content-Length: 44
Content-Type: application/json
Host: example.com

{
  "deleteAfter": true,
  "content": true
}

curl --request PUT \
  --url https://example.com/api/2.0/files/fileops/move \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "deleteAfter": true,
  "content": true
}'

Responses

200

List of file operations

idstring

Operation ID

Operationone of

.enum of string

[Move - Move, Copy - Copy, Delete - Delete, Download - Download, MarkAsRead - MarkAsRead, Import - Import, Convert - Convert, Duplicate - Duplicate]

Can be one of: Move, Copy, Delete, Download, MarkAsRead, Import, Convert, Duplicate.

.enum of integer

[0 - Move, 1 - Copy, 2 - Delete, 3 - Download, 4 - MarkAsRead, 5 - Import, 6 - Convert, 7 - Duplicate]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7.

progressintegerformat: int32

Operation progress

errorstring

Error

processedstring

Processing status

finishedboolean

Specifies if the operation is finished or not

urlstringformat: uri

URL

filesarray of object

List of files

titlestring

Title

accessone of

.enum of string

[None - None, ReadWrite - Read and write, Read - Read, Restrict - Restrict, Varies - Varies, Review - Review, Comment - Comment, FillForms - Fill forms, CustomFilter - Custom filter, RoomManager - Room manager, Editing - Editing, ContentCreator - Content creator]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

Specifies if the file is shared or not

createdobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

updatedobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

autoDeleteobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

rootFolderTypeone of

.enum of string

[DEFAULT - Default, COMMON - Coomon, BUNCH - Bunch, TRASH - Trash, USER - User, SHARE - Share, Projects - Projects, Favorites - Favourites, Recent - Recent, Templates - Templates, Privacy - Privacy, VirtualRooms - Virtual rooms, FillingFormsRoom - Filling forms room, EditingRoom - Editing room, CustomRoom - Custom room, Archive - Archive, ThirdpartyBackup - Thirdparty backup, PublicRoom - Public room, ReadyFormFolder - Ready form folder, InProcessFormFolder - In process form folder, FormFillingFolderDone - Form filling folder done, FormFillingFolderInProgress - Form filling folder in progress, VirtualDataRoom - Virtual Data Room]

Can be one of: DEFAULT, COMMON, BUNCH, TRASH, USER, SHARE, Projects, Favorites, Recent, Templates, Privacy, VirtualRooms, FillingFormsRoom, EditingRoom, CustomRoom, Archive, ThirdpartyBackup, PublicRoom, ReadyFormFolder, InProcessFormFolder, FormFillingFolderDone, FormFillingFolderInProgress, VirtualDataRoom.

.enum of integer

[0 - Default, 1 - Coomon, 2 - Bunch, 3 - Trash, 5 - User, 6 - Share, 8 - Projects, 10 - Favourites, 11 - Recent, 12 - Templates, 13 - Privacy, 14 - Virtual rooms, 15 - Filling forms room, 16 - Editing room, 19 - Custom room, 20 - Archive, 21 - Thirdparty backup, 22 - Public room, 25 - Ready form folder, 26 - In process form folder, 27 - Form filling folder done, 28 - Form filling folder in progress, 29 - Virtual Data Room]

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

updatedByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

providerItemboolean

Provider is specified or not

providerKeystring

Provider key

providerIdintegerformat: int32

Provider ID

orderstring

Order

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

foldersarray of object

List of folders

titlestring

Title

accessone of

.enum of string

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter, RoomManager, Editing, ContentCreator.

.enum of integer

[0 - None, 1 - Read and write, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - Fill forms, 8 - Custom filter, 9 - Room manager, 10 - Editing, 11 - Content creator]

Can be one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.

sharedboolean

Specifies if the file is shared or not

createdobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

createdByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

updatedobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

autoDeleteobject

utcTimestringformat: date-time: UtcTime
timeZoneOffsetstringformat: date-span: TimeZoneOffset

rootFolderTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

parentRoomTypeone of

.enum of string

.enum of integer

Can be one of: 0, 1, 2, 3, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 25, 26, 27, 28, 29.

updatedByobject

idstringformat: uuid: ID
displayNamestring: Display name
titlestring: Title
avatarstring: Avatar
avatarOriginalstring: Original size avatar
avatarMaxstring: Maximum size avatar
avatarMediumstring: Medium size avatar
avatarSmallstring: Small avatar
profileUrlstring: Profile URL
hasAvatarboolean: Specifies if the user has an avatar or not
isAnonimboolean: Specifies if the user is an anonim or not

providerItemboolean

Provider is specified or not

providerKeystring

Provider key

providerIdintegerformat: int32

Provider ID

orderstring

Order

fileEntryTypeenum of integerformat: int32

Can be one of: 1, 2.

401

Unauthorized

403

You don't have enough permission to move

Get Help

If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).

Move to a folder

Request

Authorization

Headers

Body

Examples

Responses

200

401

403

Results

Get Help