Ressourcentyp „driveItem“
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Stellt eine Datei, einen Ordner oder ein anderes Element dar, das auf einem Laufwerk gespeichert ist.
Alle Dateisystemobjekte in OneDrive und SharePoint werden als driveItem-Ressourcen zurückgegeben. Elemente in SharePoint-Dokumentbibliotheken können als listItem- oder driveItem-Ressourcen dargestellt werden.
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
Weitere Informationen finden Sie unter Adressierung von driveItems.
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.
Anmerkung: In OneDrive for Business- oder SharePoint-Dokumentbibliotheken wird die cTag-Eigenschaft nicht zurückgegeben, wenn das driveItem-Element über ein Ordnerfacet verfügt.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Get item | driveItem | Rufen Sie die Metadaten für ein driveItem-Objekt auf einem Laufwerk ab. |
| Analysen abrufen | itemAnalytics | Abrufen von Analysen für diese Ressource. |
| Aktivitäten nach Intervall abrufen | itemActivityStat | Eine Sammlung von itemActivityStats innerhalb des angegebenen Zeitintervalls abrufen. |
| List children (Untergeordnete Elemente auflisten) | driveItem-Sammlung | Gibt eine Auflistung von driveItems in der untergeordneten Beziehung eines driveItem zurück. |
| Versionen auflisten | driveItemVersion-Sammlung | Rufen Sie die Versionen einer Datei auf dem Laufwerk des aktuellen Benutzers ab. |
| Ordner erstellen | driveItem | Erstellen Sie ein driveItem-Objekt auf dem angegebenen Laufwerk. |
| Update item | driveItem | Aktualisieren Sie ein driveItem-Element auf dem Laufwerk. |
| Hochladen | driveItem | Laden Sie Inhalte in das driveItem-Objekt hoch. |
| Herunterladen von Dateiinhalten | Stream | Laden Sie die Inhalte des primären Streams (Datei) eines driveItem herunter. |
| Herunterladen eines bestimmten Dateiformats | Download-URL | Laden Sie den Inhalt eines driveItem-Objekts mit einem bestimmten Format herunter. |
| Element löschen | Keine | Löschen sie ein driveItem-Objekt. |
| Element endgültig löschen | Keine | Löschen Sie ein driveItem-Objekt dauerhaft mithilfe seiner ID. |
| Move item | driveItem | Verschieben sie ein driveItem-Objekt in ein neues übergeordnetes Element. |
| Element kopieren | detaillierte Informationen zum Überwachen des Status der Kopie | Erstellen Sie eine Kopie eines driveItem -Objekts (einschließlich aller untergeordneten Elemente). |
| Elemente suchen | driveItem-Sammlung | Durchsuchen Sie die Hierarchie der Elemente nach Elementen, die mit einer Abfrage übereinstimmen. |
| Änderungen nachverfolgen | Delta-Link | Alle Änderungen im Laufwerk auflisten. |
| Element folgen | driveItem | Folgen Sie einem driveItem-Objekt. |
| Element nicht folgen | Keine | Einem driveItem-Objekt nicht folgen. |
| Miniaturansichten abrufen | driveItem-Sammlung | Listen Sie driveItems mit ihren Miniaturansichten auf. |
| Create sharing link | Freigabelink | Erstellen Sie einen Link, um das driveItem-Objekt zu teilen. |
| Add permissions | permission collection | Senden einer Freigabeseinladung an einen Benutzer. |
| Berechtigungen auflisten | permission collection | Rufen Sie die Auflistung von Berechtigungen für ein driveItem ab. |
| Berechtigung erstellen | permission | Erstellen Sie eine Berechtigung für ein driveItem-Objekt. |
| Berechtigung löschen | Keine | Entfernen Sie die Berechtigung aus driveItem. |
| Widerrufen von Zuweisungen bei Freigabelink | permission | Widerrufen Sie den Zugriff auf ein listItem- oder driveItem-Objekt, das über einen Freigabelink gewährt wird, indem Sie den angegebenen Empfänger aus dem Link entfernen. |
| WebSocket-Kanal erhalten | subscription | Empfangen von Änderungsbenachrichtigungen für ein Laufwerk nahezu in Echtzeit mithilfe von socket.io. |
| Element in Vorschau anzeigen | JSON-Objekt | Erhalten Sie kurzzeitig einbindbare URLs für ein Element, um eine temporäre Vorschau zu erstellen. |
| Dateien einchecken | Keine | Checken Sie eine ausgecheckte driveItem-Ressource ein, die die Version des Dokuments für andere Personen verfügbar macht. |
| Dateien auschecken | Keine | Checken Sie eine driveItem-Ressource aus, um zu verhindern, dass andere Personen das Dokument bearbeiten, und verhindern Sie, dass Ihre Änderungen sichtbar sind, bis die dokumentierte Ressource eingecheckt ist. |
| Auschecken verwerfen | Keine | Verwerfen eines zuvor ausgechecktendriveItem-Objekts. |
| Extrahieren von Vertraulichkeitsbezeichnungen | extractSensitivityLabelsResult | Extrahieren Sie eine oder mehrere Vertraulichkeitsbezeichnungen, die einem Laufwerkselement zugewiesen sind, und aktualisieren Sie die Metadaten eines Laufwerkelements mit den neuesten Details der zugewiesenen Bezeichnung. |
| Vertraulichkeitsbezeichnung zuweisen | Zeichenfolge | Asynchrones Zuweisen einer Vertraulichkeitsbezeichnung zu einem driveItem. |
| Abrufen der Aufbewahrungsbezeichnung | itemRetentionLabel | Abrufen von Metadateninformationen für eine Aufbewahrungsbezeichnung, die auf ein driveItem-Objekt angewendet wird. |
| Festlegen der Aufbewahrungsbezeichnung | itemRetentionLabel | Anwenden (Festlegen) einer Aufbewahrungsbezeichnung auf ein driveItem -Objekt (Dateien und Ordner). |
| Entfernen der Aufbewahrungsbezeichnung | Keine | Entfernen Sie eine Aufbewahrungsbezeichnung aus einem driveItem.Remove a retention label from a driveItem. |
| Sperren oder Entsperren des Datensatzes | itemRetentionLabel | Sperren oder Entsperren einer Aufbewahrungsbezeichnung für ein driveItem-Objekt , das Inhalte als Datensätze klassifiziert. |
| Datei herunterladen (veraltet) | Download-URL | Laden Sie den Inhalt eines driveItem-Objekts herunter. |
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| audio | audio | Audiometadaten, wenn das Element eine Audiodatei ist. Schreibgeschützt. Nur auf OneDrive Personal. |
| bundle | Bündel | Bündelmetadaten, wenn das Element ein Bündel ist. Schreibgeschützt. |
| Inhalt (veraltet) | Stream | Der Inhaltsdatenstrom, wenn das Element eine Datei ist Die Inhaltseigenschaft wird in Zukunft möglicherweise eine breaking Änderung des Verhaltens aufweisen. Inhalte werden direkt gestreamt, anstatt umzuleiten. Um das neue Verhalten proaktiv zu aktivieren, verwenden Sie stattdessen die contentStream-Eigenschaft . |
| contentStream | Stream | Der Inhaltsdatenstrom, wenn das Element eine Datei ist |
| createdBy | identitySet | Identität des Benutzers, geräts und der Anwendung, die das Element erstellt haben. 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. Anmerkung 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 | Identität des Benutzers, geräts und der Anwendung, die das Element zuletzt geändert hat. 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. |
| media | media | Informationen zum Medienelement (Audio oder Video). Lese-/Schreibzugriff. Nur auf OneDrive for Business und SharePoint. |
| 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. |
| pendingOperations | pendingOperations | Falls vorhanden, gibt an, dass mindestens ein Vorgang, der sich auf den Zustand des driveItem auswirken kann, aussteht. Schreibgeschützt. |
| photo | 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 stellt Informationen zum freigegebenen Zustand des Elements bereit. 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. |
| source | driveItemSource | Informationen zur Laufwerkelementquelle. Schreibgeschützt. Nur auf OneDrive for Business und SharePoint. |
| video | video | Videometadaten, wenn das Element ein Video ist. Schreibgeschützt. |
| Aussichtspunkt | driveItemViewpoint | Gibt spezifische Informationen für den aufrufenden Benutzer für dieses Laufwerkselement zurück. 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. |
Anmerkung: 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 sind (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. |
| Analysen | itemAnalytics-Ressource | Analysen zu den Anzeigeaktivitäten, die auf diesem Element stattgefunden haben. |
| Untergeordnetes Element | driveitem-Sammlung | Sammlung von Elementobjekten der direkten untergeordneten Elemente eines Elements. Nur Elemente, die Ordner repräsentieren, haben untergeordnete Elemente. Schreibgeschützt. Lässt Nullwerte zu. |
| createdByUser | user | Der Name des Benutzers, der das Element erstellt hat. Schreibgeschützt. |
| lastModifiedByUser | user | Der Name des Benutzers, der das Element zuletzt geändert hat. Schreibgeschützt. |
| 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. Nullwerte zulassend. |
| retentionLabel | itemRetentionLabel | Informationen zur Aufbewahrungsbezeichnung und einstellungen, die für das driveItem erzwungen werden. Lese-/Schreibzugriff. |
| Abonnements | Abonnement-Sammlung | Die Gruppe von Abonnements für das Element. Wird nur im Stammordner eines Laufwerks unterstützt. |
| thumbnails | thumbnailSet collection | Auflistung von thumbnailSet-Objekten , die dem Element zugeordnet sind. Weitere Informationen finden Sie unter 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. |
| workbook | workbook | Für Dateien, bei denen es sich um Excel-Kalkulationstabellen handelt, greifen Sie auf die Arbeitsmappen-API zu, um mit dem Inhalt der Kalkulationstabelle zu arbeiten. Nullwerte zulassend. |
Instanzenattribute
Instanzattribute sind Eigenschaften mit besonderem Verhalten. Diese Eigenschaften sind temporär und definieren entweder das Verhalten, das der Dienst ausführen soll, oder 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 | Zeichenfolge | Eine URL, über die die Inhalte der Datei heruntergeladen werden können. Für diese URL ist keine Authentifizierung erforderlich. Schreibgeschützt. |
| @microsoft.graph.sourceUrl | string | Diese Instanzanmerkung kann verwendet werden, um den Dienst anzuweisen, den Inhalt der URL beim Ausgeben einer PUT-Anforderung herunterzuladen und als Datei zu speichern. Schreibzugriff. |
Hinweis: Der Parameter
@microsoft.graph.conflictBehaviorsollte in der URL und nicht im Textkörper der Anfrage enthalten sein.Der Wert
@microsoft.graph.downloadUrlist eine kurzlebige URL und kann nicht zwischengespeichert werden. Die URL wird nach für einen kurzen Zeitraum (1 Stunde) ungültig. Beim Entfernen von Dateiberechtigungen für einen Benutzer wird die URL möglicherweise nicht sofort ungültig.Die
@microsoft.graph.sourceUrl-Eigenschaft für den Dateiupload wird in OneDrive for Business, SharePoint Online und SharePoint Server 2016 nicht unterstützt.
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
Die driveItem-Ressource wird von baseItem abgeleitet und erbt Eigenschaften von dieser 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"
}