This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting SharePoint Lists

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

Request

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

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.
listId	string	Specifies the identification number of the SharePoint list. For more information on how to get this parameter, see Getting SharePoint Lists.

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 list.
name	string	Specifies the name of the backed-up SharePoint list.
creationTime	UTC	Specifies date and time when the list was created.
description	string	Specifies the description of the SharePoint list.
parent	object[]	Specifies _links for the parent object.
children	object[]	Specifies _links for the children objects.
url	string	Specifies the URL of th SharePoint list.
_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 list 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/Lists/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444d0bf1b2f-be66-4982-ba88-a31a49f61a3a

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444d0bf1b2f-be66-4982-ba88-a31a49f61a3a",

"name": "Local",

"url": "/sites/inconsiderable/Lists/Local",

"description": "",

"creationTime": "0001-01-01T00:00:00Z",

"_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/lists/37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444d0bf1b2f-be66-4982-ba88-a31a49f61a3a"

"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-04f489c34444d0bf1b2f-be66-4982-ba88-a31a49f61a3a"

"items": {

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

}