GET /jobs/{jobId}/
FROM API REVISION 6.0
This resource will allow you to get the information about the selected Job.
A job progress can be cancelled. ([More info](http://eclypseapi.distech-controls.com/restApi/jobs/resources/1114/POST "Cancel progress documentation"))
A job is not running when the progress is done, or the job has been cancelled.
The example below will show a M-Bus devices 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.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> 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.
The Content-Length entity-header field indicates the size of the entity-body.
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 progress of the job. It starts at 0 and finish at 100. |
GET |
| Type | String | This is the type of the current job. Here is the possible type : - BACKUP - REMOTE_DEVICES - MBUS_DEVICES - MBUS_POINTS - REMOTE_DEVICE_OBJECTS |
GET |
| Cancelable | Boolean | Indicate if the job can be cancelled. | GET |
| Running | Boolean | Indicate if the job is currently running. When the job is running, the progress continue to evolve. The job stop running when the job is cancelled or finished. |
GET |
| CustomObject | Object | This is a custom object, proper to the type of job. - BACKUP \u0026rarr; backupDiscovery - REMOTE_DEVICES \u0026rarr; remoteDevicesDiscovery - MBUS_DEVICES \u0026rarr; mbusDevicesDiscovery - MBUS_POINTS \u0026rarr; mbusPointsDiscovery - REMOTE_DEVICE_OBJECTS \u0026rarr; remoteDeviceObjectsDiscovery |
GET |
URL Example: https://0.0.0.0/api/rest/v1/jobs/8dc2e127-5bba-496d-b135-987afcf1a8d1
{
"progress": 15,
"cancelable": true,
"mbusDevicesDiscovery": {},
"type": "MBUS_DEVICES",
"running": true
}
URL Example: https://0.0.0.0/api/rest/v1/jobs/8dc2e127-5bba-496d-b135-987afcf1a8d1
<?xml version="1.0" encoding="utf-8"?>
<Job>
<Progress>15</Progress>
<Type>MBUS_DEVICES</Type>
<Cancelable>true</Cancelable>
<Running>true</Running>
<MbusDevicesDiscovery />
</Job>