Getting OneDrive Documents

Returns a resource representation of OneDrive documents with a specified ID.

Request

GET https://<hostname>:4443/v4/RestoreSessions/{restoreSessionId}/Organization/OneDrives/{oneDriveId}/Documents/{documentId}

Request Headers

The request header must contain an authorization token of the current session.

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

Property

Type

Description

Id

string

Specifies the ID of the backed-up OneDrive document.

Name

string

Specifies the name of the backed-up OneDrive document.

Parent

object

Specifies _links for the parent object.

Version

int

Specifies the version of the document.

SizeBytes

int

Specifies the size of the document.

CreatedBy

string

Specifies the user, which created the document.

CreationTime

UTC

Specifies date and time when the document 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.

InheritedPermissions

boolean

Specifies if the permission settings of an element will be passed on to the children of that element.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The following request returns an entity representation of of OneDrive documents with a specified ID.

Request:

GET https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/Documents/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "sizeBytes": 80101,

 "inheritedPermissions": true,

 "version": "1.0",

 "id": "724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11",

 "name": "content.jpg",

 "createdBy": "System Account",

 "creationTime": "2017-04-09T09:12:59",

 "modifiedBy": "System Account",

 "modificationTime": "2017-04-09T09:12:59",

 "_links": {

  "self": {

   "href": "https://support.north.local:4443/v4/restoresessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/b3184e77-b95b-45f7-96cc-180a20b61cbd8507931c-4561-4ddf-bc90-411aba44bb39/documents/0e4079a2-faa5-41bf-b8a7-ba883308cbc9"

  },

  "onedrive": {

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

  },

  "parent": {

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

  }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.