Getting SharePoint Sites

In this article

    You can get a resource representation of a SharePoint site with the specified ID.

    Request

    GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Sites/{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

    restoreSessionId

    string

    Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

    siteId

    string

    Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Getting Organization 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 the backed-up SharePoint site.

    url

    string

    Specifies the URL address of the backed-up SharePoint site.

    name

    string

    Specifies the name of the backed-up SharePoint site.

    parent

    site

    Specifies the parent site.

    children

    object[]

    Specifies _links for the children objects.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    The following request returns a resource representation of a SharePoint site with the specified ID for exploring and performing restore operations.

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/Organization/Sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

       "id": "b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39",

       "name": "MySite",

       "url": "http://server/sites/mySite",

       "_links": {

        "self": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39"

        },

        "sites": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites?parentId=b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39"

        },

        "libraries": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/libraries"

        },

        "lists": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/lists"

        },

        "documents": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents"

        },

        "items": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/items"

        },

        "folders": {

         "href": "https://support.north.local:4443/v5/RestoreSessions/6a50c1ce-07e1-4ee9-9158-9150acb5c2eb/organization/sites/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders"

        }

       }

      }