Getting Mailbox Folders
This section explains how to get a resource representation of an organization's mailbox folder with a specified ID.
Request
GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Folders/{folderId} |
Request Headers
The request header must contain an authorization token of the current session.
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
Property | Type | Description |
---|---|---|
Id | string | Specifies the ID of the organization's backed-up mailbox folder. |
Name | string | Specifies the name of the organization's backed-up mailbox folder. |
Type | string | Specifies the type of the organization's backed-up mailbox folder:
|
Description | string | Specifies the description of the organization's backed-up mailbox folder. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The following request returns an entity representation of the organization's mailbox folder with ID AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==.
Request: GET https://abc.tech.local:4443/v5/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "name": "Support Contacts", "type": "Contact", "description": "", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==" }, "children": { "href": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==" }, "items": { "href": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==" }, "mailbox": { "href": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c" } }, "_actions": { "restoretoOriginallocation": { "uri": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action", "method": "POST" }, "restoreTo": { "uri": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action", "method": "POST" }, "exporttoPst": { "uri": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action", "method": "POST" }, "search": { "uri": "https://abc.tech.local:4443/v5/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action", "method": "POST" } }, "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==" } |