Getting SharePoint Data by Repository and Site ID

In this article

    You can get a backed-up or archived SharePoint site with the specified ID whose data is stored in a backup repository with the specified ID.

    Request

    GET https://<hostname>:4443/v6/BackupRepositories/{repositoryId}/SiteData/{siteId}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    repositoryId

    string

    Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

    siteId

    string

    Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Getting SharePoint Data by Repository ID or Getting Microsoft SharePoint Sites.

    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 SharePoint site ID.

    title

    string

    Specifies the SharePoint site title.

    url

    string

    Specifies the SharePoint site path.

    backedUpTime

    UTC

    Specifies date and time when the SharePoint site was backed up.

    organizationId

    string

    Specifies the backed-up organization ID.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a resource representation of the SharePoint site with the ID 2bba7ec6-4711-4ad8-8c43-335abee74d313a8f02b1-4f00-4123-9067-3fb7e71177b4.

    Request:

    GET https://abc.tech.local:4443/v6/BackupRepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/SiteData/2bba7ec6-4711-4ad8-8c43-335abee74d313a8f02b1-4f00-4123-9067-3fb7e71177b4

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "id": "2bba7ec6-4711-4ad8-8c43-335abee74d313a8f02b1-4f00-4123-9067-3fb7e71177b4",

     "title": "User 2",

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

     "backedUpTime": "2022-01-28T16:08:21.2654526Z",

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "_links": {

       "self": {

         "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/sitedata/2bba7ec6-4711-4ad8-8c43-335abee74d313a8f02b1-4f00-4123-9067-3fb7e71177b4"

       },

       "organization": {

         "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/organizationdata/abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

       },

       "backupRepository": {

         "href": "v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       }

     }

    }