Type de ressource DriveItem
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.
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
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.
Représentation JSON
Voici une représentation JSON d’une ressource driveItem.
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" },
"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" },
"malware": { "@odata.type": "microsoft.graph.malware" },
"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"}],
"children": [{ "@odata.type": "microsoft.graph.driveItem" }],
"permissions": [ {"@odata.type": "microsoft.graph.permission"} ],
"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"
}
Propriétés
| Propriété | Type | Description |
|---|---|---|
| audio | audio | Métadonnées audio, si l’élément est un fichier audio. En lecture seule. |
| contenu | Flux | Flux du contenu, si l’élément est un fichier. |
| createdBy | identitySet | Identité de l’utilisateur, du périphérique 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. Remarque Cette propriété n’est pas renvoyé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, du périphérique et de l’application qui ont modifié l’élément en dernier. 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. |
| name | 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. |
| 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 renvoyé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 de partage 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. En lecture seule. |
| video | video | Métadonnées de la vidéo, si l’élément est une vidéo. 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. |
| 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. Pouvant accepter la valeur Null. |
| 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. Peut avoir la valeur Null. |
| miniatures | collection thumbnailSet | 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. |
| 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. |
Attributs d’instance
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.
| 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 ne sera jamais renvoyé avec cette annotation. En écriture seule. |
| @microsoft.graph.downloadUrl | string | 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. |
| @microsoft.graph.sourceUrl | chaîne | 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. |
Note: La @microsoft.graph.downloadUrl valeur est une URL de courte durée et ne peut pas être mise en cache. L’URL sera disponible uniquement pour une courte durée (1 heure) avant qu’elle ne devienne non valide.
Méthodes
| Méthode | Chemin d’accès REST |
|---|---|
| Obtenir un élément | GET /drive/items/{item-id} |
| Répertorier les activités | GET /drive/items/{item-id}/activities |
| Liste de enfants | GET /drive/items/{item-id}/children |
| Liste des versions | GET /drive/items/{item-id}/versions |
| Créer un élément | POST /drive/items/{item-id}/children |
| Mettre à jour un élément | PATCH /drive/items/{item-id} |
| Charger du contenu | PUT /drive/items/{item-id}/content |
| Télécharger du contenu | GET /drive/items/{item-id}/content |
| Télécharger un format de fichier spécifique | GET /drive/items/{item-id}/content?format={format} |
| Supprimer un élément | DELETE /drive/items/{item-id} |
| Déplacer un élément | PATCH /drive/items/{item-id} |
| Copier un élément | POST /drive/items/{item-id}/copy |
| Rechercher des éléments | GET /drive/items/{item-id}/search(q='text') |
| Répertorier les modifications dans un lecteur | GET /drive/root/delta |
| Répertorier les miniatures | GET /drive/items/{item-id}/thumbnails |
| Créer un lien de partage | POST /drive/items/{item-id}/createLink |
| Ajouter des autorisations | POST /drive/items/{item-id}/invite |
| Répertorier les autorisations | GET /drive/items/{item-id}/permissions |
| Supprimer une autorisation | DELETE /drive/items/{item-id}/permissions/{perm-id} |
| Élément Aperçu | POST /drive/items/{item-id}/preview |
Remarques
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.