Getting OneDrive Folders
You can get a resource representation of a backed-up OneDrive folder with the specified ID.
Request
GET https://<hostname>:4443/v6/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 OneDrives. |
folderId | string | Specifies the identification number of the OneDrive folder. For more information on how to get this parameter, see Getting OneDrive Folders. |
The following optional parameter can be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
versionId | integer | Specifies the identification number of the OneDrive folder version. For more information on how to get this parameter, see Getting All Versions of OneDrive Folder. |
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 body contains the following properties:
Property | Type | Description |
---|---|---|
id | string | Specifies the ID of the backed-up OneDrive folder. |
version | string | Specifies the version of the OneDrive folder. |
versionId | integer | Specifies the ID of the OneDrive folder version. |
name | string | Specifies the name of the backed-up OneDrive folder. |
createdBy | string | Specifies the user created the folder. |
creationTime | UTC | Specifies date and time when the folder was created. |
modifiedBy | string | Specifies the user performed the last modifications to the folder. |
modificationTime | UTC | Specifies date and time when the folder was modified. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of the OneDrive folder with the ID bbc9960c-767b-428a-ac6c-c75bb8f7c548.
Request: GET https://abc.tech.local:4443/v6/RestoreSessions/02db1338-09f9-466d-8d48-588f4f215ad9/Organization/OneDrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/Folders/bbc9960c-767b-428a-ac6c-c75bb8f7c548
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "version": "1.0", "id": "bbc9960c-767b-428a-ac6c-c75bb8f7c548", "versionId": 1, "name": "Folder1", "createdBy": "administrator", "creationTime": "2021-04-20T09:42:29Z", "modifiedBy": "Administrator", "modificationTime": "2021-05-25T15:41:42Z", "_links": { "self": { "href": "v6/restoresessions/02db1338-09f9-466d-8d48-588f4f215ad9/organization/onedrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/folders/bbc9960c-767b-428a-ac6c-c75bb8f7c548" }, "onedrive": { "href": "v6/restoresessions/02db1338-09f9-466d-8d48-588f4f215ad9/organization/onedrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5" }, "folders": { "href": "v6/restoresessions/02db1338-09f9-466d-8d48-588f4f215ad9/organization/onedrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/folders?parentId=bbc9960c-767b-428a-ac6c-c75bb8f7c548" }, "documents": { "href": "v6/restoresessions/02db1338-09f9-466d-8d48-588f4f215ad9/organization/onedrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/documents?parentId=bbc9960c-767b-428a-ac6c-c75bb8f7c548" }, "versions": { "href": "v6/restoresessions/02db1338-09f9-466d-8d48-588f4f215ad9/organization/onedrives/9c4a2afc-5e57-4dfa-a7e2-59e092691772ef4221af-9351-41ec-9128-534cf34db1a5/folders/bbc9960c-767b-428a-ac6c-c75bb8f7c548/versions" } } } |