Arbeiten mit Listen und Listenelementen unter Verwendung von REST

Tipp

Der SharePoint Online-REST-Dienst (sowie der REST-Dienst von lokalem SharePoint 2016 und höher) 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.

Voraussetzungen

In diesem Artikel setzen wir voraus, dass Sie bereits den Artikel Grundlegendes zum SharePoint-REST-Dienst sowie den Artikel Ausführen grundlegender Vorgänge unter Verwendung von SharePoint-REST-Endpunkten gelesen haben. Es werden keine Codeausschnitte bereitgestellt.

Abrufen von Listen und Listeneigenschaften mit REST

Das folgende Beispiel zeigt, wie Sie eine bestimmte Liste abrufen, wenn ihre GUID bekannt ist.

GET https://{site_url}/_api/web/lists(guid'{list_guid}')
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Hinweis

Verwenden Sie in der Accept-Kopfzeile application/json;odata=verbose, wenn Sie die Antwort in JSON wünschen.

Verwenden Sie application/atom+xml in der Accept-Kopfzeile, wenn Sie die Antwort im Format Atom wünschen.

Das folgende Beispiel zeigt, wie Sie eine bestimmte Liste abrufen, wenn ihr Titel bekannt ist.

GET https://{site_url}/_api/web/lists/GetByTitle('List Title')
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Der folgende XML-Code zeigt ein Beispiel für die Listeneigenschaften, die beim Anfordern des XML-Inhaltstyps zurückgegeben werden.

<content type="application/xml">
  <m:properties>
    <d:AllowContentTypes m:type="Edm.Boolean">true</d:AllowContentTypes>
    <d:BaseTemplate m:type="Edm.Int32">100</d:BaseTemplate>
    <d:BaseType m:type="Edm.Int32">0</d:BaseType>
    <d:ContentTypesEnabled m:type="Edm.Boolean">false</d:ContentTypesEnabled>
    <d:Created m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:Created>
    <d:DefaultContentApprovalWorkflowId m:type="Edm.Guid">00000000-0000-0000-0000-000000000000</d:DefaultContentApprovalWorkflowId>
    <d:Description>A list created by Project Based Retention used to store Project Policy Items.</d:Description>
    <d:Direction>none</d:Direction>
    <d:DocumentTemplateUrl m:null="true" />
    <d:DraftVersionVisibility m:type="Edm.Int32">0</d:DraftVersionVisibility>
    <d:EnableAttachments m:type="Edm.Boolean">true</d:EnableAttachments>
    <d:EnableFolderCreation m:type="Edm.Boolean">false</d:EnableFolderCreation>
    <d:EnableMinorVersions m:type="Edm.Boolean">false</d:EnableMinorVersions>
    <d:EnableModeration m:type="Edm.Boolean">false</d:EnableModeration>
    <d:EnableVersioning m:type="Edm.Boolean">false</d:EnableVersioning>
    <d:EntityTypeName>ProjectPolicyItemList</d:EntityTypeName>
    <d:ForceCheckout m:type="Edm.Boolean">false</d:ForceCheckout>
    <d:HasExternalDataSource m:type="Edm.Boolean">false</d:HasExternalDataSource>
    <d:Hidden m:type="Edm.Boolean">true</d:Hidden>
    <d:Id m:type="Edm.Guid">74de3ff3-029c-42f9-bd2a-1e9463def69d</d:Id>
    <d:ImageUrl>/_layouts/15/images/itgen.gif</d:ImageUrl>
    <d:IrmEnabled m:type="Edm.Boolean">false</d:IrmEnabled>
    <d:IrmExpire m:type="Edm.Boolean">false</d:IrmExpire>
    <d:IrmReject m:type="Edm.Boolean">false</d:IrmReject>
    <d:IsApplicationList m:type="Edm.Boolean">false</d:IsApplicationList>
    <d:IsCatalog m:type="Edm.Boolean">false</d:IsCatalog>
    <d:IsPrivate m:type="Edm.Boolean">false</d:IsPrivate>
    <d:ItemCount m:type="Edm.Int32">0</d:ItemCount>
    <d:LastItemDeletedDate m:type="Edm.DateTime">2012-06-26T23:15:58Z</d:LastItemDeletedDate>
    <d:LastItemModifiedDate m:type="Edm.DateTime">2012-06-26T23:15:59Z</d:LastItemModifiedDate>
    <d:ListItemEntityTypeFullName>SP.Data.ProjectPolicyItemListItem</d:ListItemEntityTypeFullName>
    <d:MultipleDataList m:type="Edm.Boolean">false</d:MultipleDataList>
    <d:NoCrawl m:type="Edm.Boolean">true</d:NoCrawl>
    <d:ParentWebUrl>/</d:ParentWebUrl>
    <d:ServerTemplateCanCreateFolders m:type="Edm.Boolean">true</d:ServerTemplateCanCreateFolders>
    <d:TemplateFeatureId m:type="Edm.Guid">00bfea71-de22-43b2-a848-c05709900100</d:TemplateFeatureId>
    <d:Title>Project Policy Item List</d:Title>
  </m:properties>
