REST-API-Referenz zu Listen und Listenelementen

Erfahren Sie mehr über Listen, Listenelemente, Ansichten und anderen listenbezogenen Ressourcen und Endpunkten in der REST-API..

Letzte Änderung: Donnerstag, 17. September 2015

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

Informationen zu Anforderungsbeispielen in diesem Artikel

Die Anforderungsbeispiele in diesem Artikel gehen davon aus, dass Sie die domänenübergreifende Bibliothek (SP.RequestExecutor.js) verwenden, um domänenübergreifende Anforderungen durchzuführen. Dafür verwenden sie die SP.AppContextSite in der Endpunkt-URI. Weitere Informationen dazu finden Sie unter Zugreifen auf SharePoint 2013-Daten über Add-Ins mithilfe der domänenübergreifenden Bibliothek.

Bevor Sie ein Anforderungsbeispiel verwenden, sollten Sie folgende Schritte durchführen:

  • Ändern Sie die <App Web-URL>, <Hostweb-URL> und andere Platzhalterdaten, wie IDs, Namen oder Pfade von SharePoint-Entitäten.

  • Falls Sie nicht die domänenübergreifende Bibliothek verwenden, müssen Sie eine X-RequestDigest-Kopfzeile einbeziehen, 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 durchführen, müssen Sie 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>) miteinbeziehen, um ein OAuth-Zugriffstoken zu senden.

  • Entfernen Sie die Zeilenumbrüche aus den url- und body-Eigenschaftswerten in den Anforderungsbeispielen. Den Beispielen wurden Zeilenumbrüche hinzugefügt, damit man sie leichter lesen kann.

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

Links zu weiteren Informationen zum Verwenden der domänenübergreifenden Bibliothek, OAuth und des SharePoint REST-Diensts 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.

Sehen Sie sich die SharePoint 2013-Listen und Listenelemente der REST-Syntax an

Hinweise zur Syntax der REST-Dienstliste und -Listenelemente

Weitere Informationen finden Sie unter den SharePoint 2013-Listen und Listenelemente der REST-Syntax.

Weitere SharePoint REST-Syntaxdiagramme:

Dateien und Ordner | Benutzer und Gruppen

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

Hinweis

Die OData-Abfrageoption $skip funktioniert nicht beim Abfragen von Listenelementen. Sie funktioniert beim Abfragen des Listenendpunkts.

List-Ressource

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

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Endpunkt-URI

http://<Website-URL>/web/lists(guid'<Listen-ID>')

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen einer Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByTitle-Methode aus der ListCollection-Ressource verwenden, um eine Liste nach dem Titel abzurufen. Beispiel: …/web/lists/getbytitle('Access Requests').

POST-Anforderungsbeispiel: Erstellen einer Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

MERGE-Anforderungsbeispiel: Ändern einer Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "MERGE",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

DELETE-Anforderungsbeispiel: Löschen einer Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Wenn Sie eine Liste wiederverwenden möchten, um die GUID des Papierkorbelements abzurufen, müssen Sie die Recycle-Methode der Liste verwenden, um die Datei zu entfernen.

Listeneigenschaften

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
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/<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

AllowContentTypes

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob die Liste Inhaltstypen unterstützt.

BaseTemplate

Int32

R

Ja

Ruft den Listendefinitionstyp ab, auf dem die Liste basiert. Stellt einen ListTemplateType-Wert dar. Unter ListTemplateType in der .NET-Clientobjekt-Modellreferenz finden Sie Vorlagentypwerte.

BaseType

Int32

R

Ja

Ruft den Basistyp für die Liste ab. Stellt einen SP.BaseType-Wert dar: Generic List = 0; Document Library = 1; Discussion Board = 3; Survey = 4; Issue = 5.

BrowserFileHandling

Int32

R

Nein

Ruft einen Wert ab, der die Überschreibung der BrowserFileHandling-Eigenschaft der Webanwendung auf Listenebene angibt. Stellt einen SP.BrowserFileHandling-Wert dar: Permissive = 0; Strict = 1.

ContentTypes

SP.ContentTypeCollection

R

Nein

Ruft die Inhaltstypen ab, die der Liste zugeordnet sind.

ContentTypesEnabled

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Inhaltstypen für die Liste aktiviert sind.

Erstellt

DateTime

R

Ja

Ruft einen Wert ab, der angibt, wann die Liste erstellt wurde.

DataSource

SP.ListDataSource

R

Nein

Ruft die mit der Liste verknüpfte Datenquelle ab (oder null, falls es sich bei der Liste nicht um eine virtuelle Liste handelt). Gibt Null zurück, wenn die HasExternalDataSource-Eigenschaft false lautet.

DefaultContentApprovalWorkflowId

GUID

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den standardmäßigen Workflowbezeichner für die Inhaltsgenehmigung der Liste angibt. Gibt eine leere GUID zurück, wenn kein standardmäßiger Inhaltsgenehmigungsworkflow vorhanden ist.

DefaultDisplayFormUrl

String

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der den Speicherort des standardmäßigen Anzeigeformulars für die Liste angibt. Clients geben eine serverrelative URL an, und der Server gibt eine websiterelative URL zurück

DefaultEditFormUrl

String

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der die URL des Bearbeitungsformulars angibt, das für Listenelemente in der Liste verwendet werden soll. Clients geben eine serverrelative URL an und der Server gibt eine websiterelative URL zurück.

DefaultNewFormUrl

String

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der den Speicherort des standardmäßigen neuen Formulars für die Liste angibt. Clients geben eine serverrelative URL an und der Server gibt eine websiterelative URL zurück.

DefaultView

SP.View

R

Nein

DefaultViewUrl

String

R

Nein

Ruft die URL der Standardansicht für die Liste ab.

Beschreibung

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Beschreibung der Liste angibt.

Richtung

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Lesereihenfolge der Liste angibt. Gibt "NONE", "LTR" oder "RTL" zurück.

DocumentTemplateUrl

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die serverrelative URL der Dokumentvorlage für die Liste angibt. Gibt eine serverrelative URL zurück, wenn der Basistyp DocumentLibrary lautet, andernfalls wird Null zurückgegeben.

DraftVersionVisibility

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die mindestens erforderlichen Berechtigungen zum Anzeigen von Nebenversionen und Entwürfen innerhalb der Liste angibt. Stellt einen SP.DraftVisibilityType-Wert dar: Reader = 0; Author = 1; Approver = 2.

EffectiveBasePermissions

SP.BasePermissions

R

Nein

Ruft einen Wert ab, der die effektiven Berechtigungen für die Liste angibt, die dem aktuellen Benutzer zugewiesen sind.

EffectiveBasePermissionsForUI

SP.BasePermissions

R

Nein

EnableAttachments

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Listenelementanlagen für die Liste aktiviert sind.

EnableFolderCreation

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Liste neue Listenordner hinzugefügt werden können.

EnableMinorVersions

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Nebenversionen für die Liste aktiviert sind.

EnableModeration

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Inhaltsgenehmigung für die Liste aktiviert ist.

EnableVersioning

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob ältere Versionen von Listenelementen und Dokumenten in der Liste erstellt werden können.

EntityTypeName

String

R

Ja

EventReceivers

SP.EventReceiverDefinitionCollection

R

Nein

Felder

SP.FieldCollection

R

Nein

Ruft einen Wert ab, der die Auflistung aller Felder in der Liste angibt.

FirstUniqueAncestorSecurableObject

SP.SecurableObject

R

Nein

Ruft das Objekt ab, bei dem Rollenzuweisungen für dieses Objekt definiert sind. Wenn Rollenzuweisungen direkt zum aktuellen Objekt definiert werden, wird das aktuelle Objekt zurückgegeben.

ForceCheckout

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das erzwungene Auschecken für die Dokumentbibliothek aktiviert ist.

Formulare

SP.FormCollection

R

Nein

Ruft einen Wert ab, der die Auflistung aller Listenformulare in der Liste angibt.

HasExternalDataSource

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob es sich bei der Liste um eine externe Liste handelt.

HasUniqueRoleAssignments

Boolean

R

Nein

Ruft einen Wert ab, der angibt, ob die Rollenzuweisungen für dieses sicherungsfähige Objekt eindeutig definiert oder von einem übergeordneten sicherungsfähigen Objekt geerbt werden.

Ausgeblendet

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Liste ausgeblendet ist. Falls true, setzt der Server die OnQuickLaunch-Eigenschaft auf false.

ID

GUID

R

Ja

Ruft die GUID ab, über die die Liste in der Datenbank identifiziert wird.

ImageUrl

String

R

Ja

