Type de ressource DriveItemdriveItem resource type

La ressource driveItem représente un fichier, un dossier ou un autre élément stocké dans un lecteur. Tous les objets du système de fichiers dans OneDrive et SharePoint sont renvoyés sous forme de ressources driveItem.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.

Il existe deux manières principales de traiter une ressource driveItem :There are two primary ways of addressing a driveItem resource:

  • Grâce à l’identifiant unique driveItem à l’aide de drive/items/{item-id}By the driveItem unique identifier using drive/items/{item-id}
  • Grâce au chemin d’accès au système de fichiers /drive/root:/path/to/fileBy file system path using /drive/root:/path/to/file

Les ressources DriveItem ont des facettes modélisées comme des propriétés qui fournissent des informations sur les identités et les fonctionnalités de l’élément.driveItem resources have facets modeled as properties that provide data about the driveItem's identities and capabilities. Par exemple :For example:

  • Les dossiers ont une facette.Folders have a folder facet
  • Les fichiers ont une facette.Files have a file facet.
  • Les images ont une facette en plus de leur facette file.Images have an image facet in addition to their file facet.
  • Les images prises avec un appareil photo ont une facette qui identifie l’élément comme une photo et indique ses propriétés, telles que la date à laquelle elle a été prise et l’appareil utilisé.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.

Les éléments de la facette dossier servent de conteneurs d’éléments et, par conséquent, ont une référence children dirigeant vers une collection d’éléments driveItems situés au-dessous du dossier.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.

Remarque : dans les bibliothèques de documents OneDrive Entreprise ou SharePoint, la propriété cTag n’est pas renvoyée si l’élément driveItem a une facette folder.Note: In OneDrive for Business or SharePoint document libraries, the cTag property is not returned, if the driveItem has a folder facet.

PropriétésProperties

