Migrates
POST /api/2.0/migration/migrate
Request
Migrates
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
- Content-Type
enum of string
Can be one of:
application/json
,application/*+json
,text/json
.
Body
- migratorName
string
- operation
string
- failedArchives
array of string
- users
array of object
- shouldImport
boolean
- key
string
- email
string
email - displayName
string
- firstName
string
- lastName
string
- userType
one 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
.
- migratingFiles
object
- foldersCount
integer
int32 - filesCount
integer
int32 - bytesTotal
integer
int64
- withoutEmailUsers
array of object
- shouldImport
boolean
- key
string
- email
string
email - displayName
string
- firstName
string
- lastName
string
- userType
one 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
.
- migratingFiles
object
- foldersCount
integer
int32 - filesCount
integer
int32 - bytesTotal
integer
int64
- existUsers
array of object
- shouldImport
boolean
- key
string
- email
string
email - displayName
string
- firstName
string
- lastName
string
- userType
one 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
.
- migratingFiles
object
- foldersCount
integer
int32 - filesCount
integer
int32 - bytesTotal
integer
int64
- groups
array of object
- shouldImport
boolean
- groupName
string
- moduleName
string
- userUidList
array of string
- importPersonalFiles
boolean
- importSharedFiles
boolean
- importSharedFolders
boolean
- importCommonFiles
boolean
- importProjectFiles
boolean
- importGroups
boolean
- successedUsers
integer
int32 - failedUsers
integer
int32 - files
array of string
- errors
array of string
Examples
POST /api/2.0/migration/migrate HTTP/1.1
Content-Length: 1762
Content-Type: application/json
Host: example.com
{
"migratorName": "some text",
"operation": "some text",
"failedArchives": [
"some text"
],
"users": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"withoutEmailUsers": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"existUsers": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"groups": [
{
"value": {
"shouldImport": true,
"groupName": "some text",
"moduleName": "some text",
"userUidList": [
"some text"
]
}
}
],
"importPersonalFiles": true,
"importSharedFiles": true,
"importSharedFolders": true,
"importCommonFiles": true,
"importProjectFiles": true,
"importGroups": true,
"successedUsers": 1234,
"failedUsers": 1234,
"files": [
"some text"
],
"errors": [
"some text"
]
}
curl --request POST \
--url https://example.com/api/2.0/migration/migrate \
--header 'Content-Type: application/json' \
--data '{
"migratorName": "some text",
"operation": "some text",
"failedArchives": [
"some text"
],
"users": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"withoutEmailUsers": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"existUsers": [
{
"value": {
"shouldImport": true,
"key": "some text",
"email": "Raymundo72@hotmail.com",
"displayName": "some text",
"firstName": "Rico",
"lastName": "Towne",
"migratingFiles": {
"foldersCount": 1234,
"filesCount": 1234,
"bytesTotal": 1234
}
}
}
],
"groups": [
{
"value": {
"shouldImport": true,
"groupName": "some text",
"moduleName": "some text",
"userUidList": [
"some text"
]
}
}
],
"importPersonalFiles": true,
"importSharedFiles": true,
"importSharedFolders": true,
"importCommonFiles": true,
"importProjectFiles": true,
"importGroups": true,
"successedUsers": 1234,
"failedUsers": 1234,
"files": [
"some text"
],
"errors": [
"some text"
]
}'
Responses
200
Ok
401
Unauthorized
403
No permissions to perform this action