Ruft einen Wert ab, der die URI für das Symbol der Liste angibt.

InformationRightsManagementSettings

SP.InformationRightsManagementSettings

R

Nein

IrmEnabled

Boolean

RW

Ja

IrmExpire

Boolean

RW

Ja

IrmReject

Boolean

RW

Ja

IsApplicationList

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der ein Kennzeichen angibt, mit dessen Hilfe eine Clientanwendung bestimmen kann, ob die Liste angezeigt werden soll.

IsCatalog

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob es sich bei der Liste um einen Katalog handelt.

IsPrivate

Boolean

R

Ja

IsSiteAssetsLibrary

Boolean

R

Nein

Ruft einen Wert ab, der angibt, ob die Liste als standardmäßiger Objektspeicherort für Bilder oder andere Dateien konzipiert ist, die die Benutzer an ihre Wiki-Seiten hochladen.

ItemCount

Int32

R

Ja

Ruft einen Wert ab, der die Anzahl von Listenelementen in der Liste angibt.

Elemente

SP.ListItemCollection

R

Nein

Ruft alle Elemente in der Liste ab.

Sie können OData-Abfragevorgänge zum Filtern von Elementen verwenden (Beispiel: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

LastItemDeletedDate

DateTime

R

Ja

Ruft ein Wert ab, der angibt, wann zuletzt ein Listenelement aus der Liste gelöscht wurde.

LastItemModifiedDate

DateTime

RW

Ja

Ruft einen Wert ab, der angibt, wann ein Listenelement, ein Feld oder eine Eigenschaft der Liste geändert wurde.

ListItemEntityTypeFullName

String

R

Ja

MultipleDataList

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Liste auf einer Website mit einem Besprechungsarbeitsbereich Daten für mehrere Besprechungsinstanzen innerhalb der Website enthält.

NoCrawl

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, dass der Crawler die Liste nicht durchforsten darf.

OnQuickLaunch

Boolean

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Liste im Schnellstartbereich der Website erscheint. Falls true, setzt der Server die Hidden-Eigenschaft auf false.

ParentWeb

SP.Web

R

Nein

Ruft einen Wert ab, der die Website für die Liste angibt.

ParentWebUrl

String

R

Ja

Ruft einen Wert ab, der die serverrelative URL der Website mit der Liste angibt.

RoleAssignments

SP.RoleAssignmentCollection

R

Nein

Ruft die Rollenzuweisungen für das sicherungsfähige Objekt ab.

RootFolder

SP.Folder

R

Nein

Ruft den Stammordner mit den Dateien in der Liste sowie weiteren zugehörigen Dateien ab.

SchemaXml

String

R

Nein

Ruft einen Wert ab, der das Listenschema der Liste angibt.

ServerTemplateCanCreateFolders

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob innerhalb der Liste Ordner erstellt werden können.

TemplateFeatureId

GUID

R

Ja

Ruft einen Wert ab, der den Featurebezeichner des Features angibt, das das Listenschema für die Liste enthält. Gibt eine leer GUID zurück, falls das Listenschema nicht in einer Funktion enthalten ist.

Titel

String

RW

Ja

Dient zum Abrufen oder Festlegen des angezeigten Titels für die Liste. Die Länge muss <= 255 Zeichen sein.

UserCustomActions

SP.UserCustomActionCollection

R

Nein

Ruft einen Wert ab, der die Auflistung von benutzerdefinierten Aktionen aller Benutzer für die Liste angibt.

ValidationFormula

String

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der die Datenüberprüfungskriterien für ein Listenelement angibt. Die Länge muss <= 1023 Zeichen sein.

ValidationMessage

String

RW

Nein

Dient zum Abrufen oder Festlegen eines Werts, der die Fehlermeldung angibt, die im Falle eines Datenüberprüfungsfehlers für ein Listenelement zurückgegeben wird. Die Länge muss <= 1023 Zeichen sein.

Ansichten

SP.ViewCollection

R

Nein

Ruft einen Wert ab, der die Auflistung aller öffentlichen Ansichten der Liste und aller persönlichen Ansichten des aktuellen Benutzers der Liste angibt.

WorkflowAssociations

SP.Workflow.WorkflowAssociationCollection

R

Nein

Ruft einen Wert ab, der die Auflistung aller Workflowzuordnungen für die Liste angibt.

Listenmethoden

AddItem
BreakRoleInheritance
DeleteObject
GetChanges
GetItemById
GetItems
GetListItemChangesSinceToken
GetRelatedFields
GetUserEffectivePermissions
GetView
Recycle
RenderListData
RenderListFormData
ReserveListItemId
ResetRoleInheritance

AddItem-Methode

Beispiele

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 aus dem aktuellen Objekt erben; false (standardmäßig), 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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /breakroleinheritance(copyroleassignments=false, clearsubscopes=true)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

DeleteObject-Methode

Beispiele

GetChanges-Methode

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

Endpunkt

/getchanges

Parameter

query

Typ: SP.ChangeQuery
Die Änderungsabfrage. Geben Sie diesen Parameter in dem Anforderungstext an, wie in dem Anforderungsbeispiel gezeigt.

HTTP method

POST

Antwort

Typ: SP.ChangeCollection
Die Änderungen an der Liste, die mit den Kriterien der angegebenen Änderungsabfrage übereinstimmen.

Anforderungsbeispiel

var metadata = "{ 'query' : { '__metadata': { 'type': 'SP.ChangeQuery' },
    'Add': 'True', 'Item': 'True' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getchanges
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Antwortbeispiel

    {"d":
      {"results":[{
        "__metadata":{
          "id":"https://<site url>/_api/SP.ChangeItema7e7c6e9-2c41-47c3-aae9-2b4a63b7a087",
          "uri":"https://<site url>/_api/SP.ChangeItem",
          "type":"SP.ChangeItem"
        },
        "ChangeToken":{"__metadata":{"type":"SP.ChangeToken"}, "StringValue":"1;3;482e418a-0900-414b-8902-02248c2e44e8;634955266749500000;5749111"},
        "ChangeType":1,
        "SiteId":"ce11bfbb-cf9d-4b2b-a642-8673bd48cceb",
        "Time":"2013-02-03T22:17:54Z",
        "ItemId":1,
        "ListId":"482e418a-0900-414b-8902-02248c2e44e8",
        "WebId":"a975b994-fc67-4203-a519-b160175ca967"
      }]
    }}

GetItemById-Methode

Gibt das Listenelement mit dem angegebenen Listenelementbezeichner zurück.

Endpunkt

/getitembyid(<Element-ID>)

Parameter

Typ: Int32
Die ID des Listenelements.

HTTP method

GET

Antwort

Typ: SP.ListItem
Das Listenelement mit der angegebenen ID.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')
    /getitembyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die Listenelemente-ID an die ListItemCollection-Ressource weitergeben. Beispiel: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items(2).

GetItems-Methode

Gibt auf der Grundlage der angegebenen Abfrage eine Auflistung von Elementen aus der Liste zurück.

Endpunkt

/getitems

Parameter

query

Typ: SP.CamlQuery
Die Filterabfrage. Geben Sie diesen Parameter im Anforderungstext an, wie im Anforderungsbeispiel gezeigt.

HTTP method

POST

Antwort

Typ: SP.ListItemCollection
Die Listenelemente, die mit der angegebenen Abfrage übereinstimmen.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /getitems
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'query' : {'__metadata': { 'type': 'SP.CamlQuery' }, "ViewXml": "<View><Query><Where><Contains><FieldRef Name='Status'/><Value Type='CHOICE'>in progress</Value></Contains></Where></Query></View>" } }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json; odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

GetListItemChangesSinceToken-Methode

Endpunkt

/getlistitemchangessincetoken

Parameter

query

Typ: SP.ChangeLogItemQuery
Die Abfrage, die das Änderungstoken enthält. Geben Sie diesen Parameter im Anforderungstext an, wie im Anforderungsbeispiel gezeigt.

HTTP method

POST

Antwort

Typ: GetListItemChangesSinceTokenResult
Ein Stream, der eine XML-Darstellung der Änderungen an den Listenelementen enthält, die nach der angegebenen Änderung erfolgt sind.

Anforderungsbeispiel

