Get a driveItem resource
Namespace: microsoft.graph
Retrieve the metadata for a driveItem in a drive by file system path or ID.
item-id
is the ID of a driveItem. It may also be the unique ID of a SharePoint list item.
This API is supported in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Delegated (personal Microsoft account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All |
Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
HTTP request
GET /drives/{drive-id}/items/{item-id}
GET /drives/{drive-id}/root:/{item-path}
GET /groups/{group-id}/drive/items/{item-id}
GET /groups/{group-id}/drive/root:/{item-path}
GET /me/drive/items/{item-id}
GET /me/drive/root:/{item-path}
GET /sites/{site-id}/drive/items/{item-id}
GET /sites/{site-id}/drive/root:/{item-path}
GET /sites/{site-id}/lists/{list-id}/items/{item-id}/driveItem
GET /users/{user-id}/drive/items/{item-id}
GET /users/{user-id}/drive/root:/{item-path}
Optional query parameters
This method supports the $expand
and $select
OData query parameters to customize the response.
You can use the $expand
query string parameter to include the children of an item in the same call as retrieving the metadata of an item if the item has a children relationship.
You can also use the includeDeletedItems=true
query parameter to return deleted items.
This query parameter is only valid when targeting a driveItem by ID, and otherwise will be ignored.
This is currently only supported on OneDrive Personal.
Optional request headers
Name | Value | Description |
---|---|---|
if-none-match | String | If this request header is included and the eTag (or cTag) provided matches the current tag on the file, an HTTP 304 Not Modified response is returned. |
Response
If successful, this method returns a 200 OK
response code and the driveItem resource in the response body.
Example
Request
Here is an example of the request to the root folder of the user's OneDrive.
GET /me/drive/root
Response
Here is an example of the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"createdBy": {
"user": {
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
"displayName": "Ryan Gregg"
}
},
"createdDateTime": "2016-03-21T20:01:37Z",
"cTag": "\"c:{86EB4C8E-D20D-46B9-AD41-23B8868DDA8A},0\"",
"eTag": "\"{86EB4C8E-D20D-46B9-AD41-23B8868DDA8A},1\"",
"folder": { "childCount": 120 },
"id": "01NKDM7HMOJTVYMDOSXFDK2QJDXCDI3WUK",
"lastModifiedBy": {
"user": {
"id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
"displayName": "Ryan Gregg"
}
},
"lastModifiedDateTime": "2016-03-21T20:01:37Z",
"name": "OneDrive",
"root": { },
"size": 157286400,
"webUrl": "https://contoso-my.sharepoint.com/personal/rgregg_contoso_com/Documents"
}
See also
For details about how errors are returned, see Error responses.
Feedback
Submit and view feedback for