Getting SharePoint Libraries

In this article

    You can get a resource representation of a backed-up SharePoint document library with the specified ID.

    Request

    GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}

    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.

    libraryId

    string

    Specifies the identification number of the SharePoint document library. For more information on how to get this parameter, see Getting SharePoint Libraries.

    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 document library.

    url

    string

    Specifies the URL of the SharePoint document library.

    name

    string

    Specifies the name of the backed-up SharePoint document library.

    creationTime

    UTC

    Specifies date and time when the document library was created.

    description

    string

    Specifies the description of the document library.

    parent

    object[]

    Specifies _links for the parent object.

    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 document library with the specified ID for exploring and performing restore operations.

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/Organization/Sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/Libraries/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb",

     "name": "Style Library",

     "url": "/sites/inconsiderable/Style Library",

     "description": "Use the style library to store style sheets, such as CSS or XSL files. The style sheets in this gallery can be used by this site or any of its subsites.",

     "creationTime": "2017-12-06T14:40:54Z",

     "_links": {

      "self": {

       "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/libraries/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb"

      },

      "parent": {

       "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444"

      },

      "folders": {

       "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/folders?parentId=37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb"

      },

      "documents": {

       "href": "https://support.north.local:4443/v5/RestoreSessions/742fe5ac-3ea6-422b-b204-757b15a47e56/organization/sites/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444/documents?parentId=37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344441a867bcb-6a88-4744-adda-26c2c33e7cbb"

      }

     }

    }