var metadata = "{ 'query': { '__metadata': { 'type': 'SP.ChangeLogItemQuery' },
    'ChangeToken': '1;3;79cc20e6-adda-438e-8a96-792041b33168;635103901830230000;33050019' }}";

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getlistitemchangessincetoken
    ?@target='<host web url>'",
  method: "POST",
  body: metadata,
  headers: { "content-type": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Unter Synchronisieren von SharePoint-Elementen mit dem REST-Dienst finden Sie ein Beispiel dazu, wie Sie eine gefilterte Abfrage angeben.

Antwortbeispiel

<?xml version="1.0" encoding="utf-8" ?>
<GetListItemChangesSinceTokenResult>
  <listitems MinTimeBetweenSyncs='0' RecommendedTimeBetweenSyncs='180' MaxBulkDocumentSyncSize='500' MaxRecommendedEmbeddedFileSize='500' EffectivePermMask='FullMask' xmlns:s='uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882' xmlns:dt='uuid:C2F41010-65B3-11d1-A29F-00AA00C14882' xmlns:rs='urn:schemas-microsoft-com:rowset' xmlns:z='#RowsetSchema'>
    <Changes LastChangeToken="1;3;79cc20e6-adda-438e-8a96-792041b33168;635110802324330000;33811711">
    <List DocTemplateUrl="" DefaultViewUrl="/Lists/TestList/AllItems.aspx" MobileDefaultViewUrl="" ID="{79CC20E6-ADDA-438E-8A96-792041B33168}" Title="TestList" Description="" ImageUrl="/_layouts/15/images/itgen.png?rev=26" Name="{79CC20E6-ADDA-438E-8A96-792041B33168}" BaseType="0" FeatureId="00bfea71-de22-43b2-a848-c05709900100" ServerTemplate="100" Created="20130725 22:22:35" Modified="20130802 22:43:52" LastDeleted="20130725 22:22:35" Version="4" Direction="none" ThumbnailSize="" WebImageWidth="" WebImageHeight="" Flags="545263616" ItemCount="2" AnonymousPermMask="0" RootFolder="/Lists/TestList" ReadSecurity="1" WriteSecurity="1" Author="11" EventSinkAssembly="" EventSinkClass="" EventSinkData="" EmailAlias="" WebFullUrl="/" WebId="a975b994-fc67-4203-a519-b160175ca967" SendToLocation="" ScopeId="ad9949be-be16-4946-b5de-66c912eda54a" MajorVersionLimit="0" MajorWithMinorVersionsLimit="0" WorkFlowId="" HasUniqueScopes="False" NoThrottleListOperations="False" HasRelatedLists="" Followable="False" AllowDeletion="True" AllowMultiResponses="False" EnableAttachments="True" EnableModeration="False" EnableVersioning="False" HasExternalDataSource="False" Hidden="False" MultipleDataList="False" Ordered="False" ShowUser="True" EnablePeopleSelector="False" EnableResourceSelector="False" EnableMinorVersion="False" RequireCheckout="False" ThrottleListOperations="False" ExcludeFromOfflineClient="False" CanOpenFileAsync="True" EnableFolderCreation="False" IrmEnabled="False" IsApplicationList="False" PreserveEmptyValues="False" StrictTypeCoercion="False" EnforceDataValidation="False" MaxItemsPerThrottledOperation="5000">
      <Fields>
        <Field ID="{03e45e84-1992-4d42-9116-26f756012634}" RowOrdinal="0" Type="ContentTypeId" Sealed="TRUE" ReadOnly="TRUE" Hidden="TRUE" DisplayName="Content Type ID" Name="ContentTypeId" DisplaceOnUpgrade="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE"/>
        <Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Title" Required="TRUE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" ColName="nvarchar1"/>
        <Field ID="{34ad21eb-75bd-4544-8c73-0e08330291fe}" ReadOnly="TRUE" Type="Note" Name="_ModerationComments" DisplayName="Approver Comments" Hidden="TRUE" CanToggleHidden="TRUE" Filterable="FALSE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="_ModerationComments" FromBaseType="TRUE" ColName="ntext1"/>
        <Field ID="{39360f11-34cf-4356-9945-25c44e68dade}" ReadOnly="TRUE" Hidden="TRUE" Type="Text" Name="File_x0020_Type" DisplaceOnUpgrade="TRUE" DisplayName="File Type" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="File_x0020_Type" FromBaseType="TRUE" ColName="nvarchar2"/>
        <Field ID="{fc2e188e-ba91-48c9-9dd3-16431afddd50}" Name="WorkAddress" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="WorkAddress" Group="Core Contact and Calendar Columns" DisplayName="Address" Type="Note" NumLines="2" Sortable="FALSE" ColName="ntext2" RowOrdinal="0"/>
        <Field ID="{fce16b4c-fe53-4793-aaab-b4892e736d15}" Name="EMail" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="EMail" Group="Core Contact and Calendar Columns" DisplayName="E-Mail" ReadOnly="FALSE" Type="Text" FromBaseType="TRUE" AllowDeletion="TRUE" ColName="nvarchar3" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="anewishlisttitle" Required="FALSE" EnforceUniqueValues="FALSE" List="{482e418a-0900-414b-8902-02248c2e44e8}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{9919f3f8-88fb-43fc-b4cb-658b1db1bfe3}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="anewishlisttitle" Name="anewishlisttitle" ColName="int1" RowOrdinal="0"/>
        <Field Type="Lookup" DisplayName="Books title" Required="FALSE" EnforceUniqueValues="FALSE" List="{90146606-81fd-410d-9fdd-d03b6349fbcd}" ShowField="Title" UnlimitedLengthInDocumentLibrary="FALSE" RelationshipDeleteBehavior="None" ID="{879a1cba-91b6-4c0a-99fb-29f877aae3ea}" SourceID="{79cc20e6-adda-438e-8a96-792041b33168}" StaticName="Books_x0020_title" Name="Books_x0020_title" ColName="int2" RowOrdinal="0"/>
        <Field ID="{1d22ea11-1e32-424e-89ab-9fedbadb6ce1}" ColName="tp_ID" RowOrdinal="0" ReadOnly="TRUE" Type="Counter" Name="ID" PrimaryKey="TRUE" DisplayName="ID" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ID" FromBaseType="TRUE"/>
        <Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Type="Computed" DisplayName="Content Type" Name="ContentType" DisplaceOnUpgrade="TRUE" RenderXMLUsingPattern="TRUE" Sortable="FALSE" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" FromBaseType="TRUE">
          <FieldRefs>
            <FieldRef Name="ContentTypeId"/>
          </FieldRefs>
          <DisplayPattern>
            <MapToContentType>
              <Column Name="ContentTypeId"/>
            </MapToContentType>
          </DisplayPattern>
        </Field>
        <…>
      </Fields>
      <RegionalSettings>
        <Language>1033</Language>
        <Locale>1033</Locale>
        <AdvanceHijri>0</AdvanceHijri>
        <CalendarType>1</CalendarType>
        <Time24>False</Time24>
        <TimeZone>480</TimeZone>
        <SortOrder>2070</SortOrder>
        <Presence>True</Presence>
      </RegionalSettings>
      <ServerSettings>
        <ServerVersion>16.0.1810.1236</ServerVersion>
        <RecycleBinEnabled>True</RecycleBinEnabled>
        <ServerRelativeUrl>/</ServerRelativeUrl>
       </ServerSettings>
      </List>
    </Changes>
    <rs:data ItemCount="1">
      <z:row ows_ContentTypeId='0x0100C8CFB1DE383F1B49A44ABD2EB9AC7322' ows_Title='<item title>' ows_ID='2' ows_ContentType='Item' ows_Modified='2013-07-25T23:21:50Z' ows_Created='2013-07-25T23:21:50Z' ows_Author='<author>' ows_Editor='<editor>' ows_owshiddenversion='1' ows_WorkflowVersion='1' ows__UIVersion='512' ows__UIVersionString='1.0' ows_Attachments='0' ows__ModerationStatus='0' ows_LinkTitleNoMenu='<item title>' ows_LinkTitle='<item title>' ows_LinkTitle2='<item title>' ows_SelectTitle='2' ows_Order='200.000000000000' ows_GUID='{D38981C3-2735-4FDF-9B41-91F3ADA8F3F0}' ows_FileRef='2;#Lists/TestList/2_.000' ows_FileDirRef='2;#Lists/TestList' ows_Last_x0020_Modified='2;#2013-07-25T23:21:50Z' ows_Created_x0020_Date='2;#2013-07-25T23:21:50Z' ows_FSObjType='2;#0' ows_SortBehavior='2;#0' ows_PermMask='0x7fffffffffffffff' ows_FileLeafRef='2;#2_.000' ows_UniqueId='2;#{4D719C3B-B8AB-46A0-A080-402DF6EE31C1}' ows_ProgId='2;#' ows_ScopeId='2;#{AD9949BE-BE16-4946-B5DE-66C912EDA54A}' ows__EditMenuTableStart='2_.000' ows__EditMenuTableStart2='2' ows__EditMenuTableEnd='2' ows_LinkFilenameNoMenu='2_.000' ows_LinkFilename='2_.000' ows_LinkFilename2='2_.000' ows_ServerUrl='/Lists/TestList/2_.000' ows_EncodedAbsUrl='https://<site url>.sharepoint.com/Lists/TestList/2_.000' ows_BaseName='2_' ows_MetaInfo='2;#' ows__Level='1' ows__IsCurrentVersion='1' ows_ItemChildCount='2;#0' ows_FolderChildCount='2;#0' ows_ServerRedirected='0' />
    </rs:data>
  </listitems>
</GetListItemChangesSinceTokenResult>

GetRelatedFields-Methode

Gibt eine Sammlung von Nachschlagefeldern zurück, die diese Liste als Datenquelle verwenden und bei denen FieldLookup.IsRelationship auf true gesetzt ist.

Endpunkt

/getrelatedfields

Parameter

Keine

HTTP method

GET

Antwort

Typ: SP.RelatedFieldCollection
Eine Sammlung der SP.RelatedField-Objekte, die Informationen zur Beziehung zwischen einem Feld in einer Liste und einem Nachschlagefeld in einer anderen Liste enthalten.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getrelatedfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetUserEffectivePermissions-Methode

Endpunkt

/getusereffectivepermissions(@user)?@user='<user login name>'

Parameter

Typ: String
Der Anmeldename des Benutzers zum Abrufen von Berechtigungen werden als Alias in der Abfragezeichenfolge weitergegeben. Beispiel:
SharePoint Online oder lokal verwendete Formulare: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
  On-premises using Windows claims: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7Cdomain\user'
  On-premises using SAML claims: …/getusereffectivepermissions(@v)?@v='i%3A05%3At%7Cadfs+with+roles%7Cuser%40domain.com'

HTTP method

GET

Antwort

Typ: SP.BasePermissions
Die Berechtigungsgruppe des angegebenen Benutzers: Int64-Werte für hoch- und niederwertige Berechtigungsparts.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getusereffectivepermissions(@user)?@user='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetView-Methode

Gibt die Listenansicht mit dem angegebenen Ansichtsbezeichner zurück.

Endpunkt

/getview('<view id>')

Parameter

Typ: String
Der eindeutige Bezeichner für die Listenansicht.

HTTP method

GET

Antwort

Typ: SP.View
Die angegebene Listenansicht.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /getview('4814949d-3e17-444c-a1a3-cb69bc77e95f')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch nur die Ansichts-ID in der ViewCollection-Ressource angeben. Beispiel: …/_api/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('4814949d-3e17-444c-a1a3-cb69bc77e95f')

Recycle-Methode

Verschiebt die Liste 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 Liste.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

RenderListData-Methode

Endpunkt

/renderlistdata('<view xml>')

Parameter

Typ: String
Eine CAML-Abfrage, die die Elemente und Felder definiert, die Sie zurückgeben möchten.

HTTP method

POST

Antwort

Typ: String
Die angeforderten Listendaten in der durch die angegebene XML definierten Ansicht.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistdata(@viewXml)?@viewXml='<View><RowLimit>10</RowLimit></View>'
    &@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

RenderListFormData-Methode

Endpunkt

/renderlistformdata(itemid, formid, mode)

Parameter

itemid

Typ: Int32
Der Bezeichner des Listenelements, das gerendert werden soll.

formid

Typ: String
Der Bezeichner des Formulars.

mode

Typ: Int32
Der SP.ControlMode des zum Anzeigen des Elements verwendeten Steuerelements: 1 = Display; 2 = Edit; 3 = New.

HTTP method

POST

Antwort

Typ: String
Die Feldwerte und Feldschemaattribute für ein Listenelement.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /renderlistformdata(itemid=4, formid='e8b2f6e3-1081-4b18-833b-475f76473cde', mode=2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

ReserveListItemId-Methode

Reserviert ein Listenelement-ID für die Erstellung von idempotenten Listenelementen.

Endpunkt

/reservelistitemid

Parameter

Keine

HTTP method

POST

Antwort

Typ: Int32
Der Listenelementbezeichner, das reserviert werden soll.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    /reservelistitemid
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')",
        "etag":"\"0\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Fields"}},
      "Forms":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'8ade7551-f53c-48c5-9d2b-e89f6528cf47')/InformationRightsManagementSettings"}},
      "AllowContentTypes":true, 
      "BaseTemplate":100, 
      "BaseType":0, 
      "ContentTypesEnabled":false, 
      "Created":"2013-02-02T21:11:56Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"",
      "Direction":"none",
      "DocumentTemplateUrl":null, 
      "DraftVersionVisibility":0, 
      "EnableAttachments":true, 
      "EnableFolderCreation":false, 
      "EnableMinorVersions":false, 
      "EnableModeration":false, 
      "EnableVersioning":false,
      "EntityTypeName":"ANewList",
      "ForceCheckout":false, 
      "HasExternalDataSource":false, 
      "Hidden":false, 
      "Id":"8ade7551-f53c-48c5-9d2b-e89f6528cf47",
      "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
      "IrmEnabled":false, 
      "IrmExpire":false, 
      "IrmReject":false, 
      "IsApplicationList":false, 
      "IsCatalog":false, 
      "IsPrivate":false, 
      "ItemCount":1, 
      "LastItemDeletedDate":"2013-02-02T21:11:56Z",
      "LastItemModifiedDate":"2013-02-03T22:17:55Z",
      "ListItemEntityTypeFullName":"SP.Data.ANewListItem",
      "MultipleDataList":false, 
      "NoCrawl":false, 
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true, 
      "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
      "Title":"ANewList"
    }}

