Dateien und Ordner - REST API-Referenz

Artikel
09/29/2016

Erfahren Sie mehr über die REST-API für File, FileVersion, Folder und die dazugehörigen Ressourcen.

Letzte Änderung: Donnerstag, 17. September 2015

Gilt für: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Informationen zu den Anforderungsbeispielen in diesem Artikel

In den Anforderungsbeispielen in diesem Artikel wird davon ausgegangen, dass Sie die domänenübergreifende Bibliothek (SP.RequestExecutor.js) verwenden, um domänenübergreifende Anforderungen zu erstellen, sodass sie die SP.AppContextSite in der Endpunkt-URI verwenden. Weitere Informationen finden Sie unter Zugreifen auf SharePoint 2013-Daten über Add-Ins mithilfe der domänenübergreifenden Bibliothek.

Führen Sie folgende Schritte durch, bevor Sie ein Anforderungsbeispiel verwenden:

Ändern Sie die <App-Web-URL>, <Hostweb-URL> und sonstige Platzhalterdaten wie die IDs, Namen oder Pfade der SharePoint-Entitäten.
Wenn Sie nicht die domänenübergreifende Bibliothek verwenden, müssen Sie eine X-RequestDigest-Kopfzeile verwenden, um den Formulardigestwert in allen POST-Anforderungen zu senden und eine content-length-Kopfzeile für POST-Anforderungen, die Daten im Anforderungstext senden.
Wenn Sie keine domänenübergreifenden Anforderungen erstellen, müssen Sie die SP.AppContextSite(@target) und ?@target='<host web url>' aus der Endpunkt-URI entfernen.
Wenn Sie OAuth verwenden, müssen Sie eine Authorization-Kopfzeile ("Authorization": "Bearer " + <access token>) einbeziehen, um den OAuth-Zugriffstoken zu senden.
Entfernen Sie die Zeilenumbrüche aus der url und den body-Eigenschaftswerten in den Anforderungsbeispielen. Zeilenumbrüche werden zu Beispielen hinzugefügt, damit sie leichter zu lesen sind.
Wenn der Server Antworten im Atomformat zurückgibt, müssen Sie die "accept": "application/json; odata=verbose"-Kopfzeile entfernen.

Links zu weiteren Informationen zum Verwenden der domänenübergreifenden Bibliothek, OAuth, und dem SharePoint-REST-Dienst finden Sie unter Zusätzliche Ressourcen. Weitere Informationen zu Anforderungsformaten finden Sie unter So unterscheiden sich REST-Anforderungen je nach Umgebung und In REST-Anforderungen verwendete Eigenschaften.

Tipp

Der SharePoint Online-REST-Dienst unterstützt die Kombination mehrerer Anforderungen in einem einzelnen Dienstaufruf mithilfe der OData-Abfrageoption $batch. Einzelheiten und Links zu Codebeispielen finden Sie unter Erstellen von Batchanforderungen mit den REST-APIs. Diese Option wird für lokales SharePoint noch nicht unterstützt.

Erfahren Sie mehr über SharePoint 2013-Dateien und Ordern in der REST-Syntax

Weitere Informationen zu den SharePoint 2013-Listen und Listenelementen in der REST-Syntax.

Weitere SharePoint REST-Syntaxdiagramme:

Listen und Listenelemente | Benutzer und Gruppen

Laden Sie das PDF-Dokument aller SharePoint-REST-Syntaxdiagramme herunter.

Dateiressource

Steht für eine Datei auf einer SharePoint-Website, bei der es sich um eine Webpartseite, um ein Element in einer Dokumentbibliothek oder um eine Datei in einem Ordner handeln kann.

Endpunkt-URI | Eigenschaften | Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/getfilebyserverrelativeurl('/<Ordnername>/<Dateiname>')

Unterstützte HTTP-Methoden

GET | PUT (media-Ressource)

GET | DELETE | POST (File-Ressource)

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen von Dateiinhalten (media-Ressource)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen der Dateimetadaten

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

PUT-Anforderungsbeispiel: Aktualisieren von Dateiinhalten (media-Ressource)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.txt')/$value
    ?@target='<host web url>'",
  method: "POST",
  body: "Updated contents of the file go here",
  headers: { "X-HTTP-Method":"PUT" },
  success: successHandler,
  error: errorHandler
});

Checken Sie die Datei zunächst aus, damit andere Benutzer sie nicht ändern können. Checken Sie sie anschließend wieder ein, nachdem Sie die Änderungen vorgenommen haben. Siehe CheckOut-Methode und CheckIn-Methode.

DELETE-Anforderungsbeispiel: Löschen einer Datei

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die Recycle-Methode verwenden, um die Datei zu entfernen und die GUID des wiederverwendeten Elements abzurufen.

Hinweis

Ein Beispiel zum Erstellen einer Datei und Hinzufügen der Datei zu einem Ordner finden Sie unter Methode hinzufügen.

Dateieigenschaften

