GET /system/backup/jobs/{JobId}/
FROM API REVISION 4.0
DEPRECATED
This resource allow you to see the details of the backup job progress.
A job ID looks like this 'c83b7cd2-e5df-4dcc-9e9e-301927c76a30'.
This job id is a unique value created when a backup creation is started.
This job contain the status of the backup creation and the creation progress.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
This is the id of the job.
When a job is created, this id is usually sent back to the response.
Object Name: Job
| Property Name | Type | Description | Method |
|---|---|---|---|
| Progress | Integer | This is the progression of the backup creation. The value will rise between 0 to 100 | GET |
| Status | String | This is the status of the backup. "OK" if it's a success, otherwise it fails. | GET |
URL Example: https://0.0.0.0/api/rest/v1/system/backup/jobs/a697b806-14b1-4c61-a9db-5e875f3982f3
{
"progress": 100,
"status": "OK"
}
URL Example: https://0.0.0.0/api/rest/v1/system/backup/jobs/a697b806-14b1-4c61-a9db-5e875f3982f3
<?xml version="1.0" encoding="utf-8"?>
<Job>
<Status>OK</Status>
<Progress>100</Progress>
</Job>