ListCollection-Ressource

Stellt eine Sammlung von Listen dar.

Endpunkt-URI  |  Methoden  |  OData-Darstellung

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen von Listen der Stammwebsite

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

GET-Anforderungsbeispiel: Abrufen einer Liste nach Titel

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

GET-Anforderungsbeispiel: Abrufen einer Liste nach ID

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen einer Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.List' }, 'AllowContentTypes': true, 'BaseTemplate': 100,
    'ContentTypesEnabled': true, 'Description': 'My list description', 'Title': 'Test title' }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

ListCollection-Methoden

EnsureSiteAssetsLibrary
EnsureSitePagesLibrary
GetById
GetByTitle

EnsureSiteAssetsLibrary-Methode

Ruft eine Liste ab, die als standardmäßiger Objektspeicherort für Bilder oder andere Dateien fungiert, die die Benutzer an ihre Wiki-Seiten hochladen.

Endpunkt

/ensuresiteassetslibrary

Parameter

Keine

HTTP method

POST

Antwort

Typ: SP.List
Die Liste ist der Standardspeicherort für Wiki-Seitenobjekte.

Anforderungsbeispiel

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

EnsureSitePagesLibrary-Methode

Ruft eine Liste ab, bei der es sich um den Standardort für Wiki-Seiten handelt.

Endpunkt

/ensuresitepageslibrary

Parameter

Keine

HTTP method

POST

Antwort

Typ: SP.List
Die Liste ist der Standardspeicherort für Wikiseiten.

Anforderungsbeispiel

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

GetById-Methode

Gibt die Liste mit dem angegebenen Listenbezeichner zurück.

Endpunkt

/getbyid

Parameter

Typ: String
Der Listenbezeichner.

HTTP method

GET

Antwort

Typ: SP.List
Die Liste mit dem angegebenen Bezeichner.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web/lists
    /getbyid('51925dd7-2108-481a-b1ef-4bfa4e69d48b')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch einfach die Listen-ID an die ListCollection-Ressource weitergeben. Beispiel: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b').

GetByTitle-Methode

Gibt die Liste mit dem angegebenen Titel aus der Auflistung zurück.

Endpunkt

/getbytitle

Parameter

Typ: String
Der Listentitel.

HTTP method

GET

Antwort

Typ: SP.List
Die Liste mit dem angegebenen Titel.

Anforderungsbeispiel

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

