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

Getting SharePoint Folders

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

Request

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

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

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 folder.
name	string	Specifies the name of the backed-up SharePoint folder.
type	folderType	Specifies the type of the backed-up SharePoint folder: listFolder libraryFolder
createdBy	string	Specifies the user, which created the folder.
creationTime	UTC	Specifies date and time when the folder was created.
modifiedBy	string	Specifies the user, which performed the last modifications to the folder.
modificationTime	UTC	Specifies date and time when the folder was modified.
description	string	Specifies the description of the folder.
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 folder for exploring and performing restore operations.

Request:

GET https://support.north.local:4443/v5/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"type": "ListFolder",

"id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898",

"name": "AB922B82-8406-4E49-B17B-9057BDF09503",

"createdBy": "System Account",

"creationTime": "2017-04-16T08:06:36",

"modifiedBy": "System Account",

"modificationTime": "2017-04-16T08:06:36",

"_links": {

"self": {

"href": "https://support.north.local:4443/v5/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

"folders": {

"href": "https://support.north.local:4443/v5/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/folders?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

"list": {

"href": "https://support.north.local:4443/v5/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/lists/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc3"

"items": {

"href": "https://support.north.local:4443/v5/RestoreSessions/9de1aad8-b932-4083-b58a-edac38c35533/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/items?parentId=1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddbf94c035-744a-4ecb-85de-b0e55380bdc378b8bb47-34aa-4e8e-9c95-9dff94f35898"

}