Get status

You can get the status of an ongoing operation.

Permissions

One of the following permissions is required to call this application programming interface (API). For more information about permissions and how to select them, see Authentication.

Permission type Permissions (from least privileged to most privileged)
Delegated (work or school account) user_impersonation

HTTP request

GET /databasemovement/v1/fetchstatus/project/{projectId}/environment/{environmentId}/operationactivity/{operationactivityId}

Request headers

Header Value
Authorization Bearer {token} (required)
'x-ms-version' '2017-09-15' (required)
Content-Type application/json

Request body

Don't supply a request body for this method.

Response

The response is always a 200 OK response, unless you aren't correctly authenticated. Be sure to use the IsSuccess property to evaluate the success or failure of the action.

Example

GET /databasemovement/v1/fetchstatus/project/12345/environment/5362377c-bc37-4f92-b30e-fe0c1e664cc0/operationactivity/55eb4327-9346-4c7b-82bd-fe8ef15112c6
{
    "IsSuccess": true,
    "OperationActivityId": "6a90b45f-1764-4077-b924-3f4671540237",
    "ErrorMessage": null,
    "VersionEOL": "9999-12-31T23:59:59.9999999",
    "ProjectId": 12345,
    "EnvironmentId": "5362377c-bc37-4f92-b30e-fe0c1e664cc0",
    "ActivityId": "55eb4327-9346-4c7b-82bd-fe8ef15112c6",
    "CompletionDate": null,
    "OperationStatus": "InProgress"
}

OperationStatus property

Status Description
NotStarted The action hasn't yet been started.
InProgress The action is in progress.
Completed The action was successfully completed.
Failed The action was halted.
SignedOff The action was successfully completed and signed off.
Aborted The action was canceled without automated cleanup.
RollbackInProgress Reversal of the action is in progress.
RollbackFailed Reversal of the action was halted.
RollbackCompleted Reversal of the action was successfully completed.