Type de ressource DriveItem
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
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. Les éléments des bibliothèques de documents SharePoint peuvent être représentés sous la forme de ressources listItem ou driveItem.
Il existe deux manières principales de traiter une ressource driveItem :
- Grâce à l’identifiant unique driveItem à l’aide de
drive/items/{item-id} - Grâce au chemin d’accès au système de fichiers
/drive/root:/path/to/file
Pour plus d’informations, consultez traiter driveItems.
Les ressources DriveItem ont des facettes modélisées en tant que propriétés qui fournissent des données sur les identités et les fonctionnalités de l’élément driveItem. Par exemple :
- Les dossiers ont une facette de dossier
- Les fichiers ont une facette de fichier.
- Les images ont une facette image en plus de leur facette fichier.
- Les images prises avec un appareil photo ont une facette photo 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é.
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.
Note: Dans les bibliothèques de documents OneDrive Entreprise ou SharePoint, la propriété cTag n’est pas retournée si l’élément driveItem a une facette de dossier .
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Obtenir un élément | driveItem | Récupérer les métadonnées d’un objet driveItem dans un lecteur. |
| Obtenir les données analytiques | itemAnalytics | Obtenir les données analytiques pour cette ressource. |
| Obtenir des activités par intervalle | itemActivityStat | Obtenir une collection d’itemActivityStats dans l’intervalle de temps spécifié. |
| Répertorier les enfants | Collection driveItem | Retourne une collection de driveItems dans la relation enfant d’un objet driveItem. |
| Répertorier les versions | collectiondriveItemVersion | Récupérez les versions d’un fichier dans le lecteur de l’utilisateur actuel. |
| Créer un dossier | driveItem | Créez un driveItem dans le lecteur spécifié. |
| Mettre à jour un élément | driveItem | Mettez à jour un élément driveItem dans le lecteur. |
| Charger | driveItem | Chargez du contenu dans l’objet driveItem. |
| Télécharger le contenu du fichier | Stream | Téléchargez le contenu du flux principal (fichier) d’une ressource driveItem. |
| Télécharger un format de fichier spécifique | URL de téléchargement | Téléchargez le contenu d’un objet driveItem avec un format spécifique. |
| Supprimer un élément | Aucune | Supprimer un objet driveItem. |
| Supprimer définitivement l’élément | Aucune | Supprimez définitivement un objet driveItem à l’aide de son ID. |
| Déplacer un élément | driveItem | Déplacer un élément driveItem vers un nouvel élément parent. |
| Copier un élément | détails sur le mode de surveillance de la progression de la copie | Créez une copie d’un élément driveItem (y compris tous les enfants). |
| Rechercher des éléments | Collection driveitem | Recherche dans la hiérarchie d’éléments des éléments correspondant à une requête. |
| Suivi des modifications | lien delta | Répertorie les modifications apportées au lecteur. |
| Suivre l’élément | driveItem | Suivez un élément driveItem. |
| Annuler le suivi de l’élément | Aucune | Annulez le suivi d’un objet driveItem. |
| Obtenir des miniatures | Collection driveItem | Répertoriez les driveItems avec leurs miniatures. |
| Créer un lien de partage | lien de partage | Créez un lien pour partager l’élément driveItem. |
| Ajouter des autorisations | collection permission | Envoyer une invitation de partage à un utilisateur. |
| Répertorier les autorisations | collection permission | Récupérer la collection d’autorisations sur un objet driveItem. |
| Créer une autorisation | autorisation | Créez une autorisation sur un objet driveItem. |
| Supprimer une autorisation | Aucune | Supprimez l’autorisation de l’objet driveItem. |
| Révoquer des octrois sur le lien de partage | autorisation | Révoquez l’accès à un objet listItem ou driveItem accordé via un lien de partage en supprimant le destinataire spécifié du lien. |
| Obtenir un canal WebSocket | abonnement | Recevoir des notifications de modification en quasi-temps réel pour un lecteur à l’aide de socket.io. |
| Élément Aperçu | objet json | Obtient les URL incorporables à durée de vie limitée d’un élément afin de produire un aperçu temporaire. |
| Archiver des fichiers | Aucune | Archivez une ressource driveItem extraite, ce qui rend la version du document accessible à d’autres personnes. |
| Extraire des fichiers | Aucune | Extrayez une ressource driveItem pour empêcher d’autres personnes de modifier le document et empêcher vos modifications d’être visibles tant que le document n’est pas archivé. |
| Ignorer l’extraction | Aucune | Ignorez un élément driveItem précédemment extrait. |
| Extraire les étiquettes de confidentialité | extractSensitivityLabelsResult | Extrayez une ou plusieurs étiquettes de confidentialité affectées à un élément de lecteur et mettez à jour les métadonnées d’un élément de lecteur avec les derniers détails de l’étiquette affectée. |
| Attribuer une étiquette de confidentialité | Chaîne | Affectez de façon asynchrone une étiquette de confidentialité à un élément driveItem. |
| Obtenir l’étiquette de rétention | itemRetentionLabel | Obtenir des informations de métadonnées pour une étiquette de rétention appliquée à un objet driveItem. |
| Définir l’étiquette de rétention | itemRetentionLabel | Appliquer (définir) une étiquette de rétention sur un objet driveItem (fichiers et dossiers). |
| Supprimer l’étiquette de rétention | Aucune | Supprimez une étiquette de rétention d’un élément driveItem. |
| Verrouiller ou déverrouiller un enregistrement | itemRetentionLabel | Verrouillez ou déverrouillez une étiquette de rétention sur un élément driveItem qui classifie le contenu en tant qu’enregistrements. |
| Télécharger le fichier (déconseillé) | URL de téléchargement | Télécharger le contenu d’un objet driveItem. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| audio | audio | Métadonnées audio, si l’élément est un fichier audio. En lecture seule. Uniquement sur OneDrive Personnel. |
| bundle | regrouper | Métadonnées d’ensemble, si l’élément est un ensemble d’éléments. En lecture seule. |
| contenu (déconseillé) | Flux | Flux du contenu, si l’élément est un fichier. La propriété content aura un changement de comportement potentiellement cassant à l’avenir. Il diffusera le contenu directement au lieu de le rediriger. Pour choisir de manière proactive le nouveau comportement à l’avance, utilisez plutôt la propriété contentStream . |
| contentStream | Flux | Flux du contenu, si l’élément est un fichier. |
| createdBy | identitySet | Identité de l’utilisateur, de l’appareil et de l’application qui a créé l’élément. En lecture seule. |
| createdDateTime | DateTimeOffset | Date et heure de création de l’élément. En lecture seule. |
| cTag | String | eTag du contenu de l’élément. Cet eTag n’est pas modifié si seules les métadonnées sont modifiées. Note Cette propriété n’est pas retournée si l’élément est un dossier. En lecture seule. |
| deleted | deleted | Informations sur l’état de suppression de l’élément. En lecture seule. |
| description | String | Fournit une description de l’élément visible par l’utilisateur. En lecture-écriture. Uniquement sur OneDrive Personnel. |
| eTag | String | eTag de l’élément entier (métadonnées + contenu). En lecture seule. |
| file | file | Métadonnées du fichier, si l’élément est un fichier. En lecture seule. |
| fileSystemInfo | fileSystemInfo | Informations du système de fichiers sur le client. En lecture-écriture. |
| folder | folder | Métadonnées du dossier, si l’élément est un dossier. En lecture seule. |
| id | String | Identificateur unique de l’élément dans le lecteur. En lecture seule. |
| image | image | Métadonnées de l’image, si l’élément est une image. En lecture seule. |
| lastModifiedBy | identitySet | Identité de l’utilisateur, de l’appareil et de l’application, qui a modifié l’élément pour la dernière fois. En lecture seule. |
| lastModifiedDateTime | DateTimeOffset | Date et heure de la dernière modification de l’élément. En lecture seule. |
| location | geoCoordinates | Emplacement des métadonnées, si l’élément possède des données d’emplacement. En lecture seule. |
| programme malveillant | programme malveillant | Métadonnées de programme malveillant, si l’élément a été détecté comme contenant des programmes malveillants. En lecture seule. |
| média | media | Informations sur l’élément multimédia (audio ou vidéo). En lecture-écriture. Uniquement sur OneDrive Entreprise et SharePoint. |
| nom | String | Nom de l’élément (nom de fichier et extension). En lecture-écriture. |
| package | package | 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. |
| parentReference | itemReference | Informations de l’élément parent, si l’élément possède un parent. En lecture-écriture. |
| Operations en attente | Operations en attente | Le cas échéant, indique qu’une ou plusieurs opérations susceptibles d’affecter l’état de l’élément driveItem sont en attente d’achèvement. En lecture seule. |
| photo | photo | Métadonnées de la photo, si l’élément est une photo. En lecture seule. |
| publication | publicationFacet | Indique si un élément a été publié ou extrait, à des emplacements qui prennent en charge ces actions. Cette propriété n’est pas retournée par défaut. En lecture seule. |
| remoteItem | remoteItem | 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. |
| root | root | Si cette propriété est non null, elle indique qu’il s’agit du driveItem le plus élevé dans le lecteur. |
| searchResult | searchResult | Métadonnées de la recherche, si l’élément est issu d’une recherche. En lecture seule. |
| partagé | shared | Indique que l’élément a été partagé avec d’autres personnes et fournit des informations sur l’état partagé de l’élément. En lecture seule. |
| sharepointIds | sharepointIds | Renvoie les identificateurs utiles pour garantir la compatibilité de SharePoint REST. En lecture seule. |
| size | Int64 | Taille de l’élément en octets. En lecture seule. |
| specialFolder | specialFolder | Si l’élément actuel est également disponible sous la forme d’un dossier spécial, cette facette est renvoyée. Lecture seule. |
| source | driveItemSource | Informations sur la source de l’élément de lecteur. En lecture seule. Uniquement sur OneDrive Entreprise et SharePoint. |
| video | video | Métadonnées de la vidéo, si l’élément est une vidéo. En lecture seule. |
| point de vue | driveItemViewpoint | Retourne des informations spécifiques à l’utilisateur appelant pour cet élément de lecteur. En lecture seule. |
| webDavUrl | String | URL compatible WebDAV pour l’élément. |
| webUrl | Chaîne | URL qui affiche la ressource dans le navigateur. En lecture seule. |
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).
Relations
| Relation | Type | Description |
|---|---|---|
| activities | Collection itemActivity | Liste des activités qui ont récemment eu lieu sur cet élément. |
| analytics | Ressource itemAnalytics | Données analytiques sur l’affichage des activités effectuées sur ce site. |
| children | Collection driveitem | 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. Peut avoir la valeur Null. |
| createdByUser | user | Identité de l’utilisateur qui a créé l’élément. En lecture seule. |
| lastModifiedByUser | user | Identité de l’utilisateur qui a modifié l’élément en dernier. En lecture seule. |
| listItem | listItem | Pour les lecteurs dans SharePoint, l’élément associé de la liste de bibliothèque de documents. En lecture seule. Peut avoir la valeur Null. |
| autorisations | collection permission | Ensemble d’autorisations pour l’élément. En lecture seule. Pouvant accepter la valeur Null. |
| retentionLabel | itemRetentionLabel | Informations sur l’étiquette de rétention et les paramètres appliqués à l’élément driveItem. En lecture-écriture. |
| abonnements | collectionabonnement | L’ensemble des abonnements sur l’élément. Prise en charge uniquement sur la racine d’un lecteur. |
| miniatures | collection thumbnailSet | Collection d’objets thumbnailSet associés à l’élément. Pour plus d’informations, consultez Obtention de miniatures. En lecture seule. Pouvant accepter la valeur Null. |
| versions | collectiondriveItemVersion | Liste de toutes les versions précédentes de l’élément. Pour plus d’informations, voir l’obtention de versions précédentes. En lecture seule. Pouvant accepter la valeur Null. |
| workbook | workbook | Pour les fichiers qui sont des feuilles de calcul Excel, accédez à l’API de classeur pour travailler avec le contenu de la feuille de calcul. Pouvant accepter la valeur Null. |
Attributs d’instance
Les attributs d’instance sont des propriétés avec des comportements spéciaux. Ces propriétés sont temporaires et définissent le comportement que le service doit effectuer ou fournissent des valeurs de propriété à court terme, comme une URL de téléchargement pour un élément qui expire.
| Nom de la propriété | Type | Description |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | 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 n’est jamais retourné avec cette annotation. En écriture seule. |
| @microsoft.graph.downloadUrl | string | URL qui peut servir à télécharger le contenu de ce fichier. L’authentification n’est pas requise avec cette URL. En lecture seule. |
| @microsoft.graph.sourceUrl | chaîne | Cette annotation d’instance peut être utilisée pour indiquer au service de télécharger le contenu de l’URL lors de l’émission d’une requête PUT et de la stocker en tant que fichier. En écriture seule. |
Remarque : le paramètre
@microsoft.graph.conflictBehaviordoit être inclus dans l’URL au lieu du corps de la demande.La valeur
@microsoft.graph.downloadUrlest une URL de courte durée et ne peut pas être mise en cache. L’URL est invalidée après pendant une courte période (1 heure). La suppression d’autorisations de fichier pour un utilisateur peut ne pas invalider immédiatement l’URL.L’utilisation de la propriété
@microsoft.graph.sourceUrlpour le chargement du fichier n’est pas prise en charge dans OneDrive Entreprise, SharePoint Online et SharePoint Server 2016.
Représentation JSON
La représentation JSON suivante montre le type de ressource.
La ressource driveItem est dérivée de l’objet baseItem et hérite des propriétés de cette ressource.
{
"audio": { "@odata.type": "microsoft.graph.audio" },
"bundle": { "@odata.type": "microsoft.graph.bundle" },
"content": { "@odata.type": "Edm.Stream" },
"contentStream": { "@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" },
"malware": { "@odata.type": "microsoft.graph.malware" },
"media": { "@odata.type": "microsoft.graph.media" },
"package": { "@odata.type": "microsoft.graph.package" },
"pendingOperations": { "@odata.type": "microsoft.graph.pendingOperations" },
"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,
"source": { "@odata.type": "microsoft.graph.driveItemSource" },
"specialFolder": { "@odata.type": "microsoft.graph.specialFolder" },
"video": { "@odata.type": "microsoft.graph.video" },
"viewpoint": { "@odata.type": "microsoft.graph.driveItemViewpoint" },
"webDavUrl": "string",
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"createdByUser": { "@odata.type": "microsoft.graph.user" },
"retentionLabel": { "@odata.type": "microsoft.graph.itemRetentionLabel" },
"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"
}