Get the deletion progress

GET /api/2.0/people/remove/progress/{userid}

Request

Returns the progress of the started data deletion for the user 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.

Path

useridstringformat: uuidrequired

User ID whose data is reassigned

Examples

GET /api/2.0/people/remove/progress/0e69f83e-9337-4940-9812-d81b26393234 HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/people/remove/progress/0e69f83e-9337-4940-9812-d81b26393234 \
  --header 'Accept: application/json'

Responses

200

Deletion progress

idstring

ID

errorstring

Error

percentageintegerformat: int32

Percentage

isCompletedboolean

IsCompleted

statusone of
.enum of string

[Created - Created, Running - Running, Completed - Completed, Canceled - Canceled, Failted - Failted]

Can be one of: Created, Running, Completed, Canceled, Failted.

.enum of integer

[0 - Created, 1 - Running, 2 - Completed, 3 - Canceled, 4 - Failted]

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

401

Unauthorized

403

Forbidden

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