Senden Sie zum Abrufen einer Eigenschaft eine GET-Anforderung an den Eigenschaftsendpunkt wie im folgenden Beispiel.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft	Typ	R/W	Mit Ressource zurückgegeben	Beschreibung
Author	SP.User	R	Nein	Ruft einen Wert ab, der den Benutzer angibt, der die Datei hinzugefügt hat.
CheckedOutByUser	SP.User	R	Nein	Ruft einen Wert ab, der den Benutzer zurückgibt, von dem die Datei ausgecheckt wurde.
CheckInComment	String	R	Ja	Ruft einen Wert ab, der den Kommentar zurückgibt, der beim Einchecken eines Dokuments in die Dokumentbibliothek verwendet wurde.
CheckOutType	Int32	R	Ja	Ruft einen Wert ab, der angibt, wie die Datei aus einer Dokumentbibliothek ausgecheckt wird. Stellt einen SP.CheckOutType-Wert dar: Online = 0; Offline = 1; None = 2. Der Checkout-Status einer Datei hängt nicht von ihrer Sperrung ab.
ContentTag	String	R	Ja	Gibt eine interne Version des Inhalts zurück, der zum Validieren der Dokumentparität für Lesezwecke dient.
CustomizedPageStatus	Int32	R	Ja	Ruft einen Wert ab, der den Anpassungsstatus der Datei angibt. Stellt einen SP.CustomizedPageStatus-Wert dar: None = 0; Uncustomized = 1; Customized = 2.
ETag	String	R	Ja	Ruft einen Wert ab, der den ETag-Wert angibt.
Exists	Boolean	R	Ja	Ruft einen Wert ab, der angibt, ob die Datei vorhanden ist.
Length	Int64	R	Ja	Ruft die Größe der Datei in Bytes ohne die Größe beliebiger Webparts ab, die in der Datei verwendet werden.
Level	Byte	R	Ja	Ruft einen Wert ab, der die Veröffentlichungsebene der Datei angibt. Stellt einen SP.FileLevel-Wert dar: Published = 1; Draft = 2; Checkout = 255.
ListItemAllFields	SP.ListItem	R	Nein	Ruft einen Wert ab, der die Listenelement-Feldwerte für das Listenelement angibt, das der Datei entspricht.
LockedByUser	SP.User	R	Nein	Ruft einen Wert ab, der den Benutzer zurückgibt, bei dem es sich um den Besitzer der aktuellen Sperre für die Datei handelt.
MajorVersion	Int32	R	Ja	Ruft einen Wert ab, der die Hauptversion der Datei angibt.
MinorVersion	Int32	R	Ja	Ruft einen Wert ab, der die Nebenversion der Datei angibt.
ModifiedBy	SP.User	R	Nein	Ruft einen Wert ab, der den Benutzer zurückgibt, von dem die Datei zuletzt geändert wurde.
Name	String	R	Ja	Ruft den Namen der Datei einschließlich Erweiterung ab.
ServerRelativeUrl	String	R	Ja	Ruft die relative URL der Datei auf der Grundlage der URL für den Server ab.
TimeCreated	DateTime	R	Ja	Ruft einen Wert ab, der angibt, wann die Datei erstellt wurde.
TimeLastModified	DateTime	R	Ja	Ruft einen Wert ab, der angibt, wann die Datei zuletzt geändert wurde.
Title	String	R	Ja	Ruft einen Wert ab, der den Anzeigenamen der Datei angibt.
UiVersion	Int32	R	Ja	Ruft einen Wert ab, der den implementierungsspezifischen Versionsbezeichner der Datei angibt.
UiVersionLabel	String	R	Ja	Ruft einen Wert ab, der den implementierungsspezifischen Versionsbezeichner der Datei angibt.
Versions	SP.FileVersionCollection	R	Nein	Ruft einen Wert ab, der eine Sammlung von Dateiversionsobjekten zurückgibt, die für die Versionen der Datei stehen.

File-Methoden

Approve
CancelUpload
CheckIn
CheckOut
ContinueUpload
CopyTo
DeleteObject
Deny
FinishUpload
GetLimitedWebPartManager
MoveTo
OpenBinaryStream
Publish
Recycle
SaveBinaryStream
StartUpload
UndoCheckOut
Unpublish

Genehmigen

Genehmigt die zur Inhaltsgenehmigung übermittelte Datei mit dem angegebenen Kommentar.

Es können nur Dokumente in Listen genehmigt werden, bei denen die Inhaltsgenehmigung aktiviert ist.

Endpunkt	/approve(comment)
Parameter	comment Typ: String Der Kommentar der Genehmigung.
HTTP-Methode	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /approve(comment='Check-in comment for the approval.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

CancelUpload-Methode

Beendet die Blockuploadsitzung ohne Speichern der hochgeladenen Daten. Wenn die Datei in der Bibliothek noch nicht vorhanden ist, wird die teilweise hochgeladene Datei gelöscht. Verwenden Sie dies als Antwort auf Benutzeraktionen (z. B. in einer Anforderung zum Abbrechen eines Uploads) oder einen Fehler oder eine Ausnahme.

Verwenden Sie den uploadId-Wert, der an die StartUpload-Methode übergeben wurde, die Uploadsitzung gestartet hat.

Diese Methode ist derzeit nur in Office 365 verfügbar.

Endpoint	/cancelupload(uploadId)
Parameters	uploadID Typ: GUID Der eindeutige Bezeichner der Uploadsitzung.
HTTP method	POST
Response	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /cancelupload(uploadId=guid'GUID')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

CheckIn-Methode

Checkt die Datei auf der Grundlage des Einchecktyps in eine Dokumentbibliothek ein.

Endpoint	/checkin(comment, checkInType)
Parameters	comment Typ: String Ein Kommentar für das Einchecken. Die Länge muss <= 1023 betragen. checkInType Typ: Int32 Der SP.CheckinType der Datei: MinorCheckIn = 0; MajorCheckIn = 1; OverwriteCheckIn = 2.
HTTP method	POST
Response	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /checkin(comment='Check-in comment.',checkintype=0)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

CheckOut-Methode

Checkt die Datei auf der Grundlage des Auschecktyps aus einer Dokumentbibliothek aus.

Endpoint	/checkout
Parameters	Keine
HTTP method	POST
Response	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /checkout
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

ContinueUpload-Methode

Setzt die Blockuploadsitzung mit einem zusätzlichen Fragment fort. Der aktuelle Dateiinhalt wird nicht geändert.

Verwenden Sie den uploadId-Wert, der an die StartUpload-Methode übergeben wurde, die Uploadsitzung gestartet hat.

Diese Methode ist derzeit nur in Office 365 verfügbar.

Endpoint	/continueupload(uploadId, fileOffset)
Parameters	uploadID Typ: GUID Der eindeutige Bezeichner der Uploadsitzung. fileOffset Typ: Int64 Die Größe des Offsets in der Datei, bei dem das Fragment beginnt. Senden Sie die Dateiinhalte (Stream) im Beitragtext.
HTTP method	POST
Response	Typ: Int64 Die Größe der gesamten hochgeladenen Daten in Byte.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /continueupload(uploadId=guid'GUID',fileOffset=8388608)
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing intermediate chunk of file
  success: successHandler,
  error: errorHandler
});