OData-Darstellung

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

    {"d":{
      "results":[{
        "__metadata":{"id":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')",
        "uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-
    4bfa4e69d48b')",
        "etag":"\"6\"",
        "type":"SP.List"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RoleAssignments"}},
      "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ContentTypes"}},
      "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/DefaultView"}},
      "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/EventReceivers"}},
      "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Fields"}},
      "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Forms"}},
      "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/InformationRightsManagementSettings"}},
      "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Items"}},
      "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/ParentWeb"}},
      "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/RootFolder"}},
      "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/UserCustomActions"}},
      "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/Views"}},
      "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/WorkflowAssociations"}},
      "AllowContentTypes":true,
      "BaseTemplate":160,"BaseType":0,
      "ContentTypesEnabled":true,
      "Created":"2013-06-10T17:14:49Z",
      "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
      "Description":"Use this list to track access requests to a site or uniquely permissioned items in the site.",
      "Direction":"none",
      "DocumentTemplateUrl":null,
      "DraftVersionVisibility":0,
      "EnableAttachments":false,
      "EnableFolderCreation":false,
      "EnableMinorVersions":false,
      "EnableModeration":false,
      "EnableVersioning":true,
      "EntityTypeName":"Access_x0020_Requests",
      "ForceCheckout":false,
      "HasExternalDataSource":false,
      "Hidden":true,
      "Id":"51925dd7-2108-481a-b1ef-4bfa4e69d48b",
      "ImageUrl":"/_layouts/15/images/itgen.gif?rev=26",
      "IrmEnabled":false,
      "IrmExpire":false,
      "IrmReject":false,
      "IsApplicationList":false,
      "IsCatalog":false,
      "IsPrivate":false,
      "ItemCount":3,
      "LastItemDeletedDate":"2013-06-10T17:14:49Z",
      "LastItemModifiedDate":"2013-06-10T17:20:48Z",
      "ListItemEntityTypeFullName":"SP.Data.Access_x0020_RequestsItem",
      "MultipleDataList":false,
      "NoCrawl":true,
      "ParentWebUrl":"/",
      "ServerTemplateCanCreateFolders":true,
      "TemplateFeatureId":"a0f12ee4-9b60-4ba4-81f6-75724f4ca973",
      "Title":"Access Requests"},
      {
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')",
          "uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-
    02248c2e44e8')",
          "etag":"\"1\"",
          "type":"SP.List"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902- 
    02248c2e44e8')/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RoleAssignments"}},
        "ContentTypes":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ContentTypes"}},
        "DefaultView":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/DefaultView"}},
        "EventReceivers":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/EventReceivers"}},
        "Fields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Fields"}},
        "Forms":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Forms"}},
        "InformationRightsManagementSettings":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/InformationRightsManagementSettings"}},
        "Items":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Items"}},
        "ParentWeb":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/ParentWeb"}},
        "RootFolder":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/RootFolder"}},
        "UserCustomActions":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/UserCustomActions"}},
        "Views":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/Views"}},
        "WorkflowAssociations":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'482e418a-0900-414b-8902-02248c2e44e8')/WorkflowAssociations"}},
        "AllowContentTypes":true,
        "BaseTemplate":100,
        "BaseType":0,
        "ContentTypesEnabled":false,
        "Created":"2013-02-02T21:11:56Z",
        "DefaultContentApprovalWorkflowId":"00000000-0000-0000-0000-000000000000",
        "Description":"",
        "Direction":"none",
        "DocumentTemplateUrl":null,
        "DraftVersionVisibility":0,
        "EnableAttachments":true,
        "EnableFolderCreation":false,
        "EnableMinorVersions":false,
        "EnableModeration":false,
        "EnableVersioning":false,
        "EntityTypeName":"AList",
        "ForceCheckout":false,
        "HasExternalDataSource":false,
        "Hidden":false,
        "Id":"482e418a-0900-414b-8902-02248c2e44e8",
        "ImageUrl":"/_layouts/15/images/itgen.png?rev=23",
        "IrmEnabled":false,
        "IrmExpire":false,
        "IrmReject":false,
        "IsApplicationList":false,
        "IsCatalog":false,
        "IsPrivate":false,
        "ItemCount":3,
        "LastItemDeletedDate":"2013-02-02T21:11:56Z",
        "LastItemModifiedDate":"2013-06-26T22:31:03Z",
        "ListItemEntityTypeFullName":"SP.Data.AListListItem",
        "MultipleDataList":false,
        "NoCrawl":false,
        "ParentWebUrl":"/",
        "ServerTemplateCanCreateFolders":true,
        "TemplateFeatureId":"00bfea71-de22-43b2-a848-c05709900100",
        "Title":"AList"
      }]
    }}

ListItem-Ressource

Steht für ein Element oder eine Zeile in einer Liste. Ein Listenelement ist ein SP.SecurableObject-Typ.

Endpunkt URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Hinweis

Die OData-Abfrageoption $skip funktioniert nicht mit diesem Endpunkt.

Endpunkt-URI

http://<Website-URL>/web/lists(guid'<Listen-ID>')/items(<Element-ID>)
http://<Website-URL>/web/lists/getbytitle('<Listentitel>')/items(<Element-ID>)

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]}}",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Hinweis

Zum Erstellen oder Ändern eines Listenelements müssen Sie die ListItemEntityTypeFullName-Eigenschaft der Liste kennen und sie als Wert Typ im HTTP-Anforderungstext weitergeben.

Beispiele

MERGE-Anforderungsbeispiel: Ändern eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Priority': '(1) High', 'Status': 'In Progress', 'PercentComplete': 0.3 }",
  headers: { 
    "IF-MATCH": "*",
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Hinweis

Zum Erstellen oder Ändern eines Listenelements müssen Sie die ListItemEntityTypeFullName-Eigenschaft der Liste kennen und sie als Wert Typ im HTTP-Anforderungstext weitergeben.

DELETE-Anforderungsbeispiel: Löschen eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "POST",
  headers: { 
    "IF-MATCH”: "*",
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Wenn Sie die GUID des Wiederverwendungsvorgangs abrufen möchten, müssen Sie die Recycle-Methode des Elements verwenden.

ListItem-Eigenschaften

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

AttachmentFiles

SP.AttachmentCollection

R

Nein

Gibt die Auflistung von Anlagen an, die dem Listenelement zugeordnet sind.

ContentType

SP.ContentType

R

Nein

Ruft einen Wert ab, der den Inhaltstyp des Listenelements angibt.

DisplayName

String

R

Ja (angezeigt als "Titel"-Wert)

Ruft einen Wert ab, der den Anzeigenamen des Listenelements angibt.

EffectiveBasePermissions

SP.BasePermissions

R

Ja

Ruft einen Wert ab, der die effektiven Berechtigungen für das Listenelement angibt, die dem aktuellen Benutzer zugewiesen sind.

EffectiveBasePermissionsForUI

SP.BasePermissions

R

Ja

Ruft die geltenden Standardberechtigungen für den aktuellen Benutzer gemäß der vorgesehenen Anzeige auf der Benutzeroberfläche ab.

FieldValuesAsHtml

SP.FieldStringValues

R

Nein

Ruft die Werte für das Listenelement im HTML-Format ab.

FieldValuesAsText

SP.FieldStringValues

R

Nein

Ruft die Feldwerte des Listenelements als Sammlung von Zeichenfolgenwerten ab.

FieldValuesForEdit

SP.FieldStringValues

R

Nein

Ruft die formatierten Werte ab, die in einem Bearbeitungsformular angezeigt werden sollen.

Datei

SP.File

R

Nein

Ruft die durch das Element dargestellt Datei aus einer Dokumentbibliothek ab.

FileSystemObjectType

Int32

R

Ja

Ruft einen Wert ab, der angibt, ob es sich bei dem Listenelement um eine Datei oder um einen Listenordner handelt. Stellt einen SP.FileSystemObjectType-Wert dar: Invalid = -1; File = 0; Folder = 1; Web = 2.

FirstUniqueAncestorSecurableObject

SP.SecurableObject

R

Nein

Ruft das Objekt ab, bei dem Rollenzuweisungen für dieses Objekt definiert sind. Wenn Rollenzuweisungen direkt zum aktuellen Objekt definiert werden, wird das aktuelle Objekt zurückgegeben.

Ordner

SP.Folder

R

Nein

Ruft ein Ordnerobjekt ab, das einem Ordnerelement zugeordnet ist.

HasUniqueRoleAssignments

Boolean

R

Nein

Ruft einen Wert ab, der angibt, ob die Rollenzuweisungen für dieses sicherungsfähige Objekt eindeutig definiert oder von einem übergeordneten sicherungsfähigen Objekt geerbt werden.

ID

Int32

R

Ja

Ruft einen Wert ab, der den Listenelementbezeichner angibt.

ParentList

SP.List

R

Nein

Ruft die übergeordnete Liste ab, die das Listenelement enthält.

RoleAssignments

SP.RoleAssignmentCollection

R

Nein

Ruft die Rollenzuweisungen für das sicherungsfähige Objekt ab.

ListItem-Methoden

BreakRoleInheritance
DeleteObject
GetUserEffectivePermissions
Recycle
ResetRoleInheritance
ValidateUpdateListItem

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
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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /breakroleinheritance(copyroleassignments=true, clearsubscopes=false)
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,par
  error: errorHandler
});

