Getting Retrieval Jobs
You can get a list of configured retrieval jobs.
Request
GET https://<hostname>:4443/v6/DataRetrievals?organizationId=<string>&repositoryId=<string>&dataState=<string> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following optional parameters can 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. |
repositoryId | string | Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories. |
dataState | string | Specifies the status of the archived data. The following values are available:
|
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 /DataRetrievals collection resource.
Example
The example returns a list of configured retrieval jobs.
Request: GET https://abc.tech.local:4443/v6/DataRetrievals
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "name": "Exchange data retrieval", "description": "", "storageType": "AmazonS3Glacier", "amazonS3GlacierRetrievalPolicy": "Standard", "id": "fbcced10-80c5-49f4-a221-a007729a1a2c", "pointInTime": "2022-01-27T12:11:53.5279706Z", "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b", "organizationUniqueId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6", "repositoryId": "79f3e494-4991-4dd5-b6fa-f1cf8c421265", "dataState": "Retrieving", "lastStatus": "Running", "startTime": "2022-01-27T13:09:30.1598631Z", "enableExpirationNotification": true, "expirationHoursThreshold": 1, "type": "Exchange", "showDeleted": true, "showAllVersions": true, "_links": { "self": { "href": "v6/dataRetrievals/fbcced10-80c5-49f4-a221-a007729a1a2c" }, "organization": { "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b" }, "proxy": { "href": "v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6" }, "backupRepository": { "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265" }, "mailboxes": { "href": "v6/dataRetrievals/fbcced10-80c5-49f4-a221-a007729a1a2c/mailboxes" } }, "_actions": { "update": { "uri": "v6/dataRetrievals/fbcced10-80c5-49f4-a221-a007729a1a2c", "method": "PUT" } } }, { "name": "SharePoint data retrieval", "description": "", "storageType": "AzureArchive", "id": "b75d54e8-4c0b-45ab-90ef-a64e2411e1ee", "pointInTime": "2022-01-24T12:38:20.947749Z", "organizationId": "e60dfb9c-ac58-4463-879f-9855ac35576b", "organizationUniqueId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", "proxyId": "89e8c35e-6c73-4f46-a37d-b365e513f7c6", "repositoryId": "f93dc1b5-5ecd-45ce-b4dd-5519160b6713", "dataState": "Retrieving", "lastStatus": "Running", "startTime": "2022-01-27T13:36:18.6775319Z", "enableExpirationNotification": true, "expirationHoursThreshold": 1, "type": "SharePoint", "showDeleted": true, "showAllVersions": true, "_links": { "self": { "href": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee" }, "organization": { "href": "v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b" }, "proxy": { "href": "v6/proxies/89e8c35e-6c73-4f46-a37d-b365e513f7c6" }, "backupRepository": { "href": "v6/backuprepositories/f93dc1b5-5ecd-45ce-b4dd-5519160b6713" }, "sites": { "href": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee/sites" } }, "_actions": { "update": { "uri": "v6/dataRetrievals/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee", "method": "PUT" } }, "azureArchiveRetrievalPolicy": "HighPriority" } ] |