startReassign
TaskProgressResponseWrapper startReassign(StartReassignRequestDto)
POST /api/2.0/people/reassign/start
Start the data reassignment
Queues an asynchronous job that transfers the rooms and the shared files owned by one portal user to another. The source user must already have the Terminated status - disable the account through PUT api/2.0/people/status/{status} before calling this - and the destination user must be an active room admin or DocSpace admin, so a guest, a system account or a disabled account is rejected. The caller needs the permission to edit users, cannot reassign their own data, and must be the portal owner to reassign the data of another DocSpace administrator or of a People module administrator. The transfer does not finish within this call: poll GET api/2.0/people/reassign/progress/{userId} with the source user ID until isCompleted is true, and cancel it through PUT api/2.0/people/reassign/terminate. Pass deleteProfile as true to delete the source profile once the transfer succeeds, otherwise the emptied profile is kept. Use GET api/2.0/people/reassign/necessary first to find out whether the user owns anything that has to be reassigned at all.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| StartReassignRequestDto | body | StartReassignRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The state of the queued reassignment | TaskProgressResponseWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no fromUserId or toUserId, the destination user does not exist or is not an active room or DocSpace admin, or the source user does not exist, is a system account, the portal owner, the caller, is not disabled, or is a DocSpace or People administrator while the caller is not the portal owner | - | - |
| 403 | No permissions to perform this action | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json