CopyTo-Methode

Kopiert die Datei an die Ziel-URL.

Endpunkt	/copyto(strNewUrl, bOverWrite)
Parameter	strNewUrl Typ: String Die absolute URL oder die serverrelative URL des Zieldateipfads, auf den Elemente kopiert werden sollen. bOverWrite Typ: Boolean true, wenn eine Datei mit demselben Namen an demselben Speicherort überschrieben wird; andernfalls false.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /copyto(strnewurl='/foldername/filename.docx',boverwrite=false)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

DeleteObject-Methode

Die empfohlene Option zum Löschen einer Datei ist das Senden einer DELETE-Anforderung an den File-Ressourcenendpunkt, wie in File-Anforderungsbeispiele gezeigt.

Deny-Methode

Verweigert die Genehmigung für eine Datei, die zur Inhaltsgenehmigung übermittelt wurde.

Es können nur Dokumente in Listen verweigert werden, bei denen die Inhaltsgenehmigung aktiviert ist.

Endpunkt	/deny(comment)
Parameter	comment Type: String Der Kommentar der Verweigerung.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /deny(comment='Check-in comment for the denial.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

FinishUpload-Methode

Lädt das letzte Dateifragment hoch und für einen Commit der Datei aus. Der aktuelle Dateiinhalt wird geändert, wenn diese Methode abgeschlossen wird.

Verwenden Sie den uploadId-Wert, der an die StartUpload-Methode übergeben wurde, die Uploadsitzung gestartet hat.

Diese Methode ist derzeit nur in Office 365 verfügbar.

Endpoint	/finishupload(uploadId, fileOffset)
Parameters	uploadID Typ: GUID Der eindeutige Bezeichner der Uploadsitzung. fileOffset Typ: Int64 Die Größe des Offsets in der Datei, bei dem das Fragment beginnt. Senden Sie die Dateiinhalte (Stream) im Beitragtext.
HTTP method	POST
Response	Typ: SP.File Die neu hochgeladene Datei.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /finishupload(uploadId=guid'GUID',fileOffset=125829120)
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing final chunk of file
  success: successHandler,
  error: errorHandler
});

GetLimitedWebPartManager-Methode

Gibt den Steuerelementsatz zum Aufrufen, Ändern oder Hinzufügen von Webparts in Verbindung mit dieser Webpartseite und -ansicht an.

Eine Ausnahme wird ausgelöst, wenn die Datei keine ASPX-Seite ist.

Endpunkt	/getlimitedwebpartmanager(scope)
Parameter	scope Typ: Int32 Die SP.WebParts.PersonalizationScope-Ansicht im Webparts-Seite. User = 0; Shared = 1.
HTTP method	GET
Antwort	Typ: SP.WebParts.LimitedWebPartManager Der zum Zugreifen, Ändern oder Hinzufügen von Webparts verwendete zugeordnete Steuerelementsatz.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/fileName.aspx')
    /getlimitedwebpartmanager(scope=0)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

MoveTo-Methode

Verschiebt die Datei an die angegebene Ziel-URL.

Endpunkt	/moveto(newUrl, flags)
Parameter	newUrl Typ: String Die absolute URL oder die serverrelative URL des Zieldateipfads, auf den Elemente verschoben werden sollen. flags Typ: Int32 der bitweise SP.MoveOperations-Wert zum Verschieben der Datei. Overwrite = 1; AllowBrokenThickets (verschieben, selbst wenn unterstützende Dateien von der Datei getrennt sind) = 8.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /moveto(newurl='/Other Folder/filename.docx',flags=1)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

OpenBinaryStream-Methode

Öffnet die Datei als Stream.

Endpunkt	/openbinarystream
Parameter	Keine
HTTP method	GET
Antwort	Typ: Stream Der angegebene Datei-Stream.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /openbinarystream
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Hinweis

Sie können auch den $value aus der Dateiressource verwenden, um eine Datei zu öffnen. Beispiel: …/getfilebyserverrelativeurl('/Shared Documents/filename.docx')/$value.

Publish-Methode

Übermittelt die Datei mit dem angegebenen Kommentar zur Inhaltsgenehmigung.

