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

Getting OneDrive Documents

You can get a resource representation of OneDrive documents to explore and restore.

Request

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

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.

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/OneDrives/{oneDriveId}/Documents resource.

Examples

Example 1

The following request returns a resource representation of the organization's OneDrive parent documents.

Request:

GET https://support.north.local:4443/v5/RestoreSessions/61954db6-7278-4d26-86f7-888bda5a4ec4/organization/onedrives/724011c3-a540-4684-b24f-3e2ab4ef6380df26ea7d-6468-4846-bdf5-4e88d871ed11/documents?parentId=null

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

  {

   "sizeBytes": 80101,

   "inheritedPermissions": true,

   "version": "1.0",

   "id": "0e4079a2-faa5-41bf-b8a7-ba883308cbc9",

   "name": "image1.jpg",

   "createdBy": "System Account",

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

   "modifiedBy": "System Account",

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

   "_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/documents/0e4079a2-faa5-41bf-b8a7-ba883308cbc9"

    },

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

    },

    "parent": {

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

    }

   }

  },

  {

   "sizeBytes": 1040384,

   "inheritedPermissions": true,

   "version": "2.0",

   "id": "206b13cc-a453-4102-a256-20a64f760e6d",

   "name": "image2.png",

   "createdBy": "System Account",

   "creationTime": "2017-12-26T12:07:30",

   "modifiedBy": "System Account",

   "modificationTime": "2017-12-26T12:07:30",

   "_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/documents/206b13cc-a453-4102-a256-20a64f760e6d"

    },

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

    },

    "parent": {

     "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/67cdafbf-8c14-434e-a02d-a04f228e0086"

    }

   }

  }

 ],

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

  }

 }

}

Example 2

The following request returns a resource representation of all organization OneDrive documents.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

  {

   "sizeBytes": 80101,

   "inheritedPermissions": true,

   "version": "1.0",

   "id": "0e4079a2-faa5-41bf-b8a7-ba883308cbc9",

   "name": "image3.jpg",

   "createdBy": "System Account",

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

   "modifiedBy": "System Account",

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

   "_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/documents/0e4079a2-faa5-41bf-b8a7-ba883308cbc9"

    },

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

    },

    "parent": {

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

    }

   }

  },

  {

   "sizeBytes": 1040384,

   "inheritedPermissions": true,

   "version": "2.0",

   "id": "206b13cc-a453-4102-a256-20a64f760e6d",

   "name": "image2.png",

   "createdBy": "System Account",

   "creationTime": "2017-12-26T12:07:30",

   "modifiedBy": "System Account",

   "modificationTime": "2017-12-26T12:07:30",

   "_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/documents/206b13cc-a453-4102-a256-20a64f760e6d"

    },

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

    },

    "parent": {

     "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/67cdafbf-8c14-434e-a02d-a04f228e0086"

    }

   }

  }

 ],

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

  }

 }

}