(POST) /Organization/Action
Starts a restore session for exploring and performing restore operations with the authorized organization backups.
Request
To start a restore session, send the POST HTTPS request to the URL of the /Organization/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v3/Organization/Action |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
To start a restore session, the request body must contain the explore action property:
Property | Type | Description |
Datetime | UTC | Specifies the date and time. You can specify the date and the time in one of the following formats:
For example, "datetime": "2019-04-12T10:54:40.2794046Z". |
Type | sessionType | Specifies the type of the restore session to start:
For example, "type": "vex". |
ShowDeleted | bool | Specifies the restore session will show the deleted items. For example, "showDeleted": "true". |
ShowAllVersions | bool | Specifies the restore session will show all versions of the restored items. For example, "showAllVersions": "true". |
The request command will start a restore session only for backups that were created at the time you specified. The firstBackuptime and lastBackuptime properties of the /Organization resource inform you when the organization's data was backed up for the first time and the last time.
Mind the following:
- If you specify the point in time which precedes the first time the organization was backed up, the restore session will be created with no backup data for explore or restore.
- If you specify the point in time which exceeds the last time the organization was backed up, the restore session will be created with backup data as of the latest restore point.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 201 Created.
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 request body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a representation of the /Organization/Action resource.
Example
Request: POST https://support.east.local:4443/v3/Organization/Action
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "explore": {"datetime": "2019-04-12T10:54:40.2794046Z", "type": "vex"} }
Response: 200 OK |