Getting Sites

You can get a resource representation of sites whose backed-up data was retrieved from an archive by a retrieval job with the specified ID.

Request

GET https://<hostname>:4443/v6/DataRetrievals/{dataRetrievalId}/webs

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}/webs resource. The response body contains the following properties:

Property

Type

Description

siteId

string

Specifies the site collection ID.

webId

string

Specifies the SharePoint site ID.

title

string

Specifies the SharePoint site title.

url

string

Specifies the SharePoint site path.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example returns a resource representation of sites whose backed-up data was retrieved from an archive by the retrieval job with the ID 544f4727-2109-41ac-b907-cb5a447bd810.

Request:

GET https://abc.tech.local:4443/v6/DataRetrievals/544f4727-2109-41ac-b907-cb5a447bd810/webs

 

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "siteId": "c9d5c495-7437-461f-8040-6a20960d1fe4",

   "webId": "3a8f02b1-4f00-4123-9067-3fb7e71177b4",

   "title": "User Site 1",

   "url": "https://abc-my.sharepoint.com/personal/user1_abc_onmicrosoft_com",

   "_links": {

     "dataRetrieval": {

       "href": "/v6/dataRetrievals/544f4727-2109-41ac-b907-cb5a447bd810"

     }

   }

 },

 {

   "siteId": "f8956d6b-73b3-4ce2-bca7-66896490de77",

   "webId": "70e7bee3-08ea-48ac-ba1a-16863f06e1e2",

   "title": "User Site 2",

   "url": "https://abc-my.sharepoint.com/personal/user2_abc_onmicrosoft_com",

   "_links": {

     "dataRetrieval": {

       "href": "/v6/dataRetrievals/544f4727-2109-41ac-b907-cb5a447bd810"

     }

   }

 },

 {

   "siteId": "da1899a5-340c-486e-a65d-1d76a2a66655",

   "webId": "155a400d-a8c6-4455-ba1a-0e693b011466",

   "title": "User Site 3",

   "url": "https://abc-my.sharepoint.com/personal/user3_abc_onmicrosoft_com",

   "_links": {

     "dataRetrieval": {

       "href": "/v6/dataRetrievals/544f4727-2109-41ac-b907-cb5a447bd810"

     }

   }

 }

]