This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Mailboxes
You can get a resource representation of mailboxes whose backed-up data was retrieved from an archive by a retrieval job with the specified ID.
Request
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 |
|---|---|---|
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 /DataRetrievals/{dataRetrievalId}/mailboxes resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
id | string | Specifies the mailbox ID. |
isArchive | boolean | If set to true, indicates that the mailbox is of the Archive type. |
displayName | string | Specifies a display name of the mailbox. |
string | Specifies the mailbox email. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of mailboxes whose backed-up data was retrieved from an archive by the retrieval job with the ID 8a76872b-7f2c-4c50-95f4-92c4d41bc47c.
Request: GET https://abc.tech.local:4443/v6/DataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c/mailboxes
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "id": "062bc84d-d627-4acb-8ecd-b7cfa20c998c", "displayName": "User 1", "email": "user1@abc.onmicrosoft.com", "isArchive": false, "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } }, { "id": "12b2aa88-cfc5-45ea-954e-942185522850", "displayName": "User 2", "email": "user2@abc.onmicrosoft.com", "isArchive": false, "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } }, { "id": "1f843344-28ba-4389-8346-a19a10123417", "displayName": "User 3", "email": "user3@abc.onmicrosoft.com", "isArchive": false, "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } }, { "id": "5af68459-e087-467b-bf12-7c597112a352", "displayName": "User 4", "email": "user4@abc.onmicrosoft.com", "isArchive": false, "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } }, { "id": "71e44907-3a62-4991-83ec-d32e73975ca5", "displayName": "User 5", "email": "user5@abc.onmicrosoft.com", "isArchive": false, "_links": { "dataRetrieval": { "href": "/v6/dataRetrievals/8a76872b-7f2c-4c50-95f4-92c4d41bc47c" } } } ] |