</content>

Hinweis

Die Eigenschaft ListItemEntityTypeFullName (SP.Data.ProjectPolicyItemListItem im vorherigen Beispiel) ist besonders wichtig, wenn Sie Listenelemente erstellen und aktualisieren möchten. Dieser Wert muss als Eigenschaft type in den Metadaten übergeben werden, die Sie grundsätzlich beim Erstellen und Aktualisieren von Listenelemente im Textkörper der HTTP-Anforderung übergeben.

Arbeiten mit Listen unter Verwendung von REST

Das folgende Beispiel zeigt, wie Sie eine Liste erstellen.

POST https://{site_url}/_api/web/lists
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json"
Content-Length: {length of request body as integer}
X-RequestDigest: "{form_digest_value}"

{
  "__metadata": {
    "type": "SP.List"
  },
  "AllowContentTypes": true,
  "BaseTemplate": 100,
 "ContentTypesEnabled": true,
 "Description": "My list description",
 "Title": "Test"
}

Das folgende Beispiel zeigt, wie Sie eine Liste aktualisieren und dazu die MERGE-Methode verwenden.

POST https://{site_url}/_api/web/lists(guid'{list_guid}')
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json"
Content-Length: {length of request body as integer}
If-Match: "{etag or *}"
X-HTTP-Method: "MERGE"
X-RequestDigest: "{form_digest_value}"

{
  "__metadata": {
    "type": "SP.List"
  },
  "Title": "New title"
}

Das folgende Beispiel zeigt, wie Sie ein benutzerdefiniertes Feld für eine Liste erstellen.

POST https://{site_url}/_api/web/lists(guid'{list_guid}')/Fields
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json"
Content-Length: {length of request body as integer}
X-RequestDigest: "{form_digest_value}"

{
  "__metadata": {
    "type": "SP.Field"
  },
  "Title": "field title",
  "FieldTypeKind": FieldType value,
  "Required": "true/false",
  "EnforceUniqueValues": "true/false",
  "StaticName": "field name"
}

Das folgende Beispiel zeigt, wie Sie eine Liste löschen.

POST https://{site_url}/_api/web/lists(guid'{list_guid}')
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
If-Match: "{etag or *}"
X-HTTP-Method: "DELETE"
X-RequestDigest: "{form_digest_value}"

Nachschlagen von Spaltenänderungen

Beim Verweisen auf eine Nachschlagespalte in einer Liste mithilfe der REST-API verwenden Sie anstelle des internen Namens den Anzeigename der Nachschlagespalte.

GET https://{site_url}/_api/web/lists/getbytitle('ListName')/Items?&$filter=LookupColumnId eq 1
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Arbeiten mit Listenelementen unter Verwendung von REST

Abrufen aller Listenelemente

Das folgende Beispiel zeigt, wie Sie alle Elemente einer Liste abrufen.

Hinweis

  • Der OData $skip-Abfrageparameter funktioniert nicht, wenn Listenelemente abgefragt werden. In vielen Fällen können Sie stattdessen die Option $skiptoken verwenden.
  • Dadurch werden standardmäßig die ersten 100 Elemente zurückgegeben. Weitere Informationen zum Steuern der Anzahl der Elemente, zur Seitenverwaltung usw. finden Sie in der Dokumentation zu OData-Abfragevorgängen.
GET https://{site_url}/_api/web/lists/GetByTitle('Test')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Abrufen eines bestimmten Listenelements

Das folgende Beispiel zeigt, wie Sie ein bestimmtes Listenelement abrufen.

GET https://{site_url}/_api/web/lists/GetByTitle('Test')/items({item_id})
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Der folgende XML-Code zeigt ein Beispiel für die Listenelementeigenschaften, die beim Anfordern des XML-Inhaltstyps zurückgegeben werden.

