Getting SharePoint Lists

In this article

    You can get a resource representation of SharePoint lists to explore and restore.

    Request

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

    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

    In the response body, the server returns a resource representation of the /RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Lists resource.

    Examples

    Example 1

    The following request returns a resource representation of SharePoint lists.

    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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "offset": 0,

     "limit": 30,

     "results": [

      {

       "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"

        }

       }

      },

      {

       "id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c3444495b6b761-f8fb-488f-94e0-45ad8a7fd0fb",

       "name": "Calendar",

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

       "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-04f489c3444495b6b761-f8fb-488f-94e0-45ad8a7fd0fb"

        },

        "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-04f489c3444495b6b761-f8fb-488f-94e0-45ad8a7fd0fb"

        },

        "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-04f489c3444495b6b761-f8fb-488f-94e0-45ad8a7fd0fb"

        }

       }

      },

      {

       "id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344447ef8efa2-296a-4ade-b913-d05b2aea9b6e",

       "name": "Content and Structure Reports",

       "url": "/sites/inconsiderable/Reports List",

       "description": "Use the reports list to customize the queries that appear in the Content and Structure Tool views",

       "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-04f489c344447ef8efa2-296a-4ade-b913-d05b2aea9b6e"

        },

        "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-04f489c344447ef8efa2-296a-4ade-b913-d05b2aea9b6e"

        },

        "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-04f489c344447ef8efa2-296a-4ade-b913-d05b2aea9b6e"

        }

       }

      },

      {

       "id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c344447e30ca99-7af8-4be4-9501-81badbe43aaf",

       "name": "Reusable Content",

       "url": "/sites/inconsiderable/ReusableContent",

       "description": "Items in this list contain HTML or text content which can be inserted into webpages. If an item has automatic update selected, the content will be inserted into webpages as a read-only reference, and the content will update if the item is changed. If the item does not have automatic update selected, the content will be inserted as a copy in the webpage, and the content will not update if the item is changed.",

       "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-04f489c344447e30ca99-7af8-4be4-9501-81badbe43aaf"

        },

        "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-04f489c344447e30ca99-7af8-4be4-9501-81badbe43aaf"

        },

        "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-04f489c344447e30ca99-7af8-4be4-9501-81badbe43aaf"

        }

       }

      },

      {

       "id": "37ceec3f-565e-4ee0-9913-221c701d574401a462f8-4a26-4360-9296-04f489c34444656eeeae-0095-4eac-ade1-a7b05fb09edf",

       "name": "Workflow Tasks",

       "url": "/sites/inconsiderable/WorkflowTasks",

       "description": "This system library was created by the Publishing feature to store workflow tasks that are created in this site.",

       "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-04f489c34444656eeeae-0095-4eac-ade1-a7b05fb09edf"

        },

        "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-04f489c34444656eeeae-0095-4eac-ade1-a7b05fb09edf"

        },

        "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-04f489c34444656eeeae-0095-4eac-ade1-a7b05fb09edf"

        }

       }

      }

     ],

     "_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?offset=0&limit=30"

      }

     }

    }