Getting SharePoint Data by Repository and Site ID

In this article

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

    Request

    GET https://<hostname>:4443/v5/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 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 contains the following information:

    Property

    Type

    Description

    id

    string

    Specifies the ID of a backup repository.

    title

    string

    Specifies the title of a backed-up Microsoft SharePoint site.

    url

    string

    Specifies the URL for the backed-up Microsoft SharePoint site.

    organizationId

    string

    Specifies the ID of a backed-up organization.

    Examples

    Example 1

    The example returns a resource representation of the backed-up Microsoft SharePoint site data with the ID 4a971c63-7012-4610-8265-9f4775c7d16e8507931c-4561-4ddf-bc90-411aba44bb39.

    Request:

    GET https://abc.tech.local:4443/v5/BackupRepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/SiteData/4a971c63-7012-4610-8265-9f4775c7d16e8507931c-4561-4ddf-bc90-411aba44bb39

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

     {

     "id": "4a971c63-7012-4610-8265-9f4775c7d16e8507931c-4561-4ddf-bc90-411aba44bb39",

     "title": "Research",

     "url": "http://research",

     "organizationId": ":00000000-0000-0000-0000-000000000000:f56a5126-37b5-40eb-ba09-7ad7600b9afc",

     "_links": {

       "self": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41/sitedata/4a971c63-7012-4610-8265-9f4775c7d16e8507931c-4561-4ddf-bc90-411aba44bb39"

       },

       "organization": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41/organizationdata/:00000000-0000-0000-0000-000000000000:f56a5126-37b5-40eb-ba09-7ad7600b9afc"

       },

       "backupRepository": {

         "href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41"

       }

     }

    }