Getting Organization Backups for Restore

You can get a resource representation of an organization database to explore and restore backups.

Request

GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization

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

restoreSessionId

string

Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore 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

The response body contains the following properties:

Property

Type

Description

id

string

Specifies the ID of the organization whose database is available to explore and restore during the restore session.

name

string

Specifies the name of the organization whose database is available to explore and restore during the restore session.

type

string

Specifies the organization type. The following types are available:

  • Office365
  • OnPremises
  • Hybrid

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of the organization database to explore and restore backup items.

Request:

GET https://abc.tech.local:4443/v6/RestoreSessions/bd2d7082-d59d-4cbb-b5df-dfd3060604d9/organization

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "id": "23fc1798-3dfe-4a06-8d66-adddb89b925a",

 "name": "abc.onmicrosoft.com (4/15/2022 9:54:37 AM)",

 "type": "Office365",

 "_links": {

   "self": {

     "href": "/v6/restoresessions/bd2d7082-d59d-4cbb-b5df-dfd3060604d9/organization"

   },

   "mailboxes": {

     "href": "/v6/restoresessions/bd2d7082-d59d-4cbb-b5df-dfd3060604d9/organization/mailboxes"

   }

 }

}