Endpunkt	/publish(comment)
Parameter	comment Typ: String Der Kommentar der veröffentlichten Datei. Die Länge muss <= 1023 betragen.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /publish(comment='Check-in comment for the publish operation.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Recycle-Methode

Verschiebt die Datei in den Papierkorb und gibt den Bezeichner des neuen Papierkorbelements zurück.

Endpunkt	/recycle
Parameter	Keine
HTTP method	POST
Antwort	Typ: GUID Die GUID der wiederverwendeten Datei.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

SaveBinaryStream-Methode

Endpunkt	/savebinary
Parameter	Senden Sie die Dateiinhalte (Stream) im Beitragtext.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /savebinarystream
    ?@target='<host web url>'",
  method: "POST",
  body: "This is the new content.",
  success: successHandler,
  error: errorHandler
});

StartUpload-Methode

Startet eine neue Uploadsitzung für einen Abschnitt und lädt das erste Fragment hoch. Der aktuelle Inhalt der Datei wird nicht geändert, wenn diese Methode abgeschlossen wird. Die Methode ist idempotent (und das Ergebnis wird somit nicht geändert), solange Sie dieselben Werte für uploadId und stream verwenden. Die Uploadsitzung endet, wenn Sie die CancelUpload-Methode verwenden oder wenn Sie die Uploadsitzung erfolgreich abschließen, indem Sie den restlichen Inhalt der Datei an die Methoden ContinueUpload und FinishUpload übergeben.

Beispielsweise können Sie eine 35-MB-Datei übergeben, indem Sie sie in drei Streams von 10 MB und einen Stream von 5 MB aufteilen und auf diese Weise (mit den resultierenden Offsetwerten 10, 20 und 30 MB) hochladen:

startUpload(GUID, stream1)
continueUpload(GUID, 10 MB, stream2)
continueUpload(GUID, 20 MB, stream3)
finishUpload(GUID, 30 MB, stream4)

Die Methoden StartUpload und ContinueUpload geben die Größe der laufenden Summe der hochgeladenen Daten in Byte zurück. Diese Werte können Sie an nachfolgende Aufrufe von ContinueUpload und FinishUpload übergeben.

Diese Methode ist derzeit nur in Office 365 verfügbar.

Endpoint	/startupload(uploadId)
Parameters	uploadID Typ: GUID Der eindeutige Bezeichner der Uploadsitzung. Senden Sie die Dateiinhalte (Stream) im Beitragtext.
HTTP method	POST
Response	Typ: Int64 Die Größe der hochgeladenen Daten in Byte.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /startupload(uploadId=guid'GUID')
    ?@target='<host web url>'",
  method: "POST",
  body: stream containing first chunk of file
  success: successHandler,
  error: errorHandler
});

UndoCheckOut-Methode

Macht einen bestehenden Auscheckvorgang für die Datei rückgängig.

Endpunkt	/undocheckout
Parameter	Keine
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /undocheckout
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

Unpublish-Methode

Entfernt die Datei aus der Inhaltsgenehmigung oder macht die Veröffentlichung einer Hauptversion rückgängig.

Endpunkt	/unpublish
Parameter	comment Typ: String Der Kommentar zum unveröffentlichten Vorgang. Die Länge muss <= 1023 betragen.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /unpublish(comment='Check-in comment for the unpublish operation.')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

Das folgende Beispiel stellt eine File-Ressource im JSON-Format dar.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName.docx')",
        "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')",
        "type":"SP.File"
      },
      "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/Author"}},
      "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/CheckedOutByUser"}},
      "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/ListItemAllFields"}},
      "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/LockedByUser"}},
      "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/ModifiedBy"}},
      "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName.docx')/Versions"}},
      "CheckInComment":"Revisions to the file.",
      "CheckOutType":2,
      "ContentTag":"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},2,3",
      "CustomizedPageStatus":0,
      "ETag":"\"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},2\"",
      "Exists":true,
      "Length":"20609",
      "Level":1,
      "MajorVersion":1,
      "MinorVersion":0,
      "Name":"fileName.docx",
      "ServerRelativeUrl":"/Shared Documents/folderName/fileName.docx",
      "TimeCreated":"2013-05-16T21:01:23Z",
      "TimeLastModified":"2013-05-18T04:57:32Z",
      "Title":"",
      "UIVersion":512,
      "UIVersionLabel":"1.0"
    }}

FileCollection-Ressource

Stellt eine Sammlung von File-Ressourcen dar.

Endpunkt-URI | Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/getfolderbyserverrelativeurl('/<Ordnername>')/files

Unterstützte HTTP-Methoden

GET | POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen der Metadaten aller Dateien in einem Ordner

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen der Dateiinhalte (media-Ressource) nach Dateiname

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files('filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen der Dateimetadaten

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files('filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
};

Beispiele zum Abrufen einer Datei mit dem GetFileByServerRelativeUrl-Endpunkt sowie zum Aktualisieren und Löschen einer Datei finden Sie unter Methode hinzufügen File-Anforderungsbeispiele.

FileCollection-Methoden

Add
AddTemplateFile
GetByUrl

Methode hinzufügen

Endpunkt	/add(content, overwrite, url)
Parameter	content Typ: Stream Der Inhalt der Datei. Übergeben Sie den content-Parameter im Anforderungstext. Mit der REST-API können Binärdateien mit einer Größe von bis zu 2 GB hinzugefügt werden. overwrite Typ: Boolean true, wenn eine bereits vorhandene Datei überschrieben wird, andernfalls false. url Typ: String Die ordnerrelative URL der Datei.
HTTP method	POST
Antwort	Typ: SP.File Die neue Datei.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/files
    /add(overwrite=true,url='filename.txt')
    ?@target='<host web url>'",
  method: "POST",
  body: "Contents of the file go here",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Das folgende Beispiel veranschaulicht das Hochladen einer Binärdatei mithilfe der domänenübergreifenden Bibliothek, was das Konvertieren des Dateistreams in eine Zeichenfolge erfordert. Ein jQuery-Beispiel finden Sie unter Hochladen einer Datei mit der REST-API und jQuery.

function addFile(arrayBuffer) { 
    var executor = new SP.RequestExecutor(appWebUrl);

    // Construct the endpoint.
    // The GetList method is available for SharePoint Online only. 
    var fileCollectionEndpoint = String.format(
         "{0}/_api/sp.appcontextsite(@target)/web/getlist('{1}')/" +
         "rootfolder/files/add(overwrite=true, url='{2}')?@target='{3}'",
         appWebUrl, listName, fileName, hostWebUrl);

    var fileData = '';
    var byteArray = new Uint8Array(arrayBuffer);
    for (var i = 0; i < byteArray.byteLength; i++) {
        fileData += String.fromCharCode(byteArray[i]);
    }

    // Send the request.
    executor.executeAsync({
        url: fileCollectionEndpoint,
        method: "POST",
        body: fileData,
        binaryStringRequestBody: true,
        headers: {"accept":"application/json;odata=verbose"},
        success: function (data) {
            alert('File upload succeeded.');
        },
        error: function (err) {
            alert('Error: ' + err.responseText);
        }
    });
}

AddTemplateFile-Methode

Fügt einer vorhandenen Liste oder Dokumentbibliothek eine verwaiste Datei hinzu.

Endpunkt	/addTemplateFile(urlOfFile,templateFileType)
Parameter	urlOfFile Typ: String Die serverrelative URL, in der Sie die Datei speichern möchten. templateFileType Typ: Int32 Die SP.TemplateFileType zum Erstellen der Datei: StandardPage = 0; WikiPage = 1; FormPage = 2.
HTTP method	POST
Antwort	Typ: SP.File Die Vorlagendatei wurde hinzugefügt.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents')/files
    /addtemplatefile(urloffile='/Shared Documents/newwikipage.aspx',templatefiletype=1)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetByUrl-Methode

Ruft die Datei an der angegebenen URL ab.

Der GetFileByServerRelativeUrl-Endpunkt ist die empfohlene Option zum Abrufen einer Datei. Weitere Informationen dazu finden Sie unter SP.File-Anforderungsbeispiele.

Endpunkt	/getbyurl('<Name oder serverrelative URL der Datei>')
Parameter	Keine
HTTP method	GET
Antwort	Typ: SP.File Die Datei an der angegebenen URL.

Anforderungsbeispiele

Abrufen von Dateiinhalten (media-Ressource)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/foldername')/files
    /getbyurl('filename.docx')/$value
    ?@target='<host web url>'",
  method: "GET",
  binaryStringResponseBody: true,
  success: successHandler,
  error: errorHandler
});

Abrufen der Metadaten einer Datei (File-Ressource)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/foldername')/files
    /getbyurl('filename.docx')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Abrufen einer Datei finden Sie unter File-Anforderungsbeispiele und FileCollection-Anforderungsbeispiele.

OData-Darstellung

Das folgende Beispiel stellt eine FileCollection-Ressource im JSON-Format dar.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName1.docx')",
          "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')",
          "type":"SP.File"
        },
        "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/Author"}},
        "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/CheckedOutByUser"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/ListItemAllFields"}},
        "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/LockedByUser"}},
        "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/ModifiedBy"}},
        "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName1.docx')/Versions"}},
        "CheckInComment":"",
        "CheckOutType":2,
        "ContentTag":"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},4,7",
        "CustomizedPageStatus":0,
        "ETag":"\"{2FBB0C3C-4059-41A2-A5CF-3E076EA0A94C},4\"",
        "Exists":true,
        "Length":"20609",
        "Level":1,
        "MajorVersion":1,
        "MinorVersion":0,
        "Name":"fileName1.docx",
        "ServerRelativeUrl":"/Shared Documents/folderName/fileName1.docx",
        "TimeCreated":"2013-05-16T21:01:23Z",
        "TimeLastModified":"2013-06-09T02:38:14Z",
        "Title":"Title of fileName1",
        "UIVersion":512,
        "UIVersionLabel":"1.0"
        },{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared Documents/folderName/fileName2.docx')",
          "uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')",
          "type":"SP.File"
        },
        "Author":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/Author"}},
        "CheckedOutByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/CheckedOutByUser"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/ListItemAllFields"}},
        "LockedByUser":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/LockedByUser"}},
        "ModifiedBy":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/ModifiedBy"}},
        "Versions":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFileByServerRelativeUrl('/Shared%20Documents/folderName/fileName2.docx')/Versions"}},
        "CheckInComment":"",
        "CheckOutType":2,
        "ContentTag":"{E654B970-C4BF-4DC5-9719-B5B01CAD6FD9},4,9",
        "CustomizedPageStatus":0,
        "ETag":"\"{E654B970-C4BF-4DC5-9719-B5B01CAD6FD9},4\"",
        "Exists":true,
        "Length":"12263",
        "Level":1,
        "MajorVersion":1,
        "MinorVersion":0,
        "Name":"fileName2.docx",
        "ServerRelativeUrl":"/Shared Documents/folderName/fileName2.docx",
        "TimeCreated":"2013-05-18T05:01:51Z",
        "TimeLastModified":"2013-06-09T02:38:59Z",
        "Title":"Title of fileName2",
        "UIVersion":512,
        "UIVersionLabel":"1.0"
      }]}}

FileVersion-Ressource

Stellt einer Version einer File-Ressource dar.

Endpunkt-URI | Eigenschaften | Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/getfilebyserverrelativeurl('/<Ordnername>/<Dateiname>')/versions(<Versions-ID>)

Unterstützte HTTP-Methoden

GET | POST | DELETE

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen der Metdadaten einer Dateiversion

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

DELETE-Anforderungsbeispiel: Löschen einer bestimmten Version einer Datei

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(513)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

FileVersion-Eigenschaften

Senden Sie zum Abrufen einer Eigenschaft eine GET-Anforderung an den Eigenschaftsendpunkt wie im folgenden Beispiel.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')
    /versions(512)/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft	Typ	R/W	Mit Ressource zurückgegeben	Beschreibung
CheckInComment	String	R	Ja	Ruft einen Wert ab, der den Eincheckkommentar angibt.
Created	DateTime	R	Ja	Ruft einen Wert ab, der Erstellungsdatum und -uhrzeit für die Dateiversion angibt.
CreatedBy	SP.User	R	No	Ruft einen Wert ab, der den Benutzer angibt, der für den Ersteller der Dateiversion steht.
ID	Int32	R	Ja	Ruft den internen Bezeichner für die Dateiversion ab.
IsCurrentVersion	Boolean	R	Ja	Ruft einen Wert ab, der angibt, ob es sich bei der Dateiversion um die aktuelle Version handelt.
Size	Int32	R	Ja
Url	String	R	Ja	Ruft einen Wert ab, der die relative URL der Dateiversion auf der Grundlage der URL für die Website oder Unterwebsite angibt.
VersionLabel	String	R	Ja	Ruft einen Wert ab, der den implementierungsspezifischen Bezeichner der Datei angibt. Verwendet das Format majorVersionNumber.minorVersionNumber z. B.: 1.2.

FileVersion-Methoden

DeleteObject

DeleteObject-Methode

Die empfohlene Option zum Löschen einer Dateiversion ist das Senden einer DELETE-Anforderung an den FileVersion-Ressourcenendpunkt, wie in FileVersion-Anforderungsbeispiele gezeigt.

OData-Darstellung

Das folgende Beispiel stellt eine FileVersion-Ressource im JSON-Format dar.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared Documents/folderName/fileName1.docx')/versions(512)",
        "uri":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared%20Documents/folderName/fileName1.docx')/versions(512)",
        "type":"SP.FileVersion"
      },
      "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/web/getfilebyserverrelativeurl('/Shared%20Documents/folderName/fileName1.docx')/versions(512)/CreatedBy"}},
      "CheckInComment":"Revisions to the file.",
      "Created":"2013-06-10T04:02:53Z",
      "ID":512,
      "IsCurrentVersion":true,
      "Size":20609,
      "Url":"_vti_history/512/Shared Documents/folderName/fileName1.docx",
      "VersionLabel":"1.0"
    }}

FileVersionCollection-Ressource

Stellt eine Sammlung von FileVersion-Ressourcen dar.

Endpunkt-URI | -Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/getfilebyserverrelativeurl('/<Ordnername>/<Dateiname>')/versions

HTTP-Methoden

Diese Ressource unterstützt folgende HTTP-Methoden:

GET | POST

Anforderungsbeispiel

GET-Anforderungsbeispiel: Abrufen der Metadaten aller Versionen einer Datei

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen der Metadaten einer Dateiversion

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

FileVersionCollection-Methoden

DeleteAll
DeleteById
DeleteByLabel
GetById
RestoreByLabel

DeleteAll-Methode

Löscht alle Dateiversionsobjekte in der Auflistung.

Endpunkt	/deleteall
Parameter	Keine
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deleteall
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

DeleteById-Methode

Löscht die angegebene Version der Datei.

Endpunkt	/deletebyid(vid)
Parameter	vid Typ: Int32 Die ID der zu löschenden Dateiversion.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deletebyid(vid=3)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

DeleteByLabel-Methode

Löscht das Dateiversionsobjekt mit der angegebenen Versionskennzeichnung.

Endpunkt	/deletebylabel(versionlabel)
Parameter	versionlabel Typ: String Die SP.FileVersion.VersionLabel-Eigenschaft der zu löschenden Dateiversion.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /deletebylabel(versionlabel='1.2')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

GetById-Methode

Endpunkt	/getbyid(versionid)
Parameter	versionid Typ: Int32 Die ID der abzurufenden Dateiversion.
HTTP method	GET
Antwort	Typ: SP.FileVersion Die angegebene Dateiversion.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /getbyid(512)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die Versions-ID direkt an die Sammlung weitergeben (…/versions(512)). Weitere Informationen dazu finden Sie unter FileVersionCollection-Anforderungsbeispiel.

RestoreByLabel-Methode

Erstellt eine neue Dateiversion auf der Grundlage der durch die Versionskennzeichnung angegebenen Datei.

Endpunkt	/restorebylabel(versionlabel)
Parameter	versionlabel Typ: String Die SP.FileVersion.VersionLabel-Eigenschaft der wiederherzustellenden Dateiversion.
HTTP method	POST
Antwort	Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfilebyserverrelativeurl('/Shared Documents/filename.docx')/versions
    /restorebylabel(versionlabel='1.2')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

Das folgende Beispiel stellt eine FileVersionCollection-Ressource im JSON-Format dar.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9",
          "uri":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9",
          "type":"SP.FileVersion"
        },
        "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/SP.FileVersiona6a6bb00-2b96-41e6-a901-46df015183b9/CreatedBy"}},
        "CheckInComment":"",
        "Created":"2013-06-10T04:02:53Z",
        "ID":512,
        "IsCurrentVersion":true,
        "Size":20609,
        "Url":"_vti_history/512/Shared Documents/folderName/fileName1.docx",
        "VersionLabel":"1.0"
        },{
        "__metadata":{
          "id":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1",
          "uri":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1",
          "type":"SP.FileVersion"
        },
        "CreatedBy":{"__deferred":{"uri":"http://<site url>/_api/SP.FileVersion6accd876-7579-47b6-9779-19a24f6ab8a1/CreatedBy"}},
        "CheckInComment":"Revisions to the file.",
        "Created":"2013-06-11T17:42:41Z",
        "ID":513,
        "IsCurrentVersion":false,
        "Size":17973,
        "Url":"_vti_history/513/Shared Documents/folderName/fileName1.docx",
        "VersionLabel":"1.1"
      }]}}

Folder-Ressource

Steht für einen Ordner auf einer SharePoint-Website.

Endpunkt-URI | Eigenschaften | Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/getfolderbyserverrelativeurl('/<Ordnername>')

Unterstützte HTTP-Methoden

GET | POST | DELETE | MERGE | PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Ordners

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

MERGE-Anforderungsbeispiel: Ändern eines Ordners

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata':{ 'type': 'SP.Folder' }, 'WelcomePage':'Folder B/WelcomePage.aspx' }",
  headers: {
    "content-type": "application/json; odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

DELETE-Anforderungsbeispiel: Löschen eines Ordners

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method":"DELETE" },
  success: successHandler,
  error: errorHandler
});

Unter FolderCollection-Anforderungsbeispiele finden Sie ein Beispiel zum Erstellen eines Ordners.

Ordnereigenschaften

Senden Sie zum Abrufen einer Eigenschaft eine GET-Anforderung an den Eigenschaftsendpunkt wie im folgenden Beispiel.

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/<property name>
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Wenn Sie eine schreibbare Eigenschaft festlegen möchten, rufen Sie die Ressource ab, legen Sie den Eigenschaftswert im Text fest und wenden Sie dann die MERGE-Methode auf die Ressource an, um die Änderungen zusammenzuführen, beziehungsweise verwenden Sie die PUT-Methode, um die Ressource zu ersetzen. Weitere Beispiele finden Sie unter Folder-Anforderungsbeispiele.

Eigenschaft	Typ	R/W	Mit Ressource zurückgegeben	Beschreibung
ContentTypeOrder	Collection(SP.ContentTypeId)	R	Ja	Gibt die Reihenfolge an, in der Inhaltstypen angezeigt werden.
Files	SP.FileCollection	R	Nein	Ruft die Auflistung aller im Listenordner enthaltenen Dateien ab. Sie können eine Datei zu einem Ordner hinzufügen, indem Sie die Funktion Methode hinzufügen in der FileCollection-Ressource verwenden.
Folders	SP.FolderCollection	R	Nein	Ruft die Auflistung der Listenordner im Listenordner ab.
ItemCount	Int32	R	Ja	Ruft einen Wert ab, der die Anzahl von Elementen im Listenordner angibt.
ListItemAllFields	SP.ListItem	R	Nein	Gibt die Werte des Listenelementfelds (2) für das Listenelement an, das der Datei entspricht.
Name	String	R	Ja	Ruft den Namen des Ordners ab.
ParentFolder	SP.Folder	R	Nein	Ruft den übergeordneten Listenordner des Ordners ab.
Properties	SP.PropertyValues	R	Nein	Ruft die Auflistung aller im Ordner enthaltenen Dateien ab.
ServerRelativeUrl	String	R	Ja	Ruft die serverrelative URL des Listenordners ab.
UniqueContentTypeOrder	Collection(SP.ContentTypeId)	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der die Inhaltstypreihenfolge angibt.
WelcomePage	String	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der die ordnerrelative URL für die Startseite des Listenordners angibt.

Folder-Methoden

DeleteObject
Recycle

DeleteObject -Methode

Die empfohlene Option zum Löschen eines Ordners ist das Senden einer DELETE-Anforderung an den Folder-Ressourcenendpunkt, wie in Folder-Anforderungsbeispiele gezeigt.

Recycle-Methode

Verschiebt den Listenordner in den Papierkorb und gibt den Bezeichner des neuen Papierkorbelements zurück.

Endpunkt	/recycle
HTTP method	POST
Parameter	Keine
Antwort	Typ: GUID Die ID des Wiederverwendungsvorgangs.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

Das folgende Beispiel stellt eine Folder-Ressource im JSON-Format dar.

    {"d":{
      "__metadata":{,
        "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/Folder A')",
        "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')",
        "type":"SP.Folder"
      },
      "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Files"}},
      "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/ListItemAllFields"}},
      "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/ParentFolder"}},
      "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Properties"}},
      "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Folder%20A')/Folders"}},
      "ItemCount":7,
      "Name":"Folder A",
      "ServerRelativeUrl":"/Shared Documents/Folder A",
      "WelcomePage":""
    }}

FolderCollection-Ressource

Stellt eine Sammlung der Folder-Ressourcen dar.

Endpunkt-URI | Methoden | OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/folders (oberste Ordner auf Stammwebsite)
http://<Website-URL>/_api/web/getfolderbyserverrelativeurl('/<Ordnername>')/folders

Unterstützte HTTP-Methoden

GET | POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen von Ordnern auf der Stammwebsite

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen von Ordnern in einer Dokumentbibliothek

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents')/folders
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen von Ordnern nach Name

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/folders('Folder B')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Ordners (sie können auch die Funktion Methode hinzufügen verwenden)

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /getfolderbyserverrelativeurl('/Shared Documents/Folder A')/folders
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata':{ 'type': 'SP.Folder' }, 'ServerRelativeUrl':'Folder B' }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Beispiele zum Aktualisieren und Löschen eines Ordners finden Sie unter Folder-Anforderungsbeispiele .

FolderCollection-Methoden

Add
GetByUrl

Methode hinzufügen

Fügt der Auflistung den Ordner hinzu, der sich an der angegebenen URL befindet.

Endpunkt	/add(url)
Parameter	url Typ: String Der Pfad, in dem Sie den Ordner (einschließlich des Namens des neuen Ordners) als vollqualifizierte URL, serverrelative URL oder websiterelative URL hinzufügen möchten.
HTTP method	POST
Antwort	Typ: SP.Folder Der neu hinzugefügte Ordner.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    /add('/Shared Documents/Folder A/Folder B')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetByUrl-Methode

Endpunkt	/getbyurl('<serverrelative Ordner-URL>')
Parameter	Typ: String Die serverrelative URL des Ordners.
HTTP method	GET
Antwort	Typ: SP.Folder Der angegebene Ordner.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/folders
    /getbyurl('Folder B')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können einen Ordnernamen auch direkt an eine Ordnersammlung weitergeben. Beispiel: …/folders('Folder B'). Weitere Informationen dazu finden Sie unter FolderCollection-Anforderungsbeispiele.

OData-Darstellung

Das folgende Beispiel stellt eine FolderCollection-Ressource im JSON-Format dar.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/Forms')",
          "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')",
          "type":"SP.Folder"
        },
        "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Files"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/ListItemAllFields"}},
        "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/ParentFolder"}},
        "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Properties"}},
        "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/Forms')/Folders"}},
        "ItemCount":0,
        "Name":"Forms",
        "ServerRelativeUrl":"/Shared Documents/Forms",
        "WelcomePage":""
        },{
        "__metadata":{
          "id":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared Documents/folderName')",
          "uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')",
          "type":"SP.Folder"
        },
        "Files":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Files"}},
        "ListItemAllFields":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/ListItemAllFields"}},
        "ParentFolder":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/ParentFolder"}},
        "Properties":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Properties"}},
        "Folders":{"__deferred":{"uri":"http://<site url>/_api/Web/GetFolderByServerRelativeUrl('/Shared%20Documents/folderName')/Folders"}},
        "ItemCount":4,
        "Name":"folderName",
        "ServerRelativeUrl":"/Shared Documents/folderName",
        "WelcomePage":""
      }]}}

Freigeben über

Dateien und Ordner - REST API-Referenz

Informationen zu den Anforderungsbeispielen in diesem Artikel

Erfahren Sie mehr über SharePoint 2013-Dateien und Ordern in der REST-Syntax

Dateiressource

Endpunkt-URI

Unterstützte HTTP-Methoden

Anforderungsbeispiele

Dateieigenschaften

File-Methoden

Genehmigen

CancelUpload-Methode

CheckIn-Methode

CheckOut-Methode

ContinueUpload-Methode

CopyTo-Methode

DeleteObject-Methode

Deny-Methode

FinishUpload-Methode

GetLimitedWebPartManager-Methode

MoveTo-Methode

OpenBinaryStream-Methode

Publish-Methode

Recycle-Methode

SaveBinaryStream-Methode

StartUpload-Methode

UndoCheckOut-Methode

Unpublish-Methode

OData-Darstellung

FileCollection-Ressource

Endpunkt-URI

Unterstützte HTTP-Methoden

Anforderungsbeispiele

FileCollection-Methoden

Methode hinzufügen

AddTemplateFile-Methode

GetByUrl-Methode

OData-Darstellung

FileVersion-Ressource

Endpunkt-URI

Unterstützte HTTP-Methoden

Anforderungsbeispiele

FileVersion-Eigenschaften

FileVersion-Methoden

DeleteObject-Methode

OData-Darstellung

FileVersionCollection-Ressource

Endpunkt-URI

HTTP-Methoden

Anforderungsbeispiel

FileVersionCollection-Methoden

DeleteAll-Methode

DeleteById-Methode

DeleteByLabel-Methode

GetById-Methode

RestoreByLabel-Methode

OData-Darstellung

Folder-Ressource

Endpunkt-URI

Unterstützte HTTP-Methoden

Anforderungsbeispiele

Ordnereigenschaften

Folder-Methoden

DeleteObject -Methode

Recycle-Methode

OData-Darstellung

FolderCollection-Ressource

Endpunkt-URI

Unterstützte HTTP-Methoden

Anforderungsbeispiele

FolderCollection-Methoden

Methode hinzufügen

GetByUrl-Methode

OData-Darstellung

Zusätzliche Ressourcen

Zusätzliche Ressourcen