<content type="application/xml">
  <m:properties>
    <d:FileSystemObjectType m:type="Edm.Int32">0</d:FileSystemObjectType>
    <d:Id m:type="Edm.Int32">1</d:Id>
    <d:ID m:type="Edm.Int32">1</d:ID>
    <d:ContentTypeId>0x010049564F321A0F0543BA8C6303316C8C0F</d:ContentTypeId>
    <d:Title>an item</d:Title>
    <d:Modified m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Modified>
    <d:Created m:type="Edm.DateTime">2012-07-24T22:47:26Z</d:Created>
    <d:AuthorId m:type="Edm.Int32">11</d:AuthorId>
    <d:EditorId m:type="Edm.Int32">11</d:EditorId>
    <d:OData__UIVersionString>1.0</d:OData__UIVersionString>
    <d:Attachments m:type="Edm.Boolean">false</d:Attachments>
    <d:GUID m:type="Edm.Guid">eb6850c5-9a30-4636-b282-234eda8b1057</d:GUID>
  </m:properties>
</content>

Elementen als Datenstrom abrufen

Ruft Informationen über die Liste und deren Daten ab. Mit dieser API können Sie Listenelemente abrufen, falls sie komplexe Felder wie Suchvorgänge oder verwaltete Metadaten verwenden.

POST https://{site_url}/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
Content-Type: "application/json;odata=nometadata"

{
  "parameters": {
    "AddRequiredFields": "true",
    "DatesInUtc": "true",
    "RenderOptions": 17
  }
}

RenderListDataAsStream-URI-Parameter

Die folgenden Eigenschaften können als Parameter der Abfragezeichenfolge hinzugefügt werden, um die zurückgegebenen Daten zu bearbeiten.