PropriétéProperty TypeType DescriptionDescription
audioaudio audioaudio Métadonnées audio, si l’élément est un fichier audio. En lecture seule.Audio metadata, if the item is an audio file. Read-only.
contenucontent FluxStream Flux du contenu, si l’élément est un fichier.The content stream, if the item represents a file.
createdBycreatedBy identitySetidentitySet Identité de l’utilisateur, du périphérique et de l’application qui a créé l’élément. En lecture seule.Identity of the user, device, and application which created the item. Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset Date et heure de création de l’élément. En lecture seule.Date and time of item creation. Read-only.
cTagcTag StringString eTag du contenu de l’élément. Cet eTag n’est pas modifié si seules les métadonnées sont modifiées. Remarque Cette propriété n’est pas renvoyée si l’élément est un dossier. En lecture seule.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.
deleteddeleted deleteddeleted Informations sur l’état de suppression de l’élément. En lecture seule.Information about the deleted state of the item. Read-only.
descriptiondescription StringString Fournit une description de l’élément visible par l’utilisateur. En lecture-écriture. Uniquement sur OneDrive PersonnelProvides a user-visible description of the item. Read-write. Only on OneDrive Personal
eTageTag StringString eTag de l’élément entier (métadonnées + contenu). En lecture seule.eTag for the entire item (metadata + content). Read-only.
filefile filefile Métadonnées du fichier, si l’élément est un fichier. En lecture seule.File metadata, if the item is a file. Read-only.
fileSystemInfofileSystemInfo fileSystemInfofileSystemInfo Informations du système de fichiers sur le client. En lecture-écriture.File system information on client. Read-write.
folderfolder dossierfolder Métadonnées du dossier, si l’élément est un dossier. En lecture seule.Folder metadata, if the item is a folder. Read-only.
idid StringString Identificateur unique de l’élément dans le lecteur. En lecture seule.The unique identifier of the item within the Drive. Read-only.
imageimage imageimage Métadonnées de l’image, si l’élément est une image. En lecture seule.Image metadata, if the item is an image. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Identité de l’utilisateur, du périphérique et de l’application qui ont modifié l’élément en dernier. En lecture seule.Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Date et heure de dernière modification de l’élément En lecture seule.Date and time the item was last modified. Read-only.
locationlocation geoCoordinatesgeoCoordinates Emplacement des métadonnées, si l’élément possède des données d’emplacement. En lecture seule.Location metadata, if the item has location data. Read-only.
namename StringString Nom de l’élément (nom de fichier et extension). En lecture-écriture.The name of the item (filename and extension). Read-write.
packagepackage packagepackage Le cas échéant, indique que cet élément est un package au lieu d’un dossier ou d’un fichier. Les packages sont traités comme des fichiers dans certains contextes et comme des dossiers dans d’autres. En lecture seule.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.
parentReferenceparentReference itemReferenceitemReference Informations de l’élément parent, si l’élément possède un parent. En lecture-écriture.Parent information, if the item has a parent. Read-write.
Photophoto photophoto Métadonnées de la photo, si l’élément est une photo. En lecture seule.Photo metadata, if the item is a photo. Read-only.
publicationpublication publicationFacetpublicationFacet Indique si un élément a été publié ou extrait, à des emplacements qui prennent en charge ces actions.Provides information about the published or checked-out state of an item, in locations that support such actions. Cette propriété n’est pas renvoyée par défaut.This property is not returned by default. En lecture seule.Read-only.
remoteItemremoteItem remoteItemremoteItem Données de l’élément à distance, si l’élément est partagé depuis un autre lecteur que celui auquel l’utilisateur accède actuellement. En lecture seule.Remote item data, if the item is shared from a drive other than the one being accessed. Read-only.
rootroot rootroot Si cette propriété est non null, elle indique qu’il s’agit du driveItem le plus élevé dans le lecteur.If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResultsearchResult searchResultsearchResult Métadonnées de la recherche, si l’élément est issu d’une recherche. En lecture seule.Search metadata, if the item is from a search result. Read-only.
partagéshared sharedshared Indique que l’élément a été partagé avec d’autres personnes et fournit des informations sur l’état de partage de l’élément. En lecture seule.Indicates that the item has been shared with others and provides information about the shared state of the item. Read-only.
sharepointIdssharepointIds sharepointIdssharepointIds Renvoie les identificateurs utiles pour garantir la compatibilité de SharePoint REST. En lecture seule.Returns identifiers useful for SharePoint REST compatibility. Read-only.
sizesize Int64Int64 Taille de l’élément en octets. En lecture seule.Size of the item in bytes. Read-only.
specialFolderspecialFolder specialFolderspecialFolder Si l’élément actuel est également disponible sous la forme d’un dossier spécial, cette facette est renvoyée. En lecture seule.If the current item is also available as a special folder, this facet is returned. Read-only.
videovideo videovideo Métadonnées de la vidéo, si l’élément est une vidéo. En lecture seule.Video metadata, if the item is a video. Read-only.
webDavUrlwebDavUrl StringString URL compatible WebDAV pour l’élément.WebDAV compatible URL for the item.
webUrlwebUrl ChaîneString URL qui affiche la ressource dans le navigateur. En lecture seule.URL that displays the resource in the browser. Read-only.

Remarque : Les propriétés eTag et cTag fonctionnent différemment dans les conteneurs (dossiers). La valeur cTag est modifiée lorsque le contenu ou les métadonnées d’un descendant du dossier sont modifiés. La valeur eTag est modifiée uniquement lorsque les propriétés du dossier sont modifiées, à l’exception des propriétés qui sont dérivées des descendants (comme childCount ou lastModifiedDateTime).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).

RelationsRelationships

