DriveItem resource type

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

The driveItem resource represents a file, folder, or other item stored in a drive. All file system objects in OneDrive and SharePoint are returned as driveItem resources.

There are two primary ways of addressing a driveItem resource:

  • By the driveItem unique identifier using drive/items/{item-id}
  • By file system path using /drive/root:/path/to/file

DriveItem resources have facets modeled as properties that provide data about the driveItem's identities and capabilities. For example:

  • Folders have a folder facet
  • Files have a file facet.
  • Images have an image facet in addition to their file facet.
  • Images taken with a camera (photos) have a photo facet that identifies the item as a photo and provides the properties of when the photo was taken and with what device.

Items with the folder facet act as containers of items and therefore have a children reference pointing to a collection of driveItems under the folder.

JSON representation

Here is a JSON representation of a driveItem resource.

The driveItem resource is derived from baseItem and inherits properties from that resource.

{
  "audio": { "@odata.type": "microsoft.graph.audio" },
  "cTag": "string",
  "deleted": { "@odata.type": "microsoft.graph.deleted" },
  "file": { "@odata.type": "microsoft.graph.file" },
  "fileSystemInfo": { "@odata.type": "microsoft.graph.fileSystemInfo" },
  "folder": { "@odata.type": "microsoft.graph.folder" },
  "image": { "@odata.type": "microsoft.graph.image" },
  "location": { "@odata.type": "microsoft.graph.geoCoordinates" },
  "package": { "@odata.type": "microsoft.graph.package" },
  "photo": { "@odata.type": "microsoft.graph.photo" },
  "remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
  "searchResult": { "@odata.type": "microsoft.graph.searchResult" },
  "shared": { "@odata.type": "microsoft.graph.shared" },
  "sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
  "size": 1024,
  "specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
  "video": { "@odata.type": "microsoft.graph.video" },
  "webDavUrl": "string",

  /* relationships */
  "content": "stream",
  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
  "children": [ { "@odata.type": "microsoft.graph.driveItem" }],
  "listItem": [ {"@odata.type": "microsoft.graph.listItem"}],
  "thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
  "permissions": [ {"@odata.type": "microsoft.graph.permission"} ],

  /* inherited from baseItem */
  "id": "string (identifier)",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "eTag": "string",
  "lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
  "lastModifiedDateTime": "String (timestamp)",
  "name": "string",
  "parentReference": {"@odata.type": "microsoft.graph.itemReference"},
  "webUrl": "string",
}

Properties

Property Type Description
audio audio Audio metadata, if the item is an audio file. Read-only.
createdBy identitySet Identity of the user, device, and application which created the item. Read-only.
createdDateTime DateTimeOffset Date and time of item creation. Read-only.
cTag String An eTag for the content of the item. This eTag is not changed if only the metadata is changed. Note This property is not returned if the item is a folder. Read-only.
deleted deleted Information about the deleted state of the item. Read-only.
eTag String eTag for the entire item (metadata + content). Read-only.
file file File metadata, if the item is a file. Read-only.
fileSystemInfo fileSystemInfo File system information on client. Read-write.
folder folder Folder metadata, if the item is a folder. Read-only.
id String The unique identifier of the item within the Drive. Read-only.
image image Image metadata, if the item is an image. Read-only.
lastModifiedBy identitySet Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTime DateTimeOffset Date and time the item was last modified. Read-only.
location geoCoordinates Location metadata, if the item has location data. Read-only.
name String The name of the item (filename and extension). Read-write.
package package If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others. Read-only.
parentReference itemReference Parent information, if the item has a parent. Read-write.
photo photo Photo metadata, if the item is a photo. Read-only.
remoteItem remoteItem Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
searchResult searchResult Search metadata, if the item is from a search result. Read-only.
shared shared Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIds sharepointIds Returns identifiers useful for SharePoint REST compatibility. Read-only.
size Int64 Size of the item in bytes. Read-only.
specialFolder specialFolder If the current item is also available as a special folder, this facet is returned. Read-only.
video video Video metadata, if the item is a video. Read-only.
webUrl String URL that displays the resource in the browser. Read-only.

Note: The eTag and cTag properties work differently on containers (folders). The cTag value is modified when content or metadata of any descendant of the folder is changed. The eTag value is only modified when the folder's properties are changed, except for properties that are derived from descendants (like childCount or lastModifiedDateTime).

Relationships

Relationship Type Description
content Stream The content stream, if the item represents a file.
children driveitem collection Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
createdByUser user Identity of the user, device, and application which created the item. Read-only.
lastModifiedByUser user Identity of the user, device, and application which last modified the item. Read-only.
listItem listItem The corresponding Document Library list item for drive items in SharePoint.
permissions permission collection The set of permissions for the item. Read-only. Nullable.
thumbnails thumbnailSet collection Collection containing ThumbnailSet objects associated with the item. For more info, see getting thumbnails. Read-only. Nullable.

Instance Attributes

Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

Property name Type Description
@microsoft.graph.conflictBehavior string The conflict resolution behavior for actions that create a new item. You can use the values fail, replace, or rename. The default for PUT is replace. An item will never be returned with this annotation. Write-only.
@microsoft.graph.downloadUrl string A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
@microsoft.graph.sourceUrl string When issuing a PUT request, this instance annotation can be used to instruct the service to download the contents of the URL, and store it as the file. Write-only.

Note: The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached. The URL will only be available for a short period of time (1 hour) before it is invalidated.

Methods

Method REST Path
Get item GET /drive/items/{item-id}
List children GET /drive/items/{item-id}/children
Create item POST /drive/items/{item-id}/children
Update item PATCH /drive/items/{item-id}
Upload content PUT /drive/items/{item-id}/content
Download content GET /drive/items/{item-id}/content
Delete item DELETE /drive/items/{item-id}
Move item PATCH /drive/items/{item-id}
Copy item POST /drive/items/{item-id}/copy
Search items GET /drive/items/{item-id}/search(q='text')
Find changes GET /drive/root/delta
List thumbnails GET /drive/items/{item-id}/thumbnails
Create sharing link POST /drive/items/{item-id}/createLink
Add permissions POST /drive/items/{item-id}/invite
List permissions GET /drive/items/{item-id}/permissions
Delete permission DELETE /drive/items/{item-id}/permissions/{perm-id}

Remarks

In OneDrive for Business or SharePoint document libraries, the cTag property is not returned, if the driveItem has a folder facet.