Getting Backup Jobs
You can get a resource representation of all backup jobs configured for an organization with the specified ID.
Request
GET https://<hostname>:4443/v6/Organizations/{organizationId}/Jobs |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
organizationId | string | Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations. |
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 resource representation of the /Organizations/{organizationId}/Jobs collection resource.
Example
The example returns a list of configured backup jobs for the organization with the ID e60dfb9c-ac58-4463-879f-9855ac35576b.
Request: GET https://abc.tech.local:4443/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/Jobs
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "description": "", "backupType": "SelectedItems", "schedulePolicy": { "scheduleEnabled": true, "backupWindowEnabled": true, "backupWindowSettings": { "backupWindow": [ true, true, true, true, ... true, true, true, true, true ], "minuteOffset": 0 }, "periodicallyWindowSettings": { "backupWindow": [ false, false, true, ... true, true, true, true ], "minuteOffset": 0 }, "periodicallyOffsetMinutes": 5, "type": "Periodically", "periodicallyEvery": "Hours2", "retryEnabled": true, "retryNumber": 3, "retryWaitInterval": 10 }, "id": "b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504", "repositoryId": "5f7c94d0-c339-46f1-9b0f-2b9763ba83de", "name": "Backup1", "lastRun": "2022-01-25T12:43:18.3492858Z", "nextRun": "2022-01-25T14:05:00Z", "isEnabled": true, "lastStatus": "Success", "_links": { "self": { "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504" }, "copyJob": { "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/copyJob" }, "organization": { "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b" }, "backupRepository": { "href": "v6/backuprepositories/5f7c94d0-c339-46f1-9b0f-2b9763ba83de" }, "jobsessions": { "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/jobsessions" }, "excludedItems": { "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/excludedItems" }, "selectedItems": { "href": "v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504/selectedItems" } } }, { "description": "", "backupType": "SelectedItems", "schedulePolicy": { "scheduleEnabled": false, "backupWindowEnabled": false, "retryEnabled": false }, "id": "50f5eff0-9575-451d-8712-ed6439be9b34", "repositoryId": "5f7c94d0-c339-46f1-9b0f-2b9763ba83de", "name": "Backup2", "lastRun": "2022-01-21T22:38:43.1027034Z", "isEnabled": true, "lastStatus": "Stopped", "_links": { "self": { "href": "v6/jobs/50f5eff0-9575-451d-8712-ed6439be9b34" }, "copyJob": { "href": "v6/jobs/50f5eff0-9575-451d-8712-ed6439be9b34/copyJob" }, "organization": { "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b" }, "backupRepository": { "href": "v6/backuprepositories/5f7c94d0-c339-46f1-9b0f-2b9763ba83de" }, "jobsessions": { "href": "v6/jobs/50f5eff0-9575-451d-8712-ed6439be9b34/jobsessions" }, "excludedItems": { "href": "v6/jobs/50f5eff0-9575-451d-8712-ed6439be9b34/excludedItems" }, "selectedItems": { "href": "v6/jobs/50f5eff0-9575-451d-8712-ed6439be9b34/selectedItems" } } } ] |