Eigenschaft Beschreibung Typ Beispiel
CascDelWarnMessage Gibt an, ob eine Meldung angezeigt werden soll, wenn es eine Löschweitergabewarnung vorliegt number 1
DrillDown Gibt an, dass einige Gruppen in einer gruppierten Ansicht erweitert werden. Wird mit GroupString verwendet. string
GroupString Gruppenbezeichner, der für das Drilldownfeature verwendet wird. string
HasOverrideSelectCommand Wird verwendet, um das Vorhandensein bestimmter Felder sicherzustellen, damit das SharePoint-ListView-Steuerelement ordnungsgemäß funktioniert. string
Field Gibt ein spezielles Feld an, das eingeschlossen werden sollen. string
FieldInternalName Wird verwendet, um ein Feld zu identifizieren, wenn eine Liste über eine externe Datenquelle verfügt. Wird auch beim Filtern nach einem benutzerdefinierten Feld verwendet. string
Filter Gibt an, ob auf die angeforderte Ansicht ein Filter angewendet werden soll. string
FilterData Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData1 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData2 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData3 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData4 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData5 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData6 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData7 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData8 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData9 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterData10 Daten, die durch einen bestimmten Filter angegeben werden. string
FilterField Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string
FilterField1 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField2 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField3 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField4 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField5 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField6 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField7 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField8 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField9 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterField10 Ein Filterfeldname für einen bestimmten Filter, der auf die Ansicht angewendet wird. string ID
FilterFields Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields1 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields2 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields3 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields4 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields5 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields6 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields7 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields8 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields9 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterFields10 Gibt mehrere Felder an, nach denen für einen Multiplikatorfilter gefiltert wird. string
FilterValue Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string
FilterValue1 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue2 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue3 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue4 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue5 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue6 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue7 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue8 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue9 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValue10 Der einem bestimmten Filter zugeordnete Filterwert. "FilterField3" ist beispielsweise "FilterValue3" zugeordnet usw. string 1
FilterValues Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues1 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues2 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues3 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues4 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues5 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues6 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues7 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues8 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues9 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterValues10 Wird mit FilterFields für Multiplikatorfilter verwendet. "FilterField3" wäre beispielsweise "FilterValue3" zugeordnet usw. string
FilterLookupId Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId1 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId2 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId3 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId4 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId5 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId6 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId7 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId8 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId9 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterLookupId10 Wird beim Filtern nach einem Nachschlagefeld verwendet. Dies ist die Element-ID in der Fremdliste, die über einen Wert verfügt, nach dem gefiltert wird. string
FilterOnly string
FilterOp Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp1 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp2 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp3 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp4 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp5 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp6 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp7 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp8 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp9 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
FilterOp10 Filteroperator. Wird verwendet, wenn mit anderen Operatoren als Eq gefiltert wird (Geq, Leq usw.). string Geq
ID Die Element-ID des Elements, dessen Informationen gesucht werden. number
InplaceSearchQuery Suchbegriff für eine vollständige Listensuche. string
InplaceFullListSearch Ein boolescher Wert, der angibt, ob es eine vollständige Listensuche vorliegt. string
IsCSR Gibt an, ob diese Ansicht eine clientseitige gerenderte Ansicht ist. string
CustomAction string
IsGroupRender Wird verwendet, um die IsGroupRender-Eigenschaft der SPView festzulegen. string
IsRibbon string
IsXslView Gibt an, ob diese Ansicht eine XSLT-Listenansicht ist. string
List string
ListId string
ListViewPageUrl string
OverrideScope Wird verwendet, um einen Bereich in der gerenderten Ansicht zu überschreiben: SPView.Scope string
OverrideSelectCommand Wird verwendet, um sicherzustellen, dass bestimmte Felder in der Abfrage vorhanden sind, unabhängig davon, ob sie explizit in die Ansicht einschlossen werden. string
PageFirstRow Auslagerungsinformationen über die erste Zeile, die angefordert wird. Wird für Auslagerungslistenansichten verwendet. string
PageLastRow Auslagerungsinformationen über die letzte Zeile, die angefordert wird. Wird für Auslagerungslistenansichten verwendet. string
RootFolder Der Ordner, den die Ansicht anzeigt. string
SortField Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField1 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField2 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField3 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField4 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField5 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField6 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField7 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField8 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField9 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortField10 Ein Feld, nach dem die Ansicht sortiert werden soll. string ID
SortFields Gibt den Namen des ersten Felds an, nach dem sortiert werden soll. string
SortFieldValues Gibt den Namen des ersten Felds an, nach dem sortiert werden soll. string
SortDir Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir1 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir2 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir3 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir4 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir5 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir6 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir7 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir8 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir9 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
SortDir10 Die Sortierrichtung einer Ad-hoc-Sortierung, die auf die Ansicht angewendet wird. string Desc
View Gibt die Basisansicht an, die zum Rendern der Liste verwendet wird. GUID 3d13559e-3071-5000-76b8-8f1ca6b835f0
ViewPath Gibt den Pfad der Ansicht an, die zum Rendern der Liste verwendet wird. Bei Angabe von ViewId wird ViewId verwendet, und dieser Parameter wird ignoriert. string
ViewCount Wenn mehrere Listenansichten auf einer Seite vorhanden sind, wird hiermit eine davon identifiziert. string
ViewId Gibt die Basisansicht an, die zum Rendern der Liste verwendet wird. Ad-hoc-Parameter werden auf diese Ansicht angewendet. Bei Angabe von ViewXml und BaseViewId wird ViewXml verwendet, und die Ad-hoc-Parameter werden ignoriert. string
WebPartId Die ID des Listenansicht-Webparts, das diese Ansicht anzeigt. string

Eigenschaften des RenderListDataAsStream-Textkörperparameters

