Gets migration status

GET /api/2.0/migration/status

Request

Gets migration status

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.

Examples

GET /api/2.0/migration/status HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/migration/status \
  --header 'Accept: application/json'

Responses

200

Ok

progressnumberformat: double

Migration progress

errorstring

Migration error

parseResultobject

migratorNamestring

operationstring

failedArchivesarray of string

usersarray of object

shouldImportboolean

keystring

emailstringformat: email

displayNamestring

firstNamestring

lastNamestring

userTypeone of

.enum of string

[All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]

Can be one of: All, RoomAdmin, Guest, DocSpaceAdmin, User.

.enum of integer

[0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]

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

migratingFilesobject

foldersCountintegerformat: int32

filesCountintegerformat: int32

bytesTotalintegerformat: int64

withoutEmailUsersarray of object

shouldImportboolean

keystring

emailstringformat: email

displayNamestring

firstNamestring

lastNamestring

userTypeone of

.enum of string

[All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]

Can be one of: All, RoomAdmin, Guest, DocSpaceAdmin, User.

.enum of integer

[0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]

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

migratingFilesobject

foldersCountintegerformat: int32

filesCountintegerformat: int32

bytesTotalintegerformat: int64

existUsersarray of object

shouldImportboolean

keystring

emailstringformat: email

displayNamestring

firstNamestring

lastNamestring

userTypeone of

.enum of string

[All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]

Can be one of: All, RoomAdmin, Guest, DocSpaceAdmin, User.

.enum of integer

[0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]

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

migratingFilesobject

foldersCountintegerformat: int32

filesCountintegerformat: int32

bytesTotalintegerformat: int64

groupsarray of object

shouldImportboolean

groupNamestring

moduleNamestring

userUidListarray of string

importPersonalFilesboolean

importSharedFilesboolean

importSharedFoldersboolean

importCommonFilesboolean

importProjectFilesboolean

importGroupsboolean

successedUsersintegerformat: int32

failedUsersintegerformat: int32

filesarray of string

errorsarray of string

isCompletedboolean

Specifies whether the migration is completed

401

Unauthorized

403

No permissions to perform this action