Getting Information on Operations by Session ID
You can get information about the operations performed during a data retrieval session with the specified ID.
Request
GET https://<hostname>:4443/v6/DataRetrievalSessions/{sessionId}/LogItems |
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 |
|---|---|---|
sessionId | string | Specifies the identification number of the data retrieval session. For more information on how to get this parameter, see Getting Data Retrieval Sessions. |
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 /DataRetrievalSessions/{sessionId}/LogItems collection resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies the ID of the operation performed during the retrieval job. |
usn | integer | Specifies the order number of the operation performed during the retrieval job. |
title | string | Specifies status and short description of the operation performed during the retrieval job. |
creationTime | UTC | Specifies date and time of the operation start. |
endTime | string | Specifies date and time of the operation end. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the operations that were performed during the specified data retrieval session.
Request: GET https://abc.tech.local:4443/v6/DataRetrievalSessions/668f478c-0326-440a-8bdf-58cf39163ea2/LogItems
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "_links": { "self": { "href": "/v6/DataRetrievalSessions/668f478c-0326-440a-8bdf-58cf39163ea2/LogItems?offset=0&limit=30" } }, "results": [ { "id": "d0463805-5eac-4de0-b38a-081799ded6f1", "usn": 1, "title": "[Success] Expedited data retrieval started at: 1/28/2022 8:52:36 PM", "creationTime": "2022-01-28T19:52:36.9287841Z", "endTime": "2022-01-28T19:52:36.9287841Z", "_links": { "self": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2/logitems/d0463805-5eac-4de0-b38a-081799ded6f1" }, "jobsessions": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2" } } }, { "id": "0cadea59-9320-4028-ab47-89b190a15f90", "usn": 2, "title": "[Success] Collecting object list for mailbox: user1@abc.onmicrosoft.com", "creationTime": "2022-01-28T19:52:36.9586995Z", "endTime": "2022-01-28T19:52:47.144286Z", "_links": { "self": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2/logitems/0cadea59-9320-4028-ab47-89b190a15f90" }, "jobsessions": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2" } } }, { "id": "b3ad11df-c2be-44d7-9ba7-2ad8b41b62b3", "usn": 3, "title": "[Success] Collecting object list for mailbox: user2@abc.onmicrosoft.com", "creationTime": "2022-01-28T19:52:36.9586995Z", "endTime": "2022-01-28T19:52:47.9683357Z", "_links": { "self": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2/logitems/b3ad11df-c2be-44d7-9ba7-2ad8b41b62b3" }, "jobsessions": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2" } } }, ... { "id": "150ae7b4-2852-4729-848e-1d2328bfd049", "usn": 23, "title": "[Success] Data retrieval finished at: 1/28/2022 8:56:17 PM", "creationTime": "2022-01-28T19:56:17.7503464Z", "endTime": "2022-01-28T19:56:17.7503464Z", "_links": { "self": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2/logitems/150ae7b4-2852-4729-848e-1d2328bfd049" }, "jobsessions": { "href": "v6/jobsessions/668f478c-0326-440a-8bdf-58cf39163ea2" } } } ], "setId": "00000000-0000-0000-0000-000000000000" } |