Eigenschaft Beschreibung Typ Beispiel
AddRequiredFields Gibt an, ob erforderliche Felder zurückgegeben werden sollen bool true
AllowMultipleValueFilterForTaxonomyFields Gibt an, ob das Filtern mit mehreren Werten für Taxonomiefelder zulässig ist bool true
DatesInUtc Gibt an, ob das DateTime-Feld in UTC oder Ortszeit zurückgegeben wird bool true
ExpandGroups Gibt an, ob die Gruppierung erweitert werden soll bool true
FirstGroupOnly Gibt an, wenn nur die erste Gruppe zurückgegeben werden soll (unabhängig vom Ansichtsschema) bool true
FolderServerRelativeUrl Gibt die URL des Ordners an, aus dem Elemente zurückgegeben werden sollen string /sites/team-a/lists/Orders/Europe
ImageFieldsToTryRewriteToCdnUrls Durch Trennzeichen getrennte Liste von Feldnamen, deren Werte in CDN-URLs umgeschrieben werden sollen string ArticleImage,SecondaryImage
OverrideViewXml Gibt den Überschreib-XML-Code an, der mit der Ansichts-CAML kombiniert werden soll. Gilt nur für den Query/Where-Teil der Ansichts-CAML. string <Query><Where><Gt><FieldRef Name=\"OrderCount\" /><Value Type=\"Number\">3</Value></Gt></Where></Query>
Paging Gibt die Auslagerungsinformationen an string
RenderOptions Gibt den zurückzugebenden Ausgabetyp an SPRenderListDataOptions Mögliche Werte finden Sie im nächsten Abschnitt. Sie können mehrere Werte angeben, indem Sie die Werte zusammen hinzufügen.
ReplaceGroup Gibt an, ob die Gruppierung ersetzt werden soll, um die GroupBy-Einschränkkung zu behandeln. bool true
ViewXml Gibt den CAML-Ansichts-XML-Code an. string
SPRenderListDataOptions-Optionen
Label Beschreibung Wert
None Gibt die Standardausgabe zurück 0
ContextInfo Gibt Listenkontextinformationen zurück 1
ListData Gibt Listendaten zurück (entspricht None) 2
ListSchema Gibt das Listenschema zurück 4
MenuView Gibt den HTML-Code für das Listenmenü zurück 8
ListContentType Gibt Informationen zu Listeninhaltstypen zurück. Muss mit dem ContextInfo-Flag kombiniert werden. 16
FileSystemItemId Die zurückgegebene Liste enthält nach Möglichkeit ein FileSystemItemId Feld für jedes Element. Muss mit dem ListData-Flag kombiniert werden. 32
ClientFormSchema Gibt das Clientformularschema zum Hinzufügen und Bearbeiten von Elementen zurück 64
QuickLaunch Gibt QuickLaunch-Navigationsknoten zurück 128
Spotlight Gibt Spotlight-Darstellungsinformationen zurück 256
Visualization Gibt Visualiserungs-Darstellungsinformationen zurück 512
ViewMetadata Gibt den XML-Code der Ansicht und andere Informationen über die aktuelle Ansicht zurück 1024
DisableAutoHyperlink Verhindert, dass AutoHyperlink für Textfelder in diese Abfrage ausgeführt wird 2048
EnableMediaTAUrls Aktiviert URLs, die auf den Media-TA-Dienst verweisen, z. B. .thumbnailUrl, .videoManifestUrl, .pdfConversionUrls 4096
ParentInfo Gibt Informationen zum übergeordneten Ordner zurück 8192
PageContextInfo Gibt Seitenkontextinformationen für die aktuelle Liste zurück, die gerendert wird 16384
ClientSideComponentManifest Gibt Manifestinformationen der clientseitigen Komponente im Zusammenhang mit der Liste zurück (reserviert für zukünftige Verwendung) 32768

Beispiele

Element mit einer bestimmten ID abrufen
POST https://{site_url}/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&FilterField1=ID&FilterValue1=1
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
...
Elemente absteigend nach ID sortieren
POST https://{site_url}/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27&SortField=ID&SortDir=Desc
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
...
Elemente aus dem angegebenen Ordner abrufen
POST https://{site_url}/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FOrders%27
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
Content-Type: "application/json"

{
  "parameters": {
    "FolderServerRelativeUrl": "/sites/team-a/lists/Orders/Europe"
  }
}
Listenschema abrufen
POST https://{site_url}/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
Content-Type: "application/json"

{
  "parameters": {
    "RenderOptions": 4
  }
}
Informationen zu Listeninhaltstypen abrufen
POST https://{site_url}/sites/team-a/_api/web/GetList(@listUrl)/RenderListDataAsStream?@listUrl=%27%2Fsites%2Fteam-a%2Flists%2FList%27
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
Content-Type: "application/json"

{
  "parameters": {
    "RenderOptions": 17
  }
}

Erstellen eines Listenelements

Das folgende Beispiel zeigt, wie Sie ein Listenelement erstellen.

Hinweis

Um diese Operation durchzuführen, müssen Sie die Eigenschaft ListItemEntityTypeFullName der Liste kennen und sie als Wert von type im Textkörper der HTTP-Anforderung übergeben. Es folgt ein Beispiel für einen REST-Aufruf zum Abrufen von ListItemEntityTypeFullName