DeleteObject-Methode

Beispiele

GetUserEffectivePermissions-Methoden

Ruft die geltenden Berechtigungen ab, über die ein angegebener Benutzer für das Listenelement verfügt.

Endpunkt

/getusereffectivepermissions(@v)?@v='<user login name>'

Parameter

Typ: String
Der Anmeldename des Benutzers zum Abrufen der Berechtigungen. Beispiel:
SharePoint Online: …/getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7C<user>%40<domain>.onmicrosoft.com'
  On-premises using claims: …/getusereffectivepermissions(@v)?@v='i%3A0%23.w%7C<domain\user>'
  On-premises using forms: …/getusereffectivepermissions(@v)?@v='<domain\user>'

HTTP method

GET

Antwort

Typ: SP.BasePermissions
Die Basisberechtigungen für das Listenelement des angegebenen Benutzers: Int64-Werte für hoch- und niederwertige Berechtigungsparts.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /getusereffectivepermissions(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'
    &@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Recycle-Methode

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

Endpunkt

/recycle

Parameter

Keine

HTTP method

POST

Antwort

Typ: GUID
Die GUID des wiederverwendeten Listenelements.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /recycle
    ?@target='<host web url>'",
  method: "POST",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

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

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /resetroleinheritance
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

ValidateUpdateListItem-Methode

Dient zum Validieren und Festlegen der Werte der angegebenen Feldsammlung für das Listenelement.

Endpunkt

/validateupdatelistitem

Parameter

formValues

Typ: SP.ListItemFormUpdateValue[]
Die zu ändernden Felder und ihre neuen Werte. Geben Sie diesen Parameter im Anforderungstext weiter, wie im Anforderungsbeispiel gezeigt.

bNewDocumentUpdate

Typ: Boolean
true, wenn das Listenelement ein Dokument ist, das nach dem Hochladen aktualisiert wird; andernfalls false. Übergeben Sie diesen Parameter im Anforderungstext, wie im Anforderungsbeispiel gezeigt, oder im URI-Pfad.

HTTP method

POST

Antwort

Typ: SP.ListItemFormUpdateValue[]
Ein Objektarray, das die geänderten Felder und Werte darstellt.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    /validateupdatelistitem
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'formValues':[{'FieldName':'Status', 'FieldValue':'Deferred'},
    {'FieldName':'StartDate', 'FieldValue':'12/31/2014'}], 'bNewDocumentUpdate': false }",
  headers: {
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Anforderungsbeispiel

    {"d":{
      "ValidateUpdateListItem":{"results":[
        {
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"Status",
          "FieldValue":"Deferred",
          "HasException":false
        },{
          "__metadata":{"type":"SP.ListItemFormUpdateValue"},
          "ErrorMessage":null,
          "FieldName":"StartDate",
          "FieldValue":"12/31/2014",
          "HasException":false
        }
      ]}
    }}

OData-Darstellung

Das folgende Beispiel stellt eine ListItem-Ressource im JSON-Format dar. Die Ressource gibt auch die Feldwerte zurück.

    {"d":{
      "__metadata":{,
        "id":"2bbdaee6-1172-4e36-9f90-ce35ec9b6207",
        "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
        "etag":"\"1\"",
        "type":"SP.Data.Team_x0020_tasksListItem"
      },
      "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
      "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
      "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
      "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
      "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
      "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
      "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
      "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
      "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
      "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
      "FileSystemObjectType":0,
      "Id":2,
      "ID":2,
      "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
      "Title":"Assign teams",
      "Modified":"2013-09-03T17:50:30Z",
      "Created":"2013-09-03T17:50:30Z",
      "AuthorId":1073741823,
      "EditorId":1073741823,
      "OData__UIVersionString":"1.0",
      "Attachments":false,
      "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
      "PredecessorsId":{"results":[1]},
      "Priority":"(2) Normal",
      "Status":"Not Started",
      "PercentComplete":0,
      "AssignedToId":{"results":[1]},
      "Body":null,
      "StartDate":"2014-01-02T08:00:00Z",
      "DueDate":"2014-01-02T08:00:00Z",
      "Checkmark":"0",
      "RelatedItems":null
    }}

ListItemCollection-Ressource

Stellt eine Sammlung der ListItem-Ressourcen dar.

Endpunkt-URI  |  -Methoden  |  OData-Darstellung

Endpunkt-URI

http://<Website-URL>/web/lists(guid'<Listen-ID>')/items
http://<Website-URL>/web/lists/getbytitle('<Listentitel>')/items

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen aller Listenelemente

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können die OData-Abfragevorgänge verwenden, um nach bestimmten Elementen zu filtern (z. B.: …/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/items?$filter=Status eq 'not started'&$select=Title&$top=5).

POST-Anforderungsbeispiel: Erstellen eines Listenelements

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.Data.Team_x0020_tasksListItem' },
    'Title': 'Teams incorporate feedback', 'AssignedToId': {"results":[1]},
    'StartDate':'2014-01-29T08:00:00Z', 'DueDate':'2014-01-31T08:00:00Z',
    'PredecessorsId': {"results":[4]} }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Hinweis

Zum Erstellen oder Ändern eines Listenelements müssen Sie die ListItemEntityTypeFullName-Eigenschaft der Liste kennen und sie als Wert Typ im HTTP-Anforderungstext weitergeben.

Beispiele

ListItemCollection-Methoden

GetById

GetById-Methode

Gibt das Listenelement mit dem angegebenen Listenelementbezeichner zurück.

Endpunkt

/getbyid(<Element-ID>)

Parameter

Typ: Int32
Die ID des Listenelements.

HTTP method

GET

Antwort

Typ: SP.ListItem
Das Listenelement mit der angegebenen ID.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items
    /getbyid(2)
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch einfach die Listenelemente-ID in der ListItemCollection-Ressource angeben. Beispiel: …/_api/web/lists(guid'a290086b-2d43-4151-add4-893474a930a9')/items(2)

OData-Darstellung

Das folgende Beispiel stellt eine ListItemCollection-Ressource im JSON-Format dar, die eine Sammlung von ListItem-Ressourcen zurückgibt.

    {"d":{
      "results":[{
        "__metadata":{
          "id":"dd9ab60c-4653-4654-85de-1d090f0d416f",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)",
          "etag":"\"1\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(1)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":1,
        "ID":1,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Triage requests",
        "Modified":"2013-09-03T17:49:26Z",
        "Created":"2013-09-03T17:49:26Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"e132ef1b-698e-4d21-ba1b-29fa5c38fe8e",
        "PredecessorsId":{"results":[]},
        "Priority":"(2) Normal",
        "Status":"Not Started",
        "PercentComplete":0,
        "AssignedToId":{"results":[1,21]},
        "Body":null,
        "StartDate":"2014-01-01T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        "__metadata":{
          "id":"687e63a4-ed44-4bf2-881f-c83e5d3fd020",
          "uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)",
          "etag":"\"5\"",
          "type":"SP.Data.Team_x0020_tasksListItem"
        },
        "FirstUniqueAncestorSecurableObject":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FirstUniqueAncestorSecurableObject"}},
        "RoleAssignments":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/RoleAssignments"}},
        "AttachmentFiles":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/AttachmentFiles"}},
        "ContentType":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ContentType"}},
        "FieldValuesAsHtml":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsHtml"}},
        "FieldValuesAsText":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesAsText"}},
        "FieldValuesForEdit":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/FieldValuesForEdit"}},
        "File":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/File"}},
        "Folder":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/Folder"}},
        "ParentList":{"__deferred":{"uri":"http://<site url>/_api/Web/Lists(guid'a290086b-2d43-4151-add4-893474a930a9')/Items(2)/ParentList"}},
        "FileSystemObjectType":0,
        "Id":2,
        "ID":2,
        "ContentTypeId":"0x0108004F8963A897E4E64A83E990C1B6B65770",
        "Title":"Assign teams",
        "Modified":"2013-09-03T19:24:51Z",
        "Created":"2013-09-03T17:50:30Z",
        "AuthorId":1073741823,
        "EditorId":1073741823,
        "OData__UIVersionString":"1.0",
        "Attachments":false,
        "GUID":"ce6e516e-2da4-4a3e-9325-daf7d7f61490",
        "PredecessorsId":{"results":[1]},
        "Priority":"(1) High",
        "Status":"In Progress",
        "PercentComplete":0.3,
        "AssignedToId":{"results":[1]},
        "Body":null,
        "StartDate":"2014-01-02T08:00:00Z",
        "DueDate":"2014-01-02T08:00:00Z",
        "Checkmark":"0",
        "RelatedItems":null
        },{
        …
      }]
    }}