RelationRelationship TypeType DescriptionDescription
activitiesactivities Collection itemActivityitemActivity collection Liste des activités qui ont récemment eu lieu sur cet élément.The list of recent activities that took place on this item.
analyticsanalytics Ressource itemAnalyticsitemAnalytics resource Données analytiques sur l’affichage des activités effectuées sur ce site.Analytics about the view activities that took place on this item.
childrenchildren Collection driveitemdriveItem collection Collection contenant les objets de l’élément pour les enfants directs de l’élément. Seuls les éléments représentant des dossiers ont des enfants. En lecture seule. Pouvant accepter la valeur Null.Collection containing Item objects for the immediate children of Item. Only items representing folders have children. Read-only. Nullable.
createdByUsercreatedByUser useruser Identité de l’utilisateur qui a créé l’élément.Identity of the user who created the item. En lecture seule.Read-only.
lastModifiedByUserlastModifiedByUser useruser Identité de l’utilisateur qui a modifié l’élément en dernier.Identity of the user who last modified the item. En lecture seule.Read-only.
listItemlistItem listItemlistItem Pour les lecteurs dans SharePoint, l’élément associé de la liste de bibliothèque de documents.For drives in SharePoint, the associated document library list item. En lecture seule.Read-only. Peut avoir la valeur Null.Nullable.
autorisationspermissions collection permissionpermission collection Ensemble d’autorisations pour l’élément. En lecture seule. Peut avoir la valeur Null.The set of permissions for the item. Read-only. Nullable.
abonnementssubscriptions collectionabonnementsubscription collection L’ensemble des abonnements sur l’élément.The set of subscriptions on the item. Prise en charge uniquement sur la racine d’un lecteur.Only supported on the root of a drive.
miniaturesthumbnails collection thumbnailSetthumbnailSet collection Collection contenant des objets ThumbnailSet associés à l’élément. Pour plus d’informations, consultez la rubrique relative à l’obtention de miniatures. En lecture seule. Pouvant accepter la valeur Null.Collection containing ThumbnailSet objects associated with the item. For more info, see getting thumbnails. Read-only. Nullable.
versionsversions collectiondriveItemVersiondriveItemVersion collection Liste de toutes les versions précédentes de l’élément.The list of previous versions of the item. Pour plus d’informations, voir [l’obtention de versions précédentes][].For more info, see getting previous versions. En lecture seule.Read-only. Pouvant accepter la valeur Null.Nullable.
workbookworkbook workbookworkbook Pour les fichiers qui sont des feuilles de calcul Excel, il accède à l’API pour manipuler le contenu de la feuille de calcul du classeur.For files that are Excel spreadsheets, accesses the workbook API to work with the spreadsheet's contents. Pouvant accepter la valeur Null.Nullable.

Attributs d’instanceInstance Attributes

Les attributs d’instance sont des propriétés avec des comportements spéciaux. Ces propriétés sont provisoires et, a) définissent le comportement que le service doit adopter, ou b) fournissent des valeurs à court terme, comme une URL de téléchargement pour un élément qui arrive à expiration.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.

Nom de la propriétéProperty name TypeType DescriptionDescription
@microsoft.graph.conflictBehavior@microsoft.graph.conflictBehavior chaînestring Comportement de résolution des conflits des actions qui créent un élément. Vous pouvez utiliser les valeurs fail, replace ou rename. La valeur par défaut pour PUT est replace. Un élément ne sera jamais renvoyé avec cette annotation. En écriture seule.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@microsoft.graph.downloadUrl stringstring URL qui peut servir à télécharger le contenu de ce fichier. Il n’est pas nécessaire de s’authentifier avec cette URL. En lecture seule.A URL that can be used to download this file's content. Authentication is not required with this URL. Read-only.
@microsoft.graph.sourceUrl@microsoft.graph.sourceUrl stringstring Lors de l’envoi d’une demande PUT, l’annotation de cette instance peut servir à demander au service de télécharger le contenu de l’URL et de le stocker en tant que fichier. En écriture seule.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.

Remarque : La valeur @microsoft.graph.downloadUrl est une URL de courte durée et ne peut pas être mise en cache.Note: The @microsoft.graph.downloadUrl value is a short-lived URL and can't be cached. L’URL sera disponible uniquement pour une courte durée (1 heure) avant qu’elle ne soit plus valide.The URL will only be available for a short period of time (1 hour) before it is invalidated. Suppression d’autorisations de fichier pour un utilisateur peut invalident pas immédiatement l’URL.Removing file permissions for a user may not immediately invalidate the URL.

Représentation JSONJSON representation

Voici une représentation JSON d’une ressource driveItem.Here is a JSON representation of a driveItem resource.

La ressource driveItem est dérivée de l’objet baseItem et hérite des propriétés de cette ressource.The driveItem resource is derived from baseItem and inherits properties from that resource.

{
  "audio": { "@odata.type": "microsoft.graph.audio" },
  "content": { "@odata.type": "Edm.Stream" },
  "cTag": "string (etag)",
  "deleted": { "@odata.type": "microsoft.graph.deleted"},
  "description": "string",
  "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" },
  "publication": {"@odata.type": "microsoft.graph.publicationFacet"},
  "remoteItem": { "@odata.type": "microsoft.graph.remoteItem" },
  "root": { "@odata.type": "microsoft.graph.root" },
  "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 */
  "activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
  "analytics": {"@odata.type": "microsoft.graph.itemAnalytics"},
  "children": [{ "@odata.type": "microsoft.graph.driveItem" }],
  "createdByUser": { "@odata.type": "microsoft.graph.user" },
  "lastModifiedByUser": { "@odata.type": "microsoft.graph.user" },
  "permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
  "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],
  "thumbnails": [ {"@odata.type": "microsoft.graph.thumbnailSet"}],
  "versions": [ {"@odata.type": "microsoft.graph.driveItemVersion"}],

  /* 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",

  /* instance annotations */
  "@microsoft.graph.conflictBehavior": "string",
  "@microsoft.graph.downloadUrl": "url",
  "@microsoft.graph.sourceUrl": "url"
}