GET https://{site_url}/_api/web/lists/GetByTitle('Test')?$select=ListItemEntityTypeFullName
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=nometadata"
POST https://{site_url}/_api/web/lists/GetByTitle('Test')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json;odata=verbose"
Content-Length: {length of request body as integer}
X-RequestDigest: "{form_digest_value}"

{
  "__metadata": {
    "type": "SP.Data.TestListItem"
  },
  "Title": "Test"
}

Erstellen eines Listenelements in einem Ordner

Das folgende Beispiel zeigt, wie Sie ein Listenelement in einem Ordner erstellen.

POST https://{site_url}/_api/web/lists/GetByTitle('Test')/AddValidateUpdateItemUsingPath
Authorization: "Bearer " + accessToken
Accept          "application/json;odata=nometadata"
Content-Type    "application/json;odata=nometadata"
X-RequestDigest "The appropriate digest for current site"

{
  "listItemCreateInfo": {
    "FolderPath": {
      "DecodedUrl": "https://{site_url}/lists/Test/Folder/SubFolder"
    },
    "UnderlyingObjectType": 0
  },
  "formValues": [
    {
      "FieldName": "Title",
      "FieldValue": "Item"
    }
  ],
  "bNewDocumentUpdate": false
}

Anfordern von Eigenschaftendetails

Eigenschaft Beschreibung
listItemCreateInfo Informationen zur der Liste und dem Ordner, in denen das Element erstellt werden soll
listItemCreateInfo.FolderPath.DecodedUrl Absolute URL des Ordners, in dem das Element erstellt werden soll
listItemCreateInfo.UnderlyingObjectType Der Typ des zu erstellenden Elements. Weitere Informationen finden Sie unter FileSystemObjectType.
formValues Array von Feldnamen und Werten zum Festlegen des neu erstellten Elements
bNewDocumentUpdate Auf false festlegen, um ein Listenelement zu erstellen

Antworten

Name Typ Beschreibung
200 OK Boolean Erfolg
{
  "value": [
    {
      "ErrorMessage": null,
      "FieldName": "Title",
      "FieldValue": "Item",
      "HasException": false,
      "ItemId": 0
    },
    {
      "ErrorMessage": null,
      "FieldName": "Id",
      "FieldValue": "1",
      "HasException": false,
      "ItemId": 0
    }
  ]
}

Die value-Eigenschaft enthält die Liste der Eigenschaften, die beim Erstellen des Listenelements festgelegt wurden.

Aktualisieren des Listenelements

Das folgende Beispiel zeigt, wie Sie ein Listenelement aktualisieren.

Hinweis

Um diese Operation durchzuführen, müssen Sie die Eigenschaft ListItemEntityTypeFullName der Liste kennen und sie als Wert von type im Textkörper der HTTP-Anforderung übergeben.

POST https://{site_url}/_api/web/lists/GetByTitle('Test')/items({item_id})
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json"
Content-Length: {length of request body as integer}
If-Match: "{etag or *}"
X-HTTP-Method: "MERGE"
X-RequestDigest: "{form_digest_value}"

{
  "__metadata": {
    "type": "SP.Data.TestListItem"
  },
  "Title": "TestUpdated"
}

Löschen eines Listenelements

Das folgende Beispiel zeigt, wie Sie ein Listenelement löschen.

POST https://{site_url}/_api/web/lists/GetByTitle('Test')/items({item_id})
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Content-Type: "application/json"
If-Match: "{etag or *}"
X-HTTP-Method: "DELETE"

Verwenden von ETag-Werten zum Bestimmen der Version von Dokument- und Listenelementen

Der SharePoint REST-Dienst, der sich nach dem OData-Standard richtet, verwendet Header ETags für SharePoint-Listen und -Listenelemente. Um die Version eines Elements beim Ausführen einer PUT-, MERGE- oder DELETE-Anforderung zu prüfen, geben Sie ein ETag im HTTP-Anforderungsheader If-Match an.

Wenn das in Ihrer Anforderung angegebene ETag nicht mit dem ETag des Dokument- oder Listenelements auf dem Server übereinstimmt, gibt der REST-Dienst gemäß der OData-Spezifikation eine 412-Ausnahme zurück.

  • Wenn Sie ein Überschreiben des Elements unabhängig von der Version erzwingen möchten, legen Sie den ETag-Wert auf "*" fest.
  • Wenn Sie kein ETag angeben, überschreibt SharePoint das Element unabhängig von der Version.

In SharePoint gelten ETags nur für SharePoint-Listen und Listenelemente.

Siehe auch