View-Ressource

Gibt eine Listenansicht an.

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/lists(guid'<Listen-ID>')/views('<Ansichts-ID>')

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen einer Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByTitle-Methode aus der ViewCollection-Ressource verwenden, um eine Ansicht nach dem Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

MERGE-Anforderungsbeispiel: Ändern einer Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'New Mobile Default View',
    'MobileDefaultView': true, 'RowLimit': 5 }",
  headers: { 
    "content-type": "application/json;odata=verbose",
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

DELETE-Anforderungsbeispiel: Löschen einer Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "POST",
  headers: { "X-HTTP-Method": "DELETE" },
  success: successHandler,
  error: errorHandler
});

Beispiele

Eigenschaften anzeigen

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
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/<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

Aggregations

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der Felder und Funktionen angibt, die in einer Listenansicht angezeigte Summen definieren. Wenn nicht Null, muss die XML FieldRefDefinitionAggregation entsprechen, wie in [MS-WSSCAML] angegeben.

AggregationsStatus

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob in der Listenansicht Summen angezeigt werden.

BaseViewId

String

R

Ja

Ruft einen Wert ab, der den Basisansichtsbezeichner der Listenansicht angibt.

ContentTypeId

SP.ContentTypeId

RW

Ja

Dient zum Abrufen oder Festlegen des Bezeichners des Inhaltstyps, dem die Ansicht zugeordnet ist, sodass die Ansicht nur für Ordner dieses Inhaltstyps verfügbar ist.

DefaultView

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der Listenansicht um die standardmäßige Listenansicht handelt.

DefaultViewForContentType

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der Listenansicht um die standardmäßige Listenansicht für den mittels contentTypeId angegebenen Inhaltstyp handelt.

EditorModified

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Listenansicht in einem Editor geändert wurde.

Formate

String

RW

Ja

Dient zum Abrufen oder Festlegen der Spalten- und Zeilenformatierung für die Listenansicht. Wenn nicht Null, muss die XML ViewFormatDefinitions entsprechen, wie in [MS-WSSCAML] angegeben.

Ausgeblendet

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Listenansicht ausgeblendet ist.

HtmlSchemaXml

String

R

Ja

Ruft einen Wert ab, der das XML-Dokument für die Listenansicht angibt.

ID

GUID

R

Ja

Ruft einen Wert ab, der den Ansichtsbezeichner der Listenansicht angibt.

ImageUrl

String

R

Ja

Ruft einen Wert ab, der die URI (Uniform Resource Identifier) des Bilds für die Listenansicht angibt.

IncludeRootFolder

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der aktuelle Ordner in der Listenansicht angezeigt wird.

JsLink

String

RW

Ja

Dient zum Abrufen oder Festlegen des Namens der JavaScript-Datei, die für die Ansicht verwendet wird.

ListViewXml

String

RW

Ja

Dient zum Abrufen oder Festlegen einer Zeichenfolge, die die angezeigte XML darstellt.

Methode

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Ansichtsmethode für die Listenansicht angibt. Wenn nicht Null, muss die XML Methode entsprechen, wie in [MS-WSSCAP] angegeben.

MobileDefaultView

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der Listenansicht um die standardmäßige mobile Listenansicht handelt.

MobileView

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der Listenansicht um eine mobile Listenansicht handelt.

ModerationType

String

R

Ja

Ruft einen Wert ab, der den Inhaltsgenehmigungstyp für die Listenansicht angibt.

OrderedView

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob die Reihenfolge von Listenelementen in der Listenansicht angepasst werden kann.

Paged

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der Listenansicht um eine umgebrochene Ansicht handelt.

PersonalView

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob es sich bei der Listenansicht um eine persönliche Ansicht handelt.

ReadOnlyView

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob die Listenansicht schreibgeschützt ist.

RequiresClientIntegration

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob für die Listenansicht Clientintegrationsrechte benötigt werden.

RowLimit

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die maximale Anzahl von Listenelementen angibt, die auf einer visuellen Seite der Listenansicht angezeigt werden.

Bereich

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Bereich für die Listenansicht angibt. Stellt einen ViewScope-Wert dar. DefaultValue = 0, Recursive = 1, RecursiveAll = 2, FilesOnly = 3.

ServerRelativeUrl

String

R

Ja

Ruft einen Wert ab, der die serverrelative URL der Listenansichtsseite angibt.

StyleId

String

R

Ja

Ruft einen Wert ab, der den Bezeichner des Ansichtsformats für die Listenansicht angibt.

Threaded

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob es sich bei der Listenansicht um eine Ansicht mit Thread handelt.

Titel

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Anzeigenamen der Listenansicht angibt.

Toolbar

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Symbolleiste für die Listenansicht angibt.

ToolbarTemplateName

String

R

Ja

Ruft einen Wert ab, der den Namen der Vorlage für die Symbolleiste angibt, die in der Listenansicht verwendet wird.

ViewData

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Ansichtsdaten für die Listenansicht angibt. Wenn nicht Null, muss die XML FieldRefDefinitionViewData entsprechen, wie in [MS-WSSCAML] angegeben.

ViewFields

SP.ViewFieldCollection

R

Nein

Ruft einen Wert ab, der die Auflistung von Feldern in der Listenansicht angibt.

ViewJoins

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die in der Listenansicht verwendeten Joins-Elemente angibt. Wenn nicht Null, muss die XML ListJoinsDefinition entsprechen, wie in [MS-WSSCAML] angegeben.

ViewProjectedFields

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die geplanten Felder angibt, die von der Listenansicht verwendet werden. Wenn nicht Null, muss die XML ProjectedFieldsDefinitionType entsprechen, wie in [MS-WSSCAML] angegeben.

ViewQuery

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die von der Listenansicht verwendete Abfrage angibt.Wenn nicht Null, muss die XML CamlQueryRoot entsprechen, wie in [MS-WSSCAML] angegeben.

ViewType

String

R

Ja

Ruft einen Wert ab, der die Art der Listenansicht angibt. Dabei kann es sich um HTML, GRID, CALENDAR, RECURRENCE, CHART oder GANTT handeln.

Anzeigemethoden

DeleteObject
RenderAsHtml

DeleteObject method

Beispiele

RenderAsHtml-Methode

Gibt die Listenansicht im HTML-Format zurück.

Endpunkt

/renderashtml

Parameter

Keine

HTTP method

GET

Antwort

Typ: String
Die im HTML-Format gerenderte Listenansicht.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    /renderashtml
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
        "type":"SP.View"
      },
      "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
      "Aggregations":null,
      "AggregationsStatus":null,
      "BaseViewId":"2",
      "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"}, "StringValue":"0x"},
      "DefaultView":false,
      "DefaultViewForContentType":false,
      "EditorModified":false,
      "Formats":null,
      "Hidden":false,
      "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
      "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
      "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
      "IncludeRootFolder":false,
      "ViewJoins":null,
      "JSLink":"hierarchytaskslist.js",
      "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
      "Method":null,
      "MobileDefaultView":false,
      "MobileView":true,
      "ModerationType":null,
      "OrderedView":false,
      "Paged":true,
      "PersonalView":false,
      "ViewProjectedFields":null,
      "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
      "ReadOnlyView":false,
      "RequiresClientIntegration":false,
      "RowLimit":100,
      "Scope":0,
      "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
      "StyleId":null,
      "Threaded":false,
      "Title":"Late Tasks",
      "Toolbar":"",
      "ToolbarTemplateName":null,
      "ViewType":"HTML",
      "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
    }}

ViewCollection-Ressource

Stellt eine Sammlung von View-Ressourcen dar.

Endpunkt URI  |  Methoden  |  OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/lists(guid'<Listen-ID>')/views

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen aller Ansichten für eine Liste

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen einer bestimmten Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByTitle-Methode aus der ViewCollection-Ressource verwenden, um eine Ansicht nach dem Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views/getbytitle('By Status').

POST-Anforderungsbeispiel: Erstellen einer Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    ?@target='<host web url>'",
  method: "POST",
  body: "{ '__metadata': { 'type': 'SP.View' }, 'Title': 'By Status',
    'PersonalView': false }",
  headers: { 
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

Wenn Sie eine Ansicht erstellen, gibt der Server die Ansicht zurück. Um in der neuen Ansicht Ansichtsfelder hinzuzufügen, zu entfernen oder die Reihenfolge der Ansichtsfelder zu ändern, verwenden Sie die ViewFieldCollection-Methoden.

ViewCollection-Methoden

GetById
GetByTitle

GetById-Methode

Ruft die Listenansicht mit der angegebenen ID ab.

Endpunkt

/getbyid('<Ansichts-ID>')

Parameter

Typ: String
Die ID der Ansicht.

HTTP method

GET

Antwort

Typ: SP.View
Die angegebene Ansicht.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbyid('0dc42244-4bae-4da9-b074-8b8e9d8e50bc')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch einfach die Ansichts-ID an die ViewCollection-Ressource weitergeben. Beispiel: …/web/lists(guid'51925dd7-2108-481a-b1ef-4bfa4e69d48b')/views('0dc42244-4bae-4da9-b074-8b8e9d8e50bc').

GetByTitle-Methode

Ruft die Listenansicht mit dem angegebenen Titel ab.

Endpunkt

/getbytitle('<Ansichtstitel>')

Parameter

Typ: String
Der Titel der Ansicht, bei dem zwischen Groß- und Kleinschreibung unterschieden wird.

HTTP method

GET

Antwort

Typ: SP.View
Die angegebene Ansicht.

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views
    /getbytitle('By Status')
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"1",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":true,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData></View>"
        "Id":"9824c4ff-14fd-4f24-b481-fa33d90f2d85",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{9824C4FF-14FD-4F24-B481-FA33D90F2D85}\" DefaultView=\"TRUE\" MobileView=\"TRUE\" MobileDefaultView=\"TRUE\" Type=\"HTML\" DisplayName=\"All Tasks\" Url=\"/Lists/Backlog items/AllItems.aspx\" Level=\"1\" BaseViewID=\"1\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /><FieldRef Name=\"Status0\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":true,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":null
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/AllItems.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"All Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"}}"
      },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')",
          "type":"SP.View"
        },
        "ViewFields":{"__deferred":{"uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Views(guid'0dc42244-4bae-4da9-b074-8b8e9d8e50bc')/ViewFields"}},
        "Aggregations":null,
        "AggregationsStatus":null,
        "BaseViewId":"2",
        "ContentTypeId":{"__metadata":{"type":"SP.ContentTypeId"},"StringValue":"0x"},
        "DefaultView":false,
        "DefaultViewForContentType":false,
        "EditorModified":false,
        "Formats":null,
        "Hidden":false,
        "HtmlSchemaXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\"><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><RowLimit Paged=\"TRUE\">100</RowLimit><Toolbar Type=\"Standard\" /><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><ViewData><FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" /></ViewData><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query></View>",
        "Id":"0dc42244-4bae-4da9-b074-8b8e9d8e50bc",
        "ImageUrl":"/_layouts/15/images/issuelst.png?rev=31",
        "IncludeRootFolder":false,
        "ViewJoins":null,
        "JSLink":"hierarchytaskslist.js",
        "ListViewXml":"<View Name=\"{0DC42244-4BAE-4DA9-B074-8B8E9D8E50BC}\" MobileView=\"TRUE\" Type=\"HTML\" DisplayName=\"Late Tasks\" Url=\"/Lists/Backlog items/late.aspx\" Level=\"1\" BaseViewID=\"2\" ContentTypeID=\"0x\" ImageUrl=\"/_layouts/15/images/issuelst.png?rev=31\" ><Query><Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy></Query><ViewFields><FieldRef Name=\"Checkmark\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" /><FieldRef Name=\"AssignedTo\" /></ViewFields><RowLimit Paged=\"TRUE\">100</RowLimit><JSLink>hierarchytaskslist.js</JSLink><XslLink Default=\"TRUE\">main.xsl</XslLink><Toolbar Type=\"Standard\"/></View>",
        "Method":null,
        "MobileDefaultView":false,
        "MobileView":true,
        "ModerationType":null,
        "OrderedView":false,
        "Paged":true,
        "PersonalView":false,
        "ViewProjectedFields":null,
        "ViewQuery":"<Where><And><Or><IsNull><FieldRef Name=\"PercentComplete\" /></IsNull><Neq><FieldRef Name=\"PercentComplete\" /><Value Type=\"Number\">1</Value></Neq></Or><Lt><FieldRef Name=\"DueDate\" /><Value Type=\"DateTime\"><Today /></Value></Lt></And></Where><OrderBy><FieldRef Name=\"DueDate\" /><FieldRef Name=\"Priority\" /></OrderBy>",
        "ReadOnlyView":false,
        "RequiresClientIntegration":false,
        "RowLimit":100,
        "Scope":0,
        "ServerRelativeUrl":"/Lists/Backlog items/late.aspx",
        "StyleId":null,
        "Threaded":false,
        "Title":"Late Tasks",
        "Toolbar":"",
        "ToolbarTemplateName":null,
        "ViewType":"HTML",
        "ViewData":"<FieldRef Name=\"PercentComplete\" Type=\"StrikeThroughPercentComplete\" /><FieldRef Name=\"DueDate\" Type=\"TimelineDueDate\" />"
      },{
        …
      }]
    }}

ViewFieldCollection-Ressource

Steht für eine Auflistung von Feldern in einer Listenansicht.

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Endpunkt-URI

http://<Website-URL>/_api/web/lists(guid'<Listen-ID>')/views('<Ansichts-ID>')/viewfields

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen aller Felder in einer Ansicht

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    ?@target='<host web url>'",
  method: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

ViewFieldCollection-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
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields/schemaxml
    ?@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

SchemaXml

String

R

Ja

Ruft einen Wert ab, der das XML-Schema angibt, das für die Auflistung steht.

Elemente

Collection(String)

R

Ja

Gibt das XML-Schema der Feldauflistung an. Die Items-Eigenschaft wird mit der Ressource zurückgegeben, sie weist jedoch keinen URI-adressierbaren Endpunkt auf.

ViewFieldCollection-Methoden

AddViewField
MoveViewFieldTo
RemoveAllViewFields
RemoveViewField

AddViewField-Methode

Fügt das Feld mit dem angegebenen internen Feldnamen oder Anzeigenamen der Auflistung hinzu.

Endpunkt

/addviewfield('<Feldname>')

Parameter

Typ: String
Der interne Name oder Anzeigename des hinzuzufügenden Felds, bei dem zwischen Groß- und Kleinschreibung unterschieden wird.

HTTP method

POST

Antwort

Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /addviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

MoveViewFieldTo-Methode

Verschiebt das Feld mit dem angegebenen internen Feldnamen an die angegebene Position in der Auflistung.

Endpunkt

/moveviewfieldto

Parameter

field

Typ: String
Der interne Name des zu verschiebenden Felds, bei dem zwischen Groß- und Kleinschreibung unterschieden wird. Senden Sie wie im Beispiel gezeigt diesen Parameter und den index-Parameter im Anforderungstext.

index

Typ: Int32
Der nullbasierte Index der neuen Feldposition. Senden Sie wie im Beispiel gezeigt diesen Parameter und den field-Parameter im Anforderungstext.

HTTP method

POST

Antwort

Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /moveviewfieldto
    ?@target='<host web url>'",
  method: "POST",
  body: "{ 'field': 'DueDate', 'index': 0 }",
  headers: { "content-type": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

RemoveAllViewFields-Methode

Entfernt alle Felder aus der Auflistung.

Endpunkt

/removeallviewfields

Parameter

Keine

HTTP method

POST

Antwort

Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeallviewfields
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

RemoveViewField-Methode

Entfernt das Feld mit den angegebenen internen Feldnamen aus der Auflistung.

Endpunkt

/removeviewfield('<Feldname>')

Parameter

Typ: String
Der interne Name des aus der Ansicht zu entfernenden Felds, bei dem zwischen Groß- und Kleinschreibung unterschieden wird.

HTTP method

POST

Antwort

Keine

Anforderungsbeispiel

executor.executeAsync({
  url: "<app web url>/_api/SP.AppContextSite(@target)/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields
    /removeviewfield('AssignedTo')
    ?@target='<host web url>'",
  method: "POST",
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "uri":"https://<site url>/_api/SP.AppContextSite(@target)/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/views('d82d3e67-f317-413c-8f27-590317a40f20')/viewfields",
        "type":"SP.ViewFieldCollection"
      },
      "SchemaXml":"<FieldRef Name=\"Checkmark\" /><FieldRef Name=\"Status\" /><FieldRef Name=\"LinkTitle\" /><FieldRef Name=\"DueDate\" />",
      "Items":{"results":["Checkmark", "Status", "LinkTitle", "DueDate"]}
    }}

Zusätzliche Ressourcen