MéthodesMethods

MéthodeMethod Type renvoyéReturn Type DescriptionDescription
Obtenir un élémentGet item driveItemdriveItem Récupérer les métadonnées d’un DriveItem dans un lecteur.Retrieve the metadata for a DriveItem in a Drive.
Obtenir les données analytiquesGet analytics itemAnalyticsitemAnalytics Obtenir les données analytiques pour cette ressource.Get analytics for this resource.
Obtenir des activités par intervalleGet activities by interval itemActivityStatitemActivityStat Obtenir une collection d’itemActivityStats dans l’intervalle de temps spécifié.Get a collection of itemActivityStats within the specified time interval.
Répertorier les enfantsList children collection d’driveItemcollection of driveItem Renvoyez une collection d’objets DriveItem dans la relation enfants d’un objet DriveItem.Return a collection of DriveItems in the children relationship of a DriveItem.
Répertorier les versionsList versions collection de DriveItemVersioncollection of DriveItemVersion Récupère les versions d’un fichier dans le lecteur de l’utilisateur actuel.Retrieves the versions of a file in the current user's drive.
Créer un élémentCreate item driveItemdriveItem Crée une driveItem dans le lecteur spécifié.Creates a driveItem in the specified drive.
Mettre à jour un élémentUpdate item driveItemdriveItem Met à jour un driveItem dans le lecteur.Updates a driveItem in the drive.
Charger du contenuUpload content driveItemdriveItem Charge du contenu sur le driveItem.Uploads content to the driveItem.
Télécharger du contenuDownload content URL de téléchargementdownload Url Télécharge le contenu d’un driveItem.Downloads content of a driveItem.
Télécharger un format de fichier spécifiqueDownload specific file format URL de téléchargementdownload Url Télécharge le contenu d’un driveItem dans un format spécifique.Downloads content of a driveItem with a specific format.
Supprimer un élémentDelete item Aucun contenuNo Content Supprime un driveItem.Deletes a driveItem.
Déplacer un élémentMove item driveItemdriveItem Déplacer une DriveItem vers un nouvel élément parent.Move a DriveItem to a new parent item.
Copier un élémentCopy item détails sur le mode de surveillance de la progression de la copiedetails about how to monitor the progress of the copy Crée une copie d’un driveItem (incluant les enfants).Creates a copy of an driveItem (including any children).
Rechercher des élémentsSearch items collection d’driveItemcollection of driveItem Recherche dans la hiérarchie d’éléments des éléments correspondant à une requête.Search the hierarchy of items for items matching a query.
Répertorier les modifications dans un lecteurList changes in a drive lien deltadelta link Répertorie les modifications apportées au lecteur.List any changes in the drive.
Répertorier les miniaturesList thumbnails collection de driveItemcolletion of driveItem Répertorie les driveItems avec leurs miniatures.List driveItems with their thumbnails.
Créer un lien de partageCreate sharing link lien de partagesharing link Crée un lien pour partager le driveItem.Create a link to share the driveItem.
Ajouter des autorisationsAdd permissions collection d'[autorisations][]collection of permission Envoie un invite de partage à un utilisateur.Sends a sharing ivite to a user.
Répertorier les autorisationsList permissions collection d'[autorisations][]collection of permission Récupère la collection d’autorisations sur un driveItem.Retrieves the collection of permissions on an driveItem.
Supprimer une autorisationDelete permission Aucun contenuNo Content Supprime l’autorisation du driveItem.Removes the permission from the driveItem.
Obtenir un canal WebSocketGet WebSocket channel abonnementsubscription Reçoit des notifications de modification en quasi temps réel pour un lecteur utilisant socket.io.Receives near-real-time change notifications for a drive using socket.io.
Élément AperçuPreview item objet jsonjson object Obtient les URL incorporables à durée de vie limitée d’un élément afin de produire un aperçu temporaire.Obtain short-lived embeddable URLs for an item in order to render a temporary preview.