DriveItem-Ressourcentyp
Die driveItem-Ressource stellt eine Datei, einen Ordner oder ein anderes auf einem Laufwerk gespeichertes Element dar. Alle Dateisystemobjekte in OneDrive und SharePoint werden als driveItem-Ressourcen zurückgegeben.
Es gibt zwei Hauptmethoden zum Adressieren einer driveItem-Ressource:
- Durch den eindeutigen driveItem-Bezeichner unter Verwendung von
drive/items/{item-id} - Durch den Dateisystempfad unter Verwendung von
/drive/root:/path/to/file
DriveItem-Ressourcen verfügen über Facets, die als Eigenschaften modelliert sind, die Daten zu den Identitäten und Funktionen von driveItem bereitstellen. Beispiel:
- Ordner haben ein Ordnerfacet
- Dateien haben ein Dateifacet.
- Bilder haben zusätzlich zu ihrem „file“-Facet ein „image“-Facet.
- Mit einer Kamera aufgenommene Bilder (Fotos) haben ein „photo“-Facet, das die Elemente als Foto identifiziert und als Eigenschaften das Aufnahmedatum sowie das zur Aufnahme verwendete Gerät aufführt.
Elemente mit dem folder-Facet fungieren als Elementcontainer und besitzen daher einen children-Verweis auf eine Sammlung von driveItems im jeweiligen Ordner.
JSON-Darstellung
Es folgt eine JSON-Darstellung einer driveItem-Ressource.
Die driveItem-Ressource wird von baseItem abgeleitet und erbt Eigenschaften von dieser 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"
}
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| audio | audio | Audiometadaten, wenn das Element eine Audiodatei ist. Schreibgeschützt. |
| content | Stream | Der Inhaltsdatenstrom, wenn das Element eine Datei ist |
| createdBy | identitySet | Die Identität des Benutzers, des Geräts und der Anwendung, von denen das Element erstellt wurde. Schreibgeschützt. |
| createdDateTime | DateTimeOffset | Datum und Uhrzeit der Elementerstellung. Schreibgeschützt. |
| cTag | String | Ein ETag für den Inhalt des Elements. Dieses ETag wird nicht geändert, wenn nur die Metadaten geändert werden. Hinweis: Diese Eigenschaft wird nicht zurückgegeben, wenn das Element ein Ordner ist. Schreibgeschützt. |
| gelöscht | deleted | Informationen zum „gelöscht“-Zustand des Elements. Schreibgeschützt. |
| description | Zeichenfolge | Stellt eine für den Benutzer sichtbare Beschreibung des Elements bereit. Lese-/Schreibzugriff. Nur auf OneDrive Personal |
| eTag | String | ETag des gesamten Elements (Metadaten + Inhalt). Schreibgeschützt. |
| file | file | Dateimetadaten, wenn das Element eine Datei ist. Schreibgeschützt. |
| fileSystemInfo | fileSystemInfo | Informationen zum Dateisystem des Clients. Lese-/Schreibzugriff. |
| folder | folder | Ordnermetadaten, wenn das Element ein Ordner ist. Schreibgeschützt. |
| id | String | Der eindeutige Bezeichner des Elements im Laufwerk. Schreibgeschützt. |
| Abbildung | image | Bildmetadaten, wenn das Element ein Bild ist. Schreibgeschützt. |
| lastModifiedBy | identitySet | Die Identität des Benutzers, des Geräts und der Anwendung, von denen das Element zuletzt geändert wurde. Schreibgeschützt. |
| lastModifiedDateTime | DateTimeOffset | Datum und Uhrzeit der letzten Änderung des Elements. Schreibgeschützt. |
| location | geoCoordinates | Standortmetadaten, sofern das Element Standortdaten aufweist. Schreibgeschützt. |
| Schadsoftware | Schadsoftware | Schadsoftware-Metadaten, wenn entdeckt wurde, dass das Element Schadsoftware enthält. Schreibgeschützt. |
| name | String | Der Name des Elements (Dateiname und Erweiterung). Lese-/Schreibzugriff. |
| package | package | Zeigt wenn vorhanden an, dass das Element ein Paket ist statt eines Ordners oder einer Datei. Pakete werden in einigen Kontexten wie Dateien, in anderen Kontexten wie Ordner behandelt. Schreibgeschützt. |
| parentReference | itemReference | Informationen zum übergeordneten Element, wenn das Element ein übergeordnetes Element hat. Lese-/Schreibzugriff. |
| Foto | photo | Fotometadaten, wenn das Element ein Foto ist. Schreibgeschützt. |
| Veröffentlichung | publicationFacet | Stellt Informationen über den veröffentlichten oder ausgecheckten Status eines Elements an Stellen bereit, die solche Aktionen unterstützen. Diese Eigenschaft wird standardmäßig nicht zurückgegeben. Schreibgeschützt. |
| remoteItem | remoteItem | Daten zum Remoteelement, wenn das Element von einem anderen Laufwerk freigegeben ist als dem, auf das zugegriffen wird. Schreibgeschützt. |
| root | root | Wenn diese Eigenschaft nicht Null ist, bedeutet dies, dass es sich bei der driveItem-Ressource um die oberste driveItem-Ressource auf dem Laufwerk handelt. |
| searchResult | searchResult | Suchmetadaten, wenn das Element aus einem Suchergebnis stammt. Schreibgeschützt. |
| freigegeben | shared | Gibt an, dass das Element für andere freigegeben wurde, und enthält den „freigegeben“-Status des Elements. Schreibgeschützt. |
| sharepointIds | sharepointIds | Gibt Bezeichner zurück, die für SharePoint REST-Kompatibilität nützlich sind. Schreibgeschützt. |
| size | Int64 | Größe des Elements in Byte. Schreibgeschützt. |
| specialFolder | specialFolder | Facet, das zurückgegeben wird, wenn das aktuelle Element auch als spezieller Ordner verfügbar ist. Schreibgeschützt. |
| video | video | Videometadaten, wenn das Element ein Video ist. Schreibgeschützt. |
| webDavUrl | String | WebDAV-kompatible URL für das Element. |
| webUrl | String | URL, über die die Ressource im Browser angezeigt werden kann. Schreibgeschützt. |
Hinweis: Die Eigenschaften eTag und cTag funktionieren in Containern (Ordnern) unterschiedlich. Der cTag-Wert wird geändert, wenn Inhalt oder Metadaten eines Nachfolgers des Ordners geändert werden. Der eTag-Wert wird nur geändert, wenn die Eigenschaften des Ordners geändert werden, mit Ausnahme von Eigenschaften, die von Nachfolgern abgeleitet werden (z. B. childCount oder lastModifiedDateTime).
Beziehungen
| Beziehung | Typ | Beschreibung |
|---|---|---|
| Aktivitäten | ItemActivity-Sammlung | Die Liste der letzten Aktivitäten, die für dieses Element durchgeführt wurden. |
| Untergeordnetes Element | driveitem-Sammlung | Sammlung von Elementobjekten der direkten untergeordneten Elemente eines Elements. Nur Elemente, die Ordner repräsentieren, haben untergeordnete Elemente. Schreibgeschützt. Nullwerte zulassend. |
| listItem | listItem | Für Laufwerke in SharePoint das zugehörige Dokumentbibliothek-Listenelement. Schreibgeschützt. Lässt Nullwerte zu. |
| Berechtigungen | permission collection | Der Satz von Berechtigungen für das Element. Schreibgeschützt. Lässt Nullwerte zu. |
| thumbnails | thumbnailSet-Auflistung | Sammlung der dem Element zugeordneten ThumbnailSet-Objekte. Weitere Informationen finden Sie im Artikel zum Abrufen von Miniaturansichten. Schreibgeschützt. Nullwerte zulassend. |
| versions | driveItemVersion-Sammlung | Die Liste der früheren Versionen des Elements. Weitere Informationen finden Sie unter Abrufen früherer Versionen. Schreibgeschützt. Nullwerte zulassend. |
Instanzenattribute
Instanzattribute sind Eigenschaften mit besonderem Verhalten. Diese Eigenschaften sind temporär und definieren entweder a) das Verhalten, das der Dienst ausführen soll, oder b) stellen kurzfristige Eigenschaftswerte bereit, z. B. eine Download-URL für ein Element, das abläuft.
| Eigenschaftenname | Typ | Beschreibung |
|---|---|---|
| @microsoft.graph.conflictBehavior | string | Das Konfliktlösungsverhalten von Aktionen, die ein neues Element erstellen. Verwenden Sie die Werte fail, replace oder rename. Das Standardformat für PUT ist replace. Ein Element wird nie mit dieser Anmerkung zurückgegeben. Schreibzugriff. |
| @microsoft.graph.downloadUrl | string | Eine URL, über die die Inhalte der Datei heruntergeladen werden können. Eine Authentifizierung ist mit dieser URL nicht erforderlich. Schreibgeschützt. |
| @microsoft.graph.sourceUrl | string | Bei Ausgabe einer PUT-Anforderung kann der Dienst mithilfe dieser Instanzanmerkung angewiesen werden, den Inhalt der URL herunterzuladen und als diese Datei zu speichern. Schreibzugriff. |
Hinweis: Der @microsoft.graph.downloadUrl Wert ist eine kurzlebige URL und kann nicht zwischengespeichert werden. Die URL ist nur für kurze Zeit (1 Stunde) verfügbar, bevor sie ungültig wird.
Methoden
| Methode | REST-Pfad |
|---|---|
| Get item | GET /drive/items/{item-id} |
| Aktivitäten auflisten | GET /drive/items/{item-id}/activities |
| Untergeordnete Elemente auflisten | GET /drive/items/{item-id}/children |
| Versionen auflisten | GET /drive/items/{item-id}/versions |
| Element erstellen | POST /drive/items/{item-id}/children |
| Update item | PATCH /drive/items/{item-id} |
| Upload content | PUT /drive/items/{item-id}/content |
| Inhalte herunterladen | GET /drive/items/{item-id}/content |
| Herunterladen eines bestimmten Dateiformats | GET /drive/items/{item-id}/content?format={format} |
| Element löschen | 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') |
| List changes in a drive | 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 |
| Berechtigung löschen | DELETE /drive/items/{item-id}/permissions/{perm-id} |
| Element in Vorschau anzeigen | POST /drive/items/{item-id}/preview |
Hinweise
In OneDrive for Business- oder SharePoint-Dokumentbibliotheken wird die Eigenschaft cTag nicht zurückgegeben, wenn die driveItem-Ressource ein Ordner-Facet hat.