REST API - get

appliance recovery restore job: get

See restore job progress/result.

Request:

HTTP request

GET https://{server}/rest/appliance/recovery/restore/job

No request parameters

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "progress": 1,
        "state": "FAILED"
    }
}

Response Type:

Name	Type	Description
bold = required
value	restore_job_status	RestoreJobStatus Structure.
value.state	string	process state Defines state of backup/restore process Value is one of: FAILED: Failed INPROGRESS: In progress NONE: Not started SUCCEEDED: Completed successfully
value.messages	localizable_message[]	list of messages
value.messages[].id	string	id in message bundle
value.messages[].default_message	string	text in english
value.messages[].args	string[]	nested data
value.progress	long	percentage complete

Errors:

HTTP Status Code	Type	Description
500	error	Generic error