Webs - REST-API-Referenz

Erfahren Sie mehr über Websiteressourcen und Endpunkte in der SharePoint-REST-API.

Letzte Änderung: Donnerstag, 15. September 2016

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

Informationen zu den Anforderungsbeispielen in diesem Artikel

In den Beispielen in diesem Artikel werden jQuery AJAX-Anforderungen. Führen Sie folgende Aktionen aus, bevor Sie die Beispiele verwenden::

• Ändern Sie die <Website-URL> und sonstige Platzhalterdaten wie IDs, Namen oder Pfade der SharePoint-Entitäten.

• Wenn Sie die domänenübergreifende Bibliothek verwenden, müssen Sie das Anforderungsformat ändern. Das kann beispielsweise wie folgt aussehen.

  executor.executeAsync({
    url: "<app web url>/_api/SP.AppContextSite(@target)/web/getchanges?@target='<host web url>'",
    method: "POST",
    body: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' }, 'Web': true, 'Update': true } }",
    headers: {
      "accept": "application/json;odata=verbose",
      "content-type": "application/json;odata=verbose"
    },
    success: successHandler,
    error: errorHandler
  });
  

• Wenn Sie OAuth verwenden, müssen Sie eine Authorization-Kopfzeile hinzufügen ("Authorization": "Bearer " + <access token>), um das OAuth-Zugriffstoken zu senden.

• Entfernen Sie die Zeilenumbrüche aus der url und den data-Eigenschaftswerten in den Anforderungsbeispielen. Zu den Beispielen werden Zeilenumbrüche hinzugefügt, damit sie leichter gelesen werden können.

• Wenn der Server die Antworten im Atomformat zurückgeben soll, müssen Sie die "accept": "application/json;odata=verbose"-Kopfzeile entfernen.

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

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.

Webressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Stellt eine SharePoint-Website dar. Eine Website ist ein SP.SecurableObject-Typ.

Endpunkt-URI

http://<Website-URL>/_api/web

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen einer Website

$.ajax({
  url: "http://<site url>/_api/web",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen einer Website mit der Funktion Methode hinzufügen aus der WebCollection-Ressource

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Team projects', 'Url': 'TeamProjects', 'WebTemplate': 'STS',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Sie können auch die Add-Methode aus der WebInformationCollection-Ressource verwenden, wie unter Erstellen einer Website mit REST erläutert.

MERGE-Anforderungsbeispiel: Ändern einer Website

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Web' }, 'Description': 'All team projects',
    'EnableMinimalDownload': false }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

DELETE-Anforderungsbeispiel: Löschen einer Website

$.ajax({
  url: "http://<site url>/_api/web",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Web-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft	Typ	R/W	Mit Ressource zurückgegeben	Beschreibung
AllowCreateDeclarativeWorkflowForCurrentUser	Boolean	R	Nein	Gibt an, ob der aktuelle Benutzer deklarative Workflows erstellen kann. Wenn die Funktion nicht in der Webanwendung deaktiviert ist, entspricht der Wert der AllowCreateDeclarativeWorkflow -Eigenschaft der Websitesammlung. Standardwert: true.
AllowDesignerForCurrentUser	Boolean	R	Nein	Ruft einen Wert ab, der angibt, ob der aktuelle Benutzer berechtigt ist, die Website unter Verwendung einer Designeranwendung anzupassen.
AllowMasterPageEditingForCurrentUser	Boolean	R	Nein	Ruft einen Wert ab, der angibt, ob der aktuelle Benutzer zum Bearbeiten der Gestaltungsvorlage berechtigt ist.
AllowRevertFromTemplateForCurrentUser	Boolean	R	Nein	Ruft einen Wert ab, der angibt, ob der aktuelle Benutzer berechtigt ist, die Website auf eine standardmäßige Websitevorlage zurückzusetzen.
AllowRssFeeds	Boolean	R	Ja	Ruft einen Wert ab, der angibt, ob auf der Website RSS-Feeds zulässig sind.
AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser	Boolean	R	Nein	Gibt an, ob der aktuelle Benutzer deklarative Workflows als Vorlage speichern kann. Wenn die Funktion nicht in der Webanwendung deaktiviert ist, entspricht der Wert der AllowSaveDeclarativeWorkflowAsTemplate-Eigenschaft der Websitesammlung. Standardwert: true.
AllowSavePublishDeclarativeWorkflowForCurrentUser	Boolean	RW	Nein	Gibt an, ob der aktuelle Benutzer deklarative Workflows speichern oder veröffentlichen kann. Wenn die Funktion nicht in der Webanwendung deaktiviert ist, entspricht der Wert der AllowSavePublishDeclarativeWorkflowAsTemplate-Eigenschaft der Websitesammlung. Wenn die Funktion aktiviert ist, kann sie nur durch einen Websitesammlungs-Administrator festgelegt werden. Standardwert: true.
AllProperties	SP.PropertyValues	R	Nein	Ruft eine Auflistung mit Metadaten für die Website ab.
AppInstanceId	GUID	R	Ja	Die Instanz-ID der App-Instanz, die diese Website darstellt.
AssociatedMemberGroup	SP.Group	RW	Nein	Dient zum Abrufen oder Festlegen der Gruppe von Benutzern, denen Mitwirkungsberechtigungen für die Website gewährt wurden.
AssociatedOwnerGroup	SP.Group	RW	Nein	Dient zum Abrufen oder Festlegen der zugeordneten Besitzergruppe der Website.
AssociatedVisitorGroup	SP.Group	RW	Nein	Dient zum Abrufen oder Festlegen der zugeordneten Besuchergruppe der Website.
AvailableContentTypes	SP.ContentTypeCollection	R	Nein	Ruft die Auflistung aller Inhaltstypen für den aktuellen Bereich ab. Hierzu zählen auch die Inhaltstypen der aktuellen Website sowie alle übergeordneten Websites.
AvailableFields	SP.FieldCollection	R	Nein	Ruft einen Wert an, der die Auflistung aller für den aktuellen Bereich verfügbaren Felder angibt. Hierzu zählen Felder der aktuellen Website sowie möglicher übergeordneter Websites.
Configuration	Int16	R	Ja	Ruft entweder die ID der Konfiguration der Websitedefinition, die zum Erstellen der Website verwendet wurde, oder die ID der Konfiguration der Websitedefinition ab, von der die zum Erstellen der Website verwendete Websitevorlage abgeleitet wurde.
ContentTypes	SP.ContentTypeCollection	R	Nein	Ruft die Auflistung von Inhaltstypen für die Website ab.
Erstellt	DateTime	R	Ja	Ruft einen Wert ab, der angibt, wann die Website erstellt wurde.
CurrentUser	SP.User	R	Nein	Ruft den aktuellen Benutzer der Website ab.
CustomMasterUrl	String	RW	Ja	Dient zum Abrufen oder Festlegen der URL einer benutzerdefinierten Gestaltungsvorlagendatei an, die auf die Website angewendet werden soll.
Beschreibung	String	RW	Ja	Dient zum Abrufen oder Festlegen der Beschreibung für die Website.
DesignerDownloadUrlForCurrentUser	String	R	Nein	Ruft die URL ab, von der der aktuelle Benutzer SharePoint Designer herunterladen kann.
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Boolean	R	Ja	Bestimmt, ob die Web Application Companion-Vorschaufunktionen (WAC) für die Popups der Dokumentbibliothek aktiviert sind oder nicht.
EffectiveBasePermissions	SP.BasePermissions	R	Nein	Stellt den Durchschnitt der Berechtigungen des App-Prinzipals und des Benutzer-Prinzipals dar. Wenn es in diesem Fall nur um Apps geht, gibt die Eigenschaft nur die Berechtigungen des App-Prinzipals zurück. Um nur die Benutzerberechtigungen (App-Berechtigungen werden ignoriert) zu überprüfen, müssen Sie die GetUserEffectivePermissions-Methode verwenden.
EnableMinimalDownload	Boolean	RW	Ja	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Website die minimale Downloadstrategie verwenden soll.
EventReceivers	SP.EventReceiverCollection	R	Nein	Ruft die Auflistung der Ereignisempfängerdefinitionen ab, die derzeit auf der Website verfügbar sind.
Features	SP.FeatureCollection	R	Nein	Ruft einen Wert ab, der die Auflistung von Features angibt, die derzeit auf der Website aktiviert sind.
Felder	SP.FieldCollection	R	Nein	Ruft die Auflistung von Feldobjekten ab, die für alle Felder auf der Website steht.
Ordner	SP.FolderCollection	R	Nein	Ruft die Auflistung mit allen Ordnern auf der ersten Ebene der Website ab.
ID	GUID	R	Ja	Ruft einen Wert ab, der den Websitebezeichner für die Website angibt.
Language	Int32	R	Ja	Ruft einen Wert ab, der die LCID für die auf der Website verwendete Sprache angibt.
LastItemModifiedDate	DateTime	R	Ja	Ruft einen Wert ab, der angibt, wann zuletzt ein Element auf der Website geändert wurde.
Lists	SP.ListCollection	R	Nein	Ruft die Auflistung aller Listen ab, die sich innerhalb der Website befinden, die dem aktuellen Benutzer gemäß den aktuellen Benutzerberechtigungen zur Verfügung steht.
ListTemplates	SP.ListTemplateCollection	R	Nein	Ruft einen Wert ab, der die Auflistung von Listendefinitionen und Listenvorlagen angibt, die zum Erstellen von Listen auf der Website verfügbar sind.
MasterUrl	String	RW	Ja	Dient zum Abrufen oder Festlegen der Gestaltungsvorlage, die für die Website verwendet wird.
Navigation	SP.Navigation	R	Nein	Ruft einen Wert ab, der die Navigationsstruktur auf der Website (einschließlich Schnellstartbereich und obere Navigationsleiste) angibt.
ParentWeb	SP.Web	R	Nein	Ruft die übergeordnete Website der angegebenen Website ab.
PushNotificationSubscribers	SP.PushNotificationSubscriberCollection	R	Nein	Ruft die Auflistung von Pushbenachrichtigungsabonnenten über die Website ab.
QuickLaunchEnabled	Boolean	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Schnellstartbereich auf der Website aktiviert ist.
RecycleBin	SP.RecycleBin	R	Nein	Gibt die Auflistung der Papierkorbelemente im Papierkorb der Website an.
RecycleBinEnabled	Boolean	R	Ja	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Papierkorb für die Website aktiviert ist.
RegionalSettings	SP.RegionalSettings	R	Nein	Ruft die Regionaleinstellungen ab, die derzeit in der Website implementiert sind.
RoleDefinitions	SP.RoleDefinitionCollection	R	Nein	Ruft die Auflistung der Rollendefinitionen für die Website ab.
RootFolder	SP.Folder	R	Nein	Ruft den Stammordner für die Website ab.
SaveSiteAsTemplateEnabled	Boolean	RW	Nein	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob diese Website als Websitesammlung gespeichert werden kann.
ServerRelativeUrl	String	RW	Ja	Dient zum Abrufen oder Festlegen der serverrelativen URL für die Website.
ShowUrlStructureForCurrentUser	Boolean	R	Nein	Ruft einen Wert ab, der angibt, ob der aktuelle Benutzer die Dateisystemstruktur dieser Website anzeigen kann.
SiteGroups	SP.GroupCollection	R	Nein	Ruft die Auflistung der Gruppen für die Websitesammlung ab.
SiteUserInfoList	SP.List	R	Nein	Ruft die UserInfo-Liste der Websitesammlung mit der Website ab.
SiteUsers	SP.UserCollection	R	Nein	Ruft die Auflistung aller Benutzer ab, die zur Websitesammlung gehören.
SupportedUILanguageIds	Collection(Int32)	R	Nein	Gibt die Gebietsschemabezeichner (LCIDs) der Sprachen an, die für die Website aktiviert sind.
SyndicationEnabled	Boolean	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die RSS-Feeds auf der Website aktiviert sind.
ThemeInfo	SP.ThemeInfo	R	Nein	Die Informationen zum Design dieser Website. Dazu zählen Farben, Schriftarten, Rand- und Radiusgrößen usw.
Titel	String	RW	Ja	Dient zum Abrufen oder Festlegen des Titels für die Website.
TreeViewEnabled	Boolean	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Strukturansicht auf der Website aktiviert ist.
UIVersion	Int32	RW	Ja	Dient zum Abrufen oder Festlegen der Version der Benutzeroberfläche (User Interface, UI) der Website.
UIVersionConfigurationEnabled	Boolean	RW	Ja	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Einstellungsoberfläche für das visuelle Upgrade angezeigt wird oder ausgeblendet ist.
URL	String	R	Ja	Ruft die absolute URL der Website ab.
UserCustomActions	SP.UserCustomActionCollection	R	Nein	Ruft einen Wert ab, der die Auflistung von benutzerdefinierten Aktionen eines Benutzers für die Websitesammlung angibt.
WebInfos	SP.WebInformation	R	Nein	Stellt die wichtigsten Eigenschaften der untergeordneten Websites einer Website dar.
Webs	SP.WebCollection	R	Nein	Ruft ein Websitesammlungsobjekt ab, das für alle Websites steht, die der Website direkt untergeordnet sind. Unterwebsites dieser Websites gehören nicht dazu.
WebTemplate	String	R	Ja	Ruft den Namen der Websitedefinition oder -vorlage ab, die zum Erstellen der Website verwendet wurde.
WorkflowAssociations	SP.WorkflowAssociationCollection	R	Nein	Ruft einen Wert ab, der die Auflistung aller Workflowzuordnungen für die Website angibt.
WorkflowTemplates	SP.WorkflowTemplateCollection	R	Nein	Ruft einen Wert ab, der die Auflistung der Workflowvorlagen angibt, die der Website zugeordnet sind.

Webmethoden

ApplyTheme
ApplyWebTemplate
BreakRoleInheritance
DeleteObject
DoesPushNotificationSubscriberExist
DoesUserHavePermissions
EnsureUser
ExecuteRemoteLOB
GetAppBdcCatalog
GetAppBdcCatalogForAppInstance
GetAppInstanceById
GetAppInstancesByProductId
GetAvailableWebTemplates
GetCatalog
GetChanges
GetContextWebInformation
GetEntity
GetDocumentLibraries
GetFileByServerRelativeUrl
GetFolderByServerRelativeUrl
GetList
GetPushNotificationSubscriber
GetPushNotificationSubscribersByArgs
GetPushNotificationSubscribersByUser
GetSubwebsFilteredForCurrentUser
GetUserById
GetUserEffectivePermissions
GetWebUrlFromPageUrl
LoadAndInstallApp
LoadAndInstallAppInSpecifiedLocale
LoadApp
MapsToIcon
ProcessExternalNotification
RegisterPushNotificationSubscriber
ResetRoleInheritance
UnregisterPushNotificationSubscriber

ApplyTheme-Methode

Wendet das Design, das vom Inhalt der einzelnen in den Argumenten angegebenen Dateien angegeben wird, auf die Website an.

Endpunkt	/applytheme(colorpaletteurl, fontschemeurl, backgroundimageurl, sharegenerated)
Parameter	colorpaletteurl Typ: String Die serverrelative URL der Farbpalettendatei. fontschemeurl Type: String Die serverrelative URL des Schriftartenschemas. backgroundimageurl Typ: String Die serverrelative URL des Hintergrundbilds. sharegenerated Typ: Boolean true zum Speichern der auf der Stammwebsite erstellten Designdatei oder false zum Speichern auf dieser Website.
HTTP method	POST
Antwort	Keine

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /applytheme(colorpaletteurl='/_catalogs/theme/15/palette011.spcolor',
        fontschemeurl='/_catalogs/theme/15/fontscheme007.spfont',
        backgroundimageurl='/piclibrary/th.jpg', sharegenerated=true)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

Sie können die Parameter auch im Text senden: { 'colorPaletteUrl':'/_catalogs/theme/15/palette011.spcolor', 'fontSchemeUrl':'/_catalogs/theme/15/fontscheme007.spfont', 'backgroundImageUrl':'/piclibrary/pics/th.jpg', 'shareGenerated':true }

Weitere Informationen dazu finden Sie unter Übersicht über Designs für SharePoint 2013.

ApplyWebTemplate-Methode

Wendet die angegebene Websitedefinition oder -vorlage auf die Website an, auf die keine Vorlage angewendet wurde.

Hinweis

Das Aufrufen dieser Methode innerhalb einer Websitebereitstellungs-Rückrufaktion, die innerhalb der angewendeten gleichen Websitedefinitionskonfiguration definiert ist, kann zu einer unendlichen Schleife führen. Erstellen Sie stattdessen zwei ähnliche Website-Definitionskonfigurationen innerhalb der Websitedefinition, eine eingeblendete und eine ausgeblendete. Die eingeblendete Konfiguration kann dann einen Bereitstellungs-Assembly-Rückruf enthalten, die ausgeblendete Konfiguration auf Websites anwendet.

Endpunkt	/applywebtemplate('<Websitedefinition oder Webvorlagenname>')
Parameter	Typ: String Der Name der Websitedefinition oder der Name der Websitevorlage. Verwenden Sie die GetAvailableWebTemplates-Methode, um die Namen der verfügbaren Websitevorlagen abzurufen.
HTTP method	POST
Antwort	Keine

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /applywebtemplate(@v)?@v='blog%230'",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

BreakRoleInheritance-Methode

Erstellt eindeutige Rollenzuweisungen für das sicherungsfähige Objekt.

Endpunkt	/breakroleinheritance(copyroleassignments, clearsubscopes)
Parameter	copyroleassignments Typ: Boolean true zum Kopieren der Rollenzuweisungen vom übergeordneten sicherungsfähigen Objekt; false zum Entfernen der geerbten Rollenzuweisungen außer der, die den aktuellen Benutzer enthält. clearsubscopes Typ: Boolean Optional. true, wenn alle untergeordneten sicherungsfähigen Objekte die Rollenzuweisungen vom aktuellen Objekt erben; false, wenn die Rollenzuweisungen für untergeordnete sicherungsfähige Objekte, die keine Rollenzuweisungen von ihrem übergeordneten Objekt erben, unverändert bleiben.
HTTP method	POST
Antwort	Keine

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

DeleteObject-Methode

Beispiele

DoesPushNotificationSubscriberExist-Methode

Prüft, ob der Pushbenachrichtigungsabonnent für den aktuellen Benutzer mit der angegebenen Geräteanwendungsinstanz-ID vorhanden ist.

Endpunkt	/doespushnotificationsubscriberexist('<Geräte-App-Instanz-ID >')
Parameter	Typ: GUID Die ID der Geräte-App-Instanz.
HTTP method	GET
Antwort	Typ: Boolean true, wenn das Abonnement vorhanden ist; andernfalls false.

DoesUserHavePermissions-Methode

Gibt zurück, ob der aktuelle Benutzer über die angegebene Gruppe von Berechtigungen verfügt.

Endpunkt	/doesuserhavepermissions(@v)?@v={'High':'<value>', 'Low':'<value>'}
Parameter	Typ: SP.BasePermissions Der Bereich hoher und niedriger Berechtigungen. Verwenden Sie den …/_api/web/roledefinitions-Endpunkt zum Abrufen der hohen und niedrigen Berechtigungswerte für die Rollen auf der Website.
HTTP method	GET
Antwort	Typ: Boolean true, wenn der Benutzer über die Berechtigungen verfügt, andernfalls false.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /doesuserhavepermissions(@v)?@v={'High':'432', 'Low':'1012866047'}",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

EnsureUser-Methode

Prüft, ob der angegebene Anmeldename zu einem gültigen Benutzer der Website gehört. Wenn der Benutzer nicht vorhanden ist, wird der Benutzer zu der Website hinzugefügt.

Endpunkt	/ensureuser
Parameter	logonName Typ: String Der Anmeldename des Benutzers. Geben Sie den logonName-Parameter im Anforderungstext weiter, wie im Anforderungsbeispiel gezeigt.
HTTP method	POST
Antwort	Typ: SP.User Der angegebene Benutzer.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /ensureuser",
  type: "POST",
  data: "{ 'logonName': 'i:0#.f|membership|user@domain.onmicrosoft.com' }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

ExecuteRemoteLOB-Methode

Sendet Daten an einen OData-Dienst.

Diese Methode ist der Einstiegspunkt in die hybride Konnektivität und wird zum Aufrufen des OData-Diensts von einem lokalen Server verwendet. Zum Erstellen des OData-Diensts erforderliche Eingabeparameter werden als benutzerdefinierte HTTP-Kopfzeilen weitergegeben. Weitere Informationen dazu finden Sie unter ExecuteRemoteLOB.

Endpunkt	/executeremotelob
Parameter	inputStream Typ: Stream Das OData-Eingabeobjekt. Wird nur zum Erstellen oder Aktualisieren von Vorgängen verwendet.
HTTP method	POST
Antwort	Typ: Stream Die OData-Antwort des OData-Diensts.

GetAppBdcCatalog -Methode

Endpunkt	/getappbdccatalog
Parameter	Keine
HTTP method	POST
Antwort	Typ: SP.BusinessData.AppBdcCatalog Der Business Data Connectivity (BDC)-Dienst-MetadataCatalog der aktuellen App-Instanz.

GetAppBdcCatalogForAppInstance-Methode

Endpunkt	/getappbdccatalogforappinstance('<App-Instanz-ID>')
Parameter	Typ: GUID Die ID der App-Instanz.
HTTP method	POST
Antwort	Typ: SP.BusinessData.AppBdcCatalog Der BDC-MetadataCatalog der angegebenen App-Instanz.

GetAppInstanceById-Methode

Ruft eine für diese Website installierte App-Instanz ab.

Endpunkt	/getappinstancebyid('<App-Instanz-ID>')
Parameter	Typ: GUID Die ID der App-Instanz.
HTTP method	GET
Antwort	Typ: SP.AppInstance Die angegebene App-Instanz.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getappinstancebyid('3122ea58-8435-4d9a-a302-345599838671')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetAppInstancesByProductId-Methode

Ruft alle auf dieser Website installierten App-Instanzen ab, die Instanzen der angegebenen App sind.

Endpunkt	/getappinstancesbyproductid('<Produkt-ID>')
Parameter	Typ: GUID Die Produkt-ID der App.
HTTP method	GET
Antwort	Typ: Collection(SP.AppInstance) Die auf der Website für das angegebene Produkt installierte App-Instanzen.

GetAvailableWebTemplates-Methode

Gibt eine Auflistung von für die Website verfügbaren Websitevorlagen zurück.

Endpunkt	/getavailablewebtemplates(lcid, doincludecrosslanguage)
Parameter	lcid Typ: Int64 Die LCID der abzurufenden Websitevorlagen. doincludecrosslanguage Typ: Boolean true zum Einbeziehen von sprachneutralen Websitevorlagen; andernfalls false.
HTTP method	GET
Antwort	Typ: SP.WebTemplateCollection Die Sammlung der verfügbaren Websitevorlagen. Gibt eine leere Sammlung zurück, falls die angegebene LCID nicht gültig ist.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getavailablewebtemplates(lcid=1033, doincludecrosslanguage=true)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetCatalog-Methode

Gibt den Listenkatalog der Website zurück.

Endpunkt	/getcatalog(<Katalogtyp >)
Parameter	Typ: Int32 Der Katalogtyp. Stellt einen ListTemplateType-Wert dar, wie z. B. WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114, MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125.
HTTP method	GET
Antwort	Typ: SP.List Der Katalog für den angegebenen Listentyp. Gibt Null zurück, falls kein Katalog mit dem angegeben Typ vorhanden oder die Listenvorlage ungültig ist.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getcatalog(113)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetChanges-Methode

Gibt auf der Grundlage der angegebenen Abfrage die Auflistung mit allen Änderungen aus dem Änderungsprotokoll zurück, die innerhalb des Bereichs der Website aufgetreten sind.

Endpunkt	/getchanges
Parameter	query Typ: SP.ChangeQuery Die Änderungsabfrage. Geben Sie die query-Parameter im Anforderungstext weiter, wie im Anforderungsbeispiel gezeigt.
HTTP method	POST
Antwort	Typ: SP.ChangeCollection Die Änderungen an der Website, die mit den Kriterien der angegebenen Änderungsabfrage übereinstimmen.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getchanges",
  type: "POST",
  data: "{ 'query': { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Web': true, 'Update': true, 'Add': true } }",
  headers: {
    "X-RequestDigest": <form digest value>
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

GetContextWebInformation

Ruft die Kontextinformationen der Website ab. Statische Methode.

Endpunkt	http://<Website-URL>/_api/contextinfo
Parameter	Keine
HTTP method	POST
Antwort	Typ: SP.ContextWebInformation Die Kontextinformationen der Website.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api
    /contextinfo",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

GetCustomListTemplates-Methode

Ruft die benutzerdefinierten Listenvorlagen der Website ab.

Endpunkt	/getcustomlisttemplates
Parameter	Keine
HTTP method	GET
Antwort	Typ: SP.ListTemplateCollection Die benutzerdefinierten Listenvorlagen der Website.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getcustomlisttemplates",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetDocumentLibraries-Methode

Ruft die Dokumentbibliotheken einer Website ab. Statische Methode. (nur SharePoint Online)

Endpunkt	http://<Website-URL>/_api/sp.web.getdocumentlibraries(@v)?@v='<vollständige Website-URL>'
Parameter	Typ: String Die vollständige URL der Website.
HTTP method	GET
Antwort	Typ: Sammlung(SP.DocumentLibraryInformation) Eigenschaften der Dokumentbibliotheken auf der Website. Diese Methode gibt keine privaten Bibliotheken, Bildbibliotheken, Katalogbibliotheken, Objektbibliotheken, Anwendungslisten oder Bibliotheken weiter, zu denen der Benutzer über keine Berechtigungen zum Anzeigen der Elemente verfügt.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getdocumentlibraries(@v)?@v='https://contoso.sharepoint.com'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler});

GetEntity-Methode

Ruft den angegebenen externen Inhaltstyp aus einer Branchensystemanwendung ab.

Endpunkt	/getentity(namespace, name)
Parameter	namespace Typ: String Der Namespace des externen Inhaltstyps. name Typ: String der Name des externen Inhaltstyps.
HTTP method	POST
Antwort	Typ: SP.BusinessData.Entity Der externe Inhaltstyp.

GetFileByServerRelativeUrl-Methode

Gibt das Dateiobjekt zurück, das sich an der angegebenen serverrelativen URL befindet.

Endpunkt	/getfilebyserverrelativeurl('<serverrelative URL>')
Parameter	Typ: String Die serverrelative URL der Datei.
HTTP method	GET
Antwort	Typ: SP.File Die angegebene Datei.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getfilebyserverrelativeurl('/templates/ResourceRequest.docx')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetFolderByServerRelativeUrl-Methode

Gibt das Ordnerobjekt zurück, das sich an der angegebenen serverrelativen URL befindet.

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

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getfolderbyserverrelativeurl('/templates/test')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetList-Methode

Ruft die Liste der angegebenen websiterelativen URL ab.

Endpunkt	/getlist('<Listen-URL>')
Parameter	Typ: String Die websiterelative URL der Liste.
HTTP method	GET
Antwort	Typ: SP.List Die angegebene Liste.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getlist('/lists/ideas')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetPushNotificationSubscriber-Methode

Dient zum Abrufen des Pushbenachrichtigungsabonnenten über die Website für die angegebene Geräteanwendungsinstanz-ID.

Endpunkt	/getpushnotificationsubscriber('<Geräte-App-Instanz-ID>')
Parameter	Typ: GUID Die ID der Geräte-App-Instanz.
HTTP method	GET
Antwort	Typ: SP.PushNotificationSubscriber Der registrierte Pushbenachrichtigungsabonnent.

GetPushNotificationSubscribersByArgs-Methode

Dient zum Abfragen der Pushbenachrichtigungsabonnenten über die Website auf den angegebenen Wert benutzerdefinierter Argumente. Benutzerdefinierte Argumente, die NULL oder leer sind, geben Abonnenten ungefiltert zurück.

Endpunkt	/getpushnotificationsubscribersbyargs('<Argumente>')
Parameter	Typ: String Argumente zum Filtern der Ergebnisse. Weitergegebene Argumente werden mit den benutzerdefinierten Argumenten des Abonnenten im Speicher verglichen. Geben Sie Null oder leere Argumente weiter, damit ungefilterte Ergebnisse zurückgegeben werden.
HTTP method	GET
Antwort	Typ: SP.PushNotificationSubscriberCollection Die registrierten Pushbenachrichtigungsabonnenten, die mit den Argumenten übereinstimmen. Gibt eine leere Sammlung zurück, wenn keine Übereinstimmung gefunden werden konnte.

GetPushNotificationSubscribersByUser-Methode

Dient zum Abfragen der Pushbenachrichtigungsabonnenten über die Website für den angegebenen Benutzer.

Endpunkt	/getpushnotificationsubscribersbyuser(@v)?@v='<Anmeldename>'
Parameter	Typ: String Der Anmeldename des Benutzers. Weitere Informationen zu Formaten zum Weitergeben von Anmeldenamen in der Abfragezeichenfolge finden Sie unter User.
HTTP method	GET
Antwort	Typ: SP.PushNotificationSubscriberCollection Die registrierten Pushbenachrichtigungsabonnenten für den Benutzer.

GetSubwebsFilteredForCurrentUser-Methode

Gibt die Auflistung untergeordneter Websites der aktuellen Website auf der Grundlage der angegebenen Abfrage zurück.

Nur in SharePoint Online verfügbar.

Endpunkt	/getsubwebsfilteredforcurrentuser(nwebtemplatefilter, nconfigurationfilter)
Parameter	nwebtemplatefilter Typ: Int32 Die ID der Vorlage, die in der Websitedefinition der Websites verwendet wurde. nconfigurationfilter Typ: Int16 Die ID der Websitevorlage, die zur Bereitstellung der Websites verwendet wurde.
HTTP method	GET
Antwort	Typ: Collection(SP.WebInformation) Informationen über die Websites, auf die der aktuelle Benutzer zugreifen kann.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getsubwebsfilteredforcurrentuser(nwebtemplatefilter=-1,nconfigurationfilter=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetUserById-Methode

Gibt den Benutzer zurück, der der Element-ID der aktuellen Website entspricht.

Endpunkt	/getuserbyid(<Benutzer-ID>)
Parameter	Typ: Int32 Die ID des Benutzers.
HTTP method	GET
Antwort	Typ: SP.User Der angegebene Benutzer.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getuserbyid(12)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetUserEffectivePermissions-Methode

Gibt die geltenden Berechtigungen an, über die der angegebene Benutzer im Gültigkeitsbereich der aktuellen Anwendung verfügt.

Damit die Berechtigungen eines anderen als dem aktuellen Benutzers überprüft werden können, müssen die Apps über Full Control-Berechtigungen für die Website verfügen.

Endpunkt	/getusereffectivepermissions(@v)?@v='<Anmeldename>'
Parameter	Typ: String Der Anmeldename des Benutzers. Weitere Informationen zu Formaten zum Weitergeben von Anmeldenamen in der Abfragezeichenfolge finden Sie unter User.
HTTP method	GET
Antwort	Typ: SP.BasePermissions Die Berechtigungen des angegebenen Benutzers.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetWebUrlFromPageUrl-Methode

Ruft die Website-URL von einer Seiten-URL ab. Statische Methode.

Endpunkt	http://<Website-URL>/_api/sp.web.getweburlfrompageurl(@v)?@v='<vollständige Seiten-URL>'
Parameter	Typ: String Die vollständige URL der SharePoint-Seite, ggf. mit URL-Zeichencodierung.
HTTP method	GET
Antwort	Typ: String Die vollständige URL der SharePoint-Website.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api
    /sp.web.getweburlfrompageurl(@v)?@v='https://contoso.sharepoint.com/subsite/_layouts/15/start.aspx'",
  method: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

LoadAndInstallApp-Methode

Dient zum Hochladen und Installieren eines App-Pakets für diese Website.

Diese Website muss für Remoteentwicklung aktiviert sein.

Endpunkt	/loadandinstallapp
Parameter	appPackageStream Typ: Stream Der App-Paket-Stream.
HTTP-Methode	POST
Antwort	Typ: SP.AppInstance Die App-Instanz.

LoadAndInstallAppInSpecifiedLocale-Methode

Dient zum Hochladen und Installieren eines App-Pakets für diese Website in einem angegebenen Gebietsschema.

Endpunkt	/loadandinstallappinspecifiedlocale
Parameter	appPackageStream Typ: Stream Der App-Paket-Stream. installationLocaleLCID Typ: Int32 Die LCID des Gebietsschemas zum Erstellen der App-Instanz.
HTTP method	POST
Antwort	Typ: SP.AppInstance Die App-Instanz.

LoadApp-Methode

Lädt ein App-Paket hoch und erstellt daraus eine Instanz.

Endpunkt	/loadapp
Parameter	appPackageStream Typ: Stream Der App-Paket-Stream. installationLocaleLCID Typ: Int32 Die LCID des Gebietsschemas zum Erstellen der App-Instanz.
HTTP method	POST
Antwort	Typ: SP.AppInstance Die App-Instanz.

MapToIcon-Methode

Gibt den Namen der Bilddatei für das Symbol zurück, das verwendet wird, um die angegebene Datei darzustellen.

Endpunkt	/maptoicon(filename, progid, size)
Parameter	filename Typ: String Der Dateiname. Wenn dieser Parameter leer ist, gibt der Server eine leere Zeichenfolge zurück. progid Typ: String Die ProgID der Anwendung, die zum Erstellen der Datei im Formular OLEServerName.ObjectName (z. B. Excel.Sheet oder PowerPoint.Slide) verwendet wurde. Hierbei handelt es sich um die ID, die die Windows-Registrierung verwendet, um ein Objekt eindeutig zu identifizieren. size Typ: Int32 Die Größe des Symbols: 16x16 Pixel = 0, 32x32 Pixel = 1.
HTTP method	GET
Antwort	Typ: String Der Name der Symbolbilddatei.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /maptoicon(filename='spectemplate.docx', progid='', size=0)",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

ProcessExternalNotification-Methode

Verarbeitet eine Benachrichtigung von einem externen System.

Endpunkt	/processexternalnotification
Parameter	stream Typ: Stream Die Benachrichtigung des externen Systems.
HTTP method	POST
Antwort	Typ: String Der Verarbeitungsstatus: Success gibt die erfolgreiche Verarbeitung an, SubscriptionNotRequired gibt an, dass das Abonnement nicht mehr erforderlich ist und sicher gelöscht werden kann.

RegisterPushNotificationSubscriber-Methode

Registriert den Abonnenten für Pushbenachrichtigungen über die Website. Wenn die Registrierung bereits vorhanden ist, wird das Diensttoken mit dem neuen Wert aktualisiert.

Endpunkt	/registerpushnotificationsubscriber(deviceappinstanceid, servicetoken)
Parameter	deviceappinstanceid Typ: GUID Die ID der Geräte-App-Instanz. servicetoken Typ: String Das vom Benachrichtigungsdienst bereitgestellte Token an das Gerät zum Empfangen von Benachrichtigungen.
HTTP method	POST
Antwort	Typ: SP.PushNotificationSubscriber Der registrierte Pushbenachrichtigungsabonnent.

ResetRoleInheritance-Methode

Setzt die Rollenvererbung für das sicherungsfähige Objekt zurück und erbt Rollenzuweisungen vom übergeordneten sicherungsfähigen Objekt.

Endpunkt	/resetroleinheritance
Parameter	Keine
HTTP method	POST
Antwort	Keine

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /resetroleinheritance",
  method: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

UnregisterPushNotificationSubscriber-Methode

Hebt die Registrierung des Abonnenten für Pushbenachrichtigungen von der Website auf.

Endpunkt	/unregisterpushnotificationsubscriber('<Geräte-App-Instanz-ID>')
Parameter	Typ: GUID Die ID der Geräte-App-Instanz.
HTTP method	POST
Antwort	Keine

OData-Darstellung

Das folgende Beispiel stellt eine Webressource im JSON-Format dar.

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/Web",
        "uri":"https://<site url>/_api/Web",
        "type":"SP.Web"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
      "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
      "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
      "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
      "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
      "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
      "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
      "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
      "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
      "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
      "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
      "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
      "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
      "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
      "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
      "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
      "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
      "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
      "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
      "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
      "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
      "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
      "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
      "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
      "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
      "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
      "AllowRssFeeds":true,
      "AppInstanceId":"d025f690-8281-4cb7-ab11-04793e232661",
      "Configuration":0,
      "Created":"2014-02-27T20:08:25",
      "CustomMasterUrl":"/_catalogs/masterpage/app.master",
      "Description":"",
      "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
      "EnableMinimalDownload":false,
      "Id":"ba0bfd3d-ba13-4400-aacf-f60d56eecfbc",
      "Language":1033,
      "LastItemModifiedDate":"2014-02-27T20:08:28Z",
      "MasterUrl":"/_catalogs/masterpage/app.master",
      "QuickLaunchEnabled":true,
      "RecycleBinEnabled":true,
      "ServerRelativeUrl":"",
      "SyndicationEnabled":true,
      "Title":"ParseUm",
      "TreeViewEnabled":false,
      "UIVersion":15,
      "UIVersionConfigurationEnabled":false,
      "Url":"https://<site url>",
      "WebTemplate":"APP"
    }}

WebCollection-Ressource

Endpunkt-URI  |  -Methoden  |  OData-Darstellung

Stellt eine Sammlung von Websites dar.

Endpunkt-URI

http://<Website-URL>/_api/web/webs

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Ruft alle untergeordneten Websites in einer Website ab

$.ajax({
  url: "http://<site url>/_api/web/webs",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen einer Website mit der Funktion Methode hinzufügen

$.ajax({
  url: "http://<site url>/_api/web/webs/add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Sie können auch die Add-Methode aus der WebInformationCollection-Ressource verwenden, wie in Erstellen einer Website mit REST erläutert.

Beispiele

WebCollection-Methoden

Hinzufügen

Methode hinzufügen

Fügt der Auflistung eine neue Website hinzu.

Endpunkt	/add
Parameter	parameters Typ: SP.WebCreationInformation Die Eigenschaften der neuen Website. Senden Sie diesen Parameter im Anforderungstext, wie in dem Anforderungsbeispiel gezeigt.
HTTP method	POST
Antwort	Typ: SP.Web Die neue Website.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web/webs
    /add",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.WebCreationInformation' },
    'Title': 'Social Meetup', 'Url': 'social', 'WebTemplate': 'MPS#3',
    'UseSamePermissionsAsParentSite': true } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Verwenden Sie die GetAvailableWebTemplates-Methode zum Abrufen der Namen der verfügbaren Websitevorlagen.

OData-Darstellung

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

    {"d":{
      "results":[{
          "__metadata":{
            "id":"https://<site url>/_api/Web",
            "uri":"https://<site url>/_api/Web",
            "type":"SP.Web"
          },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"9f85a4a6-3609-44d6-9427-e7a5f16ceeeb",
          "Configuration":0,
          "Created":"2013-10-03T19:45:27",
          "CustomMasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":false,
          "Id":"2dbf86de-6538-4d1a-b4fe-2a8e9816d692",
          "Language":1033,
          "LastItemModifiedDate":"2013-10-03T19:45:30Z",
          "MasterUrl":"/apppart/_catalogs/masterpage/app.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/apppart",
          "SyndicationEnabled":true,
          "Title":"apppart",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>",
          "WebTemplate":"APP"
        },{
        "__metadata":{
          "id":"https://<site url>,
          "uri":"https://<site url>,
          "type":"SP.Web"
        },
          "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/FirstUniqueAncestorSecurableObject"}},
          "RoleAssignments":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleAssignments"}},
          "AllProperties":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AllProperties"}},
          "AssociatedMemberGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedMemberGroup"}},
          "AssociatedOwnerGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedOwnerGroup"}},
          "AssociatedVisitorGroup":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AssociatedVisitorGroup"}},
          "AvailableContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableContentTypes"}},
          "AvailableFields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/AvailableFields"}},
          "ContentTypes":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ContentTypes"}},
          "CurrentUser":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/CurrentUser"}},
          "DescriptionResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/DescriptionResource"}},
          "EventReceivers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/EventReceivers"}},
          "Features":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Features"}},
          "Fields":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Fields"}},
          "Folders":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Folders"}},
          "Lists":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Lists"}},
          "ListTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ListTemplates"}},
          "Navigation":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Navigation"}},
          "ParentWeb":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ParentWeb"}},
          "PushNotificationSubscribers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/PushNotificationSubscribers"}},
          "RecycleBin":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RecycleBin"}},
          "RegionalSettings":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RegionalSettings"}},
          "RoleDefinitions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RoleDefinitions"}},
          "RootFolder":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/RootFolder"}},
          "SiteGroups":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteGroups"}},
          "SiteUserInfoList":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUserInfoList"}},
          "SiteUsers":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/SiteUsers"}},
          "ThemeInfo":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/ThemeInfo"}},
          "TitleResource":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/TitleResource"}},
          "UserCustomActions":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/UserCustomActions"}},
          "Webs":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/Webs"}},
          "WebInfos":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WebInfos"}},
          "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowAssociations"}},
          "WorkflowTemplates":{"__deferred":{"uri":"https://<site url>/TeamProjects/_api/Web/WorkflowTemplates"}},
          "AllowRssFeeds":true,
          "AppInstanceId":"00000000-0000-0000-0000-000000000000",
          "Configuration":0,
          "Created":"2014-02-28T21:41:11",
          "CustomMasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "Description":"",
          "DocumentLibraryCalloutOfficeWebAppPreviewersDisabled":false,
          "EnableMinimalDownload":true,
          "Id":"3a37226d-8f0b-41bd-a720-6f63fd1e2abb",
          "Language":1033,
          "LastItemModifiedDate":"2014-02-28T21:41:23Z",
          "MasterUrl":"/TeamProjects/_catalogs/masterpage/seattle.master",
          "QuickLaunchEnabled":true,
          "RecycleBinEnabled":true,
          "ServerRelativeUrl":"/TeamProjects",
          "SyndicationEnabled":true,
          "Title":"Team projects",
          "TreeViewEnabled":false,
          "UIVersion":15,
          "UIVersionConfigurationEnabled":false,
          "Url":"https://<site url>/TeamProjects",
          "WebTemplate":"STS"
        },{
          ...
        }
      }]
    }}

Zusätzliche Ressourcen

• REST-API-Referenz und Beispiele

• Einführung in den SharePoint 2013 REST-Dienst

• Ausführen grundlegender Vorgänge unter Verwendung von SharePoint 2013-REST-Endpunkten

• Zugreifen auf SharePoint 2013-Daten über Add-Ins mithilfe der domänenübergreifenden Bibliothek

• OAuth-Authentifizierungs- und Autorisierungsablauf für in der Cloud gehostete Apps

• Verwenden von OData-Abfragevorgängen in SharePoint REST-Anforderungen