Getting Backup Jobs
This section explains how to get a resource representation of all backup jobs configured for the organization with the specified ID.
Request
GET https://<hostname>:4443/v5/Organizations/{organizationId}/Jobs |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Type | Description |
|---|---|---|
organizationId | string | An identification number of the organization. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a representation of the /Organizations/{organizationId}/Jobs resource.
Example
Request: GET https://abc.tech.local:4443/v5/Organizations/a21a5622-7fb2-49ec-b2b2-393da59fbed2/Jobs
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK [ { "id": "e1714f5b-e51b-496f-9e46-e7bf979aa6d6", "name": "test_job", "description": "", "lastRun": "2017-06-06T15:18:22.6664413Z", "nextRun": "2017-06-13T15:00:00Z", "isEnabled": true, "backupType": "SelectedItems", "lastStatus": "Success", "schedulePolicy": { "backupWindowEnabled": true, "backupWindowSettings": { "backupWindow": [ true, true, true, .. true ], "minuteOffset": 0 }, "type": "Daily", "dailyType": "Wednesday", "dailyTime": "08:00:00", "retryEnabled": true, "retryNumber": 3, "retryWaitInterval": 10 }, "_links": { "self": { "href": "https://abc.tech.local:4443/v5/jobs/e1714f4b-e51b-496b-9e46-e7bf979aa6d6" }, "organization": { "href": "https://abc.tech.local:4443/v5/organizations/a21a5622-7fb2-49ec-b2b2-393da59fbed2" }, "backupRepository": { "href": "https://abc.tech.local:4443/v5/backuprepositories/83346d9a-d448-497e-b524-ab5ec782b607" }, "jobsessions": { "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-495b-9e46-e7bf979aa6d6/jobsessions" }, "excludedItems": { "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-497b-9e46-e7bf979aa6d6/excludedItems" }, "selectedItems": { "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-497b-9e46-e7bf979aa6d6/selectedItems" } } }, { "id": "9ee03a1c-5b10-447a-90ce-1369bfb7423e", "name": "test_job-2", "description": "", "lastRun": "2017-06-06T15:44:00.8634945Z", "nextRun": "2017-06-07T22:00:00Z", "isEnabled": true, "backupType": "SelectedItems", "lastStatus": "Success", "schedulePolicy": { "backupWindowEnabled": false, "type": "Daily", "dailyType": "Thursday", "dailyTime": "15:00:00", "retryEnabled": true, "retryNumber": 3, "retryWaitInterval": 10 }, "_links": { "self": { "href": "https://abc.tech.local:4443/v5/jobs/9ee03a1c-5b10-437a-90ce-1369bfb7123e" }, "organization": { "href": "https://abc.tech.local:4443/v5/organizations/ae1a5622-7fb2-49ec-b2b2-393da59fbed2" }, "backupRepository": { "href": "https://abc.tech.local:4443/v5/backuprepositories/81846d9a-d448-497e-b524-ab5ec782b607" }, "jobsessions": { "href": "https://abc.tech.local:4443/v5/jobs/9ee03a1c-5b10-467a-90ce-1369bfb7123e/jobsessions" }, "excludedItems": { "href": "https://abc.tech.local:4443/v5/jobs/9ee03a1c-5b18-447a-90ce-1369bfb7123e/excludedItems" }, "selectedItems": { "href": "https://abc.tech.local:4443/v5/jobs/9ee03a1c-5b18-447a-90ce-1369bfb7123e/selectedItems" } } } ] |
