Getting Data Retrieval Sessions
You can get a resource representation of a collection of all sessions created for retrieval jobs.
Request
GET https://<hostname>:4443/v6/DataRetrievalSessions?dataRetrievalId=<string> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following optional parameter can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
dataRetrievalId | string | Specifies the identification number of the retrieval job. For more information on how to get this parameter, see Getting Retrieval Jobs. |
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 /v6/DataRetrievalSessions collection resource.
Example
The example returns a resource representation of all data retrieval sessions.
Request: GET https://abc.tech.local:4443/v6/DataRetrievalSessions
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "_links": { "self": { "href": "/v6/DataRetrievalSessions?offset=0&limit=30" } }, "results": [ { "id": "42deec23-35eb-4692-8a4d-024b20873ea6", "name": "Teams data retrieval", "retrievalId": "97ea63e9-125d-44e4-aaed-182c46b2b2b5", "creationTime": "2022-01-28T21:03:52.2663895+01:00", "endTime": "2022-01-28T21:04:02.0599467+01:00", "progress": 0, "processedObjects": 30, "type": "Retrieve", "status": "Failed", "_links": { "self": { "href": "v6/dataRetrievalSessions/97ea63e9-125d-44e4-aaed-182c46b2b2b5" } } }, { "id": "430ed948-17f4-4922-afb1-28d6cab5b075", "name": "SharePoint data retrieval", "retrievalId": "544f4727-2109-41ac-b907-cb5a447bd810", "creationTime": "2022-01-28T20:54:34.7064449+01:00", "endTime": "2022-01-28T20:58:59.8036299+01:00", "progress": 7, "processedObjects": 86, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/544f4727-2109-41ac-b907-cb5a447bd810" } } }, { "id": "668f478c-0326-440a-8bdf-58cf39163ea2", "name": "Exchange data retrieval", "retrievalId": "8a76872b-7f2c-4c50-95f4-92c4d41bc47c", "creationTime": "2022-01-28T20:52:36.9177053+01:00", "endTime": "2022-01-28T20:56:17.7513457+01:00", "progress": 5, "processedObjects": 37, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } }, { "id": "23f4587c-3fc2-44d5-be64-976df515131a", "name": "OneDrive data retrieval", "retrievalId": "3136489d-4290-4e88-a013-d0f36f4ffe72", "creationTime": "2022-01-28T20:28:53.7931718+01:00", "endTime": "2022-01-28T20:31:31.3752046+01:00", "progress": 2, "processedObjects": 21, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/3136489d-4290-4e88-a013-d0f36f4ffe72" } } }, { "id": "17aaf3f1-d353-4e2d-a5f4-69d708d76868", "name": "Exchange data retrieval", "retrievalId": "fbcced10-80c5-49f4-a221-a007729a1a2c", "creationTime": "2022-01-27T14:09:32.9160212+01:00", "endTime": "2022-01-27T17:23:32.6725394+01:00", "progress": 4, "processedObjects": 16, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/fbcced10-80c5-49f4-a221-a007729a1a2c" } } }, { "id": "ae889d32-e393-4709-b2a2-416d1387a33d", "name": "SharePoint data retrieval", "retrievalId": "b75d54e8-4c0b-45ab-90ef-a64e2411e1ee", "creationTime": "2022-01-27T14:36:20.0156075+01:00", "endTime": "2022-01-27T15:27:58.5203093+01:00", "progress": 3, "processedObjects": 33, "type": "Retrieve", "status": "Success", "_links": { "self": { "href": "v6/dataRetrievalSessions/b75d54e8-4c0b-45ab-90ef-a64e2411e1ee" } } } ], "setId": "00000000-0000-0000-0000-000000000000" } |