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

Getting OneDrive Folders

You can get a resource representation of a backed-up OneDrive folder with the specified ID.

Request

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

oneDriveId

string

Specifies the identification number of OneDrive. For more information on how to get this parameter, see Getting OneDrive Items.

folderId

string

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

name

string

Specifies the name of the backed-up OneDrive document.

children

object[]

Specifies _links for the children objects.

parent

object

Specifies _links for the parent object.

version

integer

Specifies the version of the document.

createdBy

string

Specifies the user, which created the document.

creationTime

UTC

Specifies date and time when the folder was created.

modifiedBy

string

Specifies the user, which performed the last modifications to the document.

modificationTime

UTC

Specifies date and time when the document was modified.

_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 OneDrive folder for exploring and performing restore operations.

Request:

GET https://support.north.local:4443/v5/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Folders/{folderId}

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

  {

   "id": "89e2b52a-66e3-4a1a-a088-4655dfbe95d7",

   "name": "F1",

   "createdBy": "System Account",

   "creationTime": "2017-04-04T12:01:49",

   "modifiedBy": "System Account",

   "modificationTime": "2017-04-04T12:01:49",

   "_links": {

    "self": {

     "href": "https://support.north.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders/89e2b52a-66e3-4a1a-a088-4655dfbe95d7"

    },

    "onedrive": {

     "href": "https://support.north.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39"

    },

    "folders": {

     "href": "https://support.north.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/folders?parentId=89e2b52a-66e3-4a1a-a088-4655dfbe95d7"

    },

    "documents": {

     "href": "https://support.north.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents?parentId=89e2b52a-66e3-4a1a-a088-4655dfbe95d7"

    }

   }

  }

}