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-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

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

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

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).