Komplexen Typen in dem SP-Namespace

Suchen von komplexen Typen in dem SP-Namespace, die von der SharePoint-REST-Schnittstelle verwendet werden.

Letzte Änderung: Montag, 9. März 2015

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

In der REST-Schnittstelle werden komplexe Typen im Text von POST-, MERGE- und PUT-Anforderungen und als Methodenparameter gesendet und als Objekt und Eigenschaftsdatentypen zurückgegeben.

Komplexer AppLicense-Typ

Stellt eine App-Lizenz für den angegebenen Benutzer für die angegebene SharePoint-Add-In dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

RawXMLLicenseToken

String

Ruft ein XML-Fragment ab, das den App-Lizenztoken darstellt, der die Lizenzeigenschafteninformationen enthält.

wahr

Komplexer AppLicenseCollection-Typ

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Items

Collection(SP.AppLicense)

Eine Sammlung von App-Lizenzen.

wahr

Komplexer AppPrincipalConfiguration-Typ

Die einem App-Prinzipal zugeordnete Konfiguration.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ApplicationEndpointAuthorities

Collection(String)

Die Liste der Endpunkt-Autoritäten, die der Prinzipal verfügbar macht.

wahr

ApplicationPrincipalNames

Collection(String)

Die Liste der Namen für den Prinzipal.

wahr

NameIdentifier

String

Der Namensbezeichner des Prinzipals.

wahr

RedirectAddresses

Collection(String)

Die Liste der Umleitungsadressen für den Prinzipal.

wahr

Komplexer AppPrincipalCredentialReference-Typ

Stellt einen Verweis auf die Anmeldedaten für einen App-Prinzipal dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ID

Guid

Der eindeutige Beizeichner des Prinzipals.

falsch

NameIdentifier

String

Der Namensbezeichner des Prinzipals.

wahr

NotAfter

DateTime

Der Zeitpunkt, zu dem dieser Schlüssel abläuft.

falsch

NotBefore

DateTime

Der Zeitpunkt, zu dem dieser Schlüssel gültig wird.

falsch

Komplexer BasePermissions-Typ

Stellt die Basisberechtigungen für eine Rollendefinition dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

High

Int64

Die bitweise obere Grenze (höher als 32 Bit) der Berechtigung.

falsch

Low

Int64

Die bitweise untere Grenze (weniger als 32 Bit) der Berechtigung.

falsch

Komplexer CamlQuery-Typ

Gibt eine CAML (Collaborative Application Markup Language)-Abfrage für eine Liste oder für verknüpfte Listen an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

DatesInUtc

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Datumsangaben im UTC-Format zurückgibt.

falsch

FolderServerRelativeUrl

String

Dient zum Abrufen oder Festlegen eines Werts, der die serverrelative URL eines Listenordners angibt, aus dem Ergebnisse zurückgegeben werden.

wahr

ListItemCollectionPosition

SP.ListItemCollectionPosition

Dient zum Abrufen oder Festlegen eines Werts, der die erforderlichen Informationen zum Abrufen der nächsten Seite mit Daten für die Listenansicht angibt.

wahr

ViewXml

String

Dient zum Abrufen oder Festlegen des Werts, der das XML-Schema angibt, das die Listenansicht definiert.

wahr

Komplexer ChangeLogItemQuery-Typ

Stellt den Eingabeparameter der GetListItemChangesSinceToken-Methode dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ChangeToken

String

Das Änderungstoken für die Anforderung.

wahr

Contains

String

Das XML-Element, das eine benutzerdefinierte Filterung der Abfrage definiert.

wahr

Query

String

Die Datensätze der zurückzugebenden Liste und deren Rückgabereihenfolge.

wahr

QueryOptions

String

Die Optionen zum Ändern der Abfrage.

wahr

RowLimit

String

Die maximale Anzahl an Elementen in der Abfrage, die pro Seite zurückgegeben werden.

wahr

ViewFields

String

Die Namen der Felder, die im Abfrageergebnis enthalten sein sollen.

wahr

ViewName

String

Die GUID der Ansicht.

wahr

Komplexer ChangeQuery-Typ

Definiert eine Abfrage, die für das Änderungsprotokoll ausgeführt wird.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Add

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Hinzufügungsänderungen enthält.

falsch

Alert

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Warnungen enthält.

falsch

ChangeTokenEnd

SP.ChangeToken

Dient zum Abrufen oder Festlegen eines Werts, der das Enddatum und die Enduhrzeit für Änderungen angibt, die durch die Abfrage zurückgegeben werden.

falsch

ChangeTokenStart

SP.ChangeToken

Dient zum Abrufen oder Festlegen eines Werts, der das Startdatum und die Startuhrzeit für Änderungen angibt, die durch die Abfrage zurückgegeben werden.

falsch

ContentType

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Inhaltstypen enthält.

falsch

DeleteObject

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Inhaltstypen enthält.

falsch

Field

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Inhaltstypen enthält.

falsch

File

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Inhaltstypen enthält.

falsch

Folder

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Ordneränderungen enthält.

falsch

Group

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Gruppen enthält.

falsch

GroupMembershipAdd

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Benutzern zu Gruppen enthält.

falsch

GroupMembershipDelete

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Löschen von Benutzern aus den Gruppen enthält.

falsch

Item

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage allgemeine Änderungen an Listenelementen enthält.

falsch

List

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Listen enthält.

falsch

Move

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Verschiebungsänderungen enthält.

falsch

Navigation

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an der Navigationsstruktur einer Websitesammlung enthält.

falsch

Rename

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Namensänderungen enthält.

falsch

Restore

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage die Wiederherstellung von Elementen aus dem Papierkorb oder aus Sicherungen enthält.

falsch

RoleAssignmentAdd

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Rollenzuweisungen enthält.

falsch

RoleAssignmentDelete

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Rollenzuweisungen enthält.

falsch

RoleDefinitionAdd

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Rollenzuweisungen enthält.

falsch

RoleDefinitionDelete

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Rollenzuweisungen enthält.

falsch

RoleDefinitionUpdate

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage das Hinzufügen von Rollenzuweisungen enthält.

falsch

SecurityPolicy

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Sicherheitsrichtlinien enthält.

falsch

Website

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Websitesammlungen enthält.

falsch

SystemUpdate

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Aktualisierungen enthält, die mithilfe der SystemUpdate-Elementmethode vorgenommen wurden.

falsch

Update

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Aktualisierungsänderungen enthält.

falsch

User

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Benutzern enthält.

falsch

View

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Ansichten enthält.

falsch

Web

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Abfrage Änderungen an Websites enthält.

falsch

Komplexer ChangeToken-Typ

Steht für den eindeutigen sequenziellen Ort einer Änderung innerhalb des Änderungsprotokolls.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

StringValue

String

Dient zum Abrufen oder Festlegen eines Zeichenfolgenwerts, der die serialisierte Darstellung des vom Protokollserver generierten Änderungstokens enthält.

wahr

Komplexer ContentTypeCreationInformation-Typ

Gibt Eigenschaften an, die als Parameter zum Initialisieren eines neuen Inhaltstyps verwendet werden.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Beschreibung

String

Dient zum Abrufen oder Festlegen eines Werts, der die Beschreibung des zu konstruierenden Inhaltstyps angibt.

wahr

Group

String

Dient zum Abrufen oder Festlegen eines Werts, der die Inhaltstypgruppe des zu konstruierenden Inhaltstyps angibt.

wahr

ID

String

wahr

Property name

String

Dient zum Abrufen oder Festlegen eines Werts, der den Namen des zu konstruierenden Inhaltstyps angibt.

wahr

Komplexer ContentTypeId-Typ

Steht für den Inhaltstypbezeichner (ID) eines Inhaltstyps.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

StringValue

String

Eine Zeichenfolge mit Hexadezimalzeichen, die für die Inhaltstyp-ID steht.

wahr

Komplexer ContextWebInformation-Typ

Die Kontextinformationen für eine Website.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

FormDigestTimeoutSeconds

Int32

Das Zeitlimit in Sekunden für den Formulardigestwert.

falsch

FormDigestValue

String

Der Formulardigestwert.

wahr

LibraryVersion

String

Die Bibliothekversion.

wahr

SiteFullUrl

String

Die vollständige URL des Kontexts der Websitesammlung.

wahr

SupportedSchemaVersions

Collection(String)

Die clientseitig unterstützte Objektmodell-Anforderungsschemaversion.

wahr

WebFullUrl

String

Die vollständige URL des Websitekontexts.

wahr

Komplexer DocumentLibraryInformation-Typ

Stellt Informationen zu einer Dokumentbibliothek dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Modified

DateTime

Das Datum der letzten Änderung.

falsch

ModifiedFriendlyDisplay

String

Der angezeigte Name des Datums der letzten Änderung.

wahr

ServerRelativeUrl

String

Die serverrelative URL der Dokumentbibliothek.

wahr

Title

String

Der Titel der Dokumentbibliothek.

wahr

Komplexer EventReceiverDefinitionCreationInformation-Typ

Gibt Informationen zur Erstellung von Ereignisempfängern an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

EventType

Int32

Der Ereignistyp. Unter EventReceiverType in der .NET-Clientobjekt-Modellreferenz finden Sie eine Liste mit Werten.

falsch

ReceiverAssembly

String

Gibt den starken Namen der Assembly an, der für Empfangsereignisse verwendet wird.

wahr

ReceiverClass

String

Gibt eine Zeichenfolge an, die die Klasse darstellt, die für Empfangsereignisse verwendet wird.

wahr

ReceiverName

String

Gibt den Namen des Ereignisempfängers an.

wahr

ReceiverUrl

String

Gibt die URL eines Webdiensts an, der für Empfangsereignisse verwendet wird.

wahr

SequenceNumber

Int32

Gibt eine ganze Zahl an, die die relative Sequenz des Ereignisses darstellt.

falsch

Synchronization

Int32

Gibt die Ausführungssynchronisierung des Ereignisempfängers an.

falsch

Komplexer ExternalAppPrincipalCreationParameters-Typ

Stellt das Objekt dar, das alle zum Erstellen eines neuen externen App-Prinzipals verwendete Parameter einschließt.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

AppIdentifier

String

Der eindeutige Beizeichner des App-Prinzipals.

wahr

ApplicationEndpointAuthorities

Collection(String)

Die Liste der Hostnamen[:Port], die App-Endpunkte verfügbar machen.

wahr

DisplayName

String

Der Anzeigename des App-Prinzipals.

wahr

RedirectAddresses

Collection(String)

Die Umleitungsadressen.

wahr

TrustedForDelegation

Boolean

Gibt an, ob einem App-Prinzipal zur Delegation getraut werden kann.

falsch

Komplexer FieldCalculatedErrorValue-Typ

Steht für den Wert des berechneten Felds eines Listenelements, wenn es sich bei dem Wert des Felds um einen Berechnungsfehler (beispielsweise um eine Teilung durch null oder um einen Überlauf) handelt.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ErrorMessage

String

Ruft die Fehlermeldung eines berechneten Felds ab.

wahr

Komplexer FieldCreationInformation-Typ

Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Choices

Collection(String)

Die Werte, die in einem Feld zur Auswahl stehen.

wahr

IsCompactName

Boolean

Gibt an, ob nur die ersten acht Zeichen als Feldname verwendet werden.

falsch

LookupFieldName

String

Der Name des Quellennaschlagefelds.

wahr

LookupListId

Guid

Die ID der Zielliste für das Quellennachschlagefeld.

falsch

LookupWebId

Guid

Die ID der Website, die die Liste enthält, die als Quelle für den Nachschlagefeldwert dient.

falsch

Required

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob für das Feld ein Wert erforderlich ist.

falsch

Title

String

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

wahr

FieldTypeKind

Int32

Dient zum Abrufen oder Festlegen eines Werts, der die Art des Felds angibt.

falsch

Komplexer FieldGeolocationValue-Typ

Gibt die Höhen-, Breitengrad-, Längengrad- und Messwerte für ein Geolocation-Feld an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Altitude

Double

Der benutzerdefinierte Höhenwert für ein Geolocation-Feld.

falsch

Latitude

Double

Der Breitengradwert für ein Geolocation-Feld.

falsch

Longitude

Double

Der Längenwert für ein Geolocation-Feld.

falsch

Measure

Double

Der benutzerdefinierte Messwert für ein Geolocation-Feld.

falsch

Komplexer FieldLookupValue-Typ

Gibt den Wert einer Suche nach einem Feld innerhalb eines Listenelements an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

LookupId

Int32

Dient zum Abrufen oder Festlegen des Bezeichners (ID) des Listenelements, auf das diese Instanz des Nachschlagefelds verweist.

falsch

LookupValue

String

Ruft eine Zusammenfassung des Listenelements ab, auf das diese Instanz des Nachschlagefelds verweist.

wahr

Komplexer FieldRatingScaleQuestionAnswer-Typ

Steht für eine bestimmte untergeordnete Frage und Antwort innerhalb eines Bewertungsskalafelds eines Listenelements.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Answer

Int32

Dient zum Abrufen oder Festlegen der Antwort auf eine untergeordnete Frage.

falsch

Question

String

Dient zum Abrufen oder Festlegen eines Werts, der eine untergeordnete Frage innerhalb einer Bewertungsskala angibt.

wahr

Komplexer FieldUrlValue-Typ

Gibt den Link- und den Beschreibungswert für "FieldURL" an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Description

String

Dient zum Abrufen oder Festlegen eines Werts, der die Beschreibung für die URI angibt.

wahr

Url

String

Gibt die URI an.

wahr

Komplexer FieldUserValue-Typ

Steht für den Wert eines Benutzerfelds für ein Listenelement. Erbt von SP.FieldLookupValue.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

LookupId

Int32

Die Benutzer-ID, die der Wert eines Nachschlagefelds für Benutzerdaten darstellt.

falsch

LookupValue

String

Der Benutzer, den der Wert eines Nachschlagefelds für Benutzerdaten darstellt.

wahr

Komplexer FileCreationInformation-Typ

Stellt Eigenschaften dar, die festgelegt werden können, wenn eine Datei mithilfe der FileCollection.Add-Methode erstellt wird.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Content

Binary

Der binäre Inhalt der Datei.

wahr

Overwrite

Boolean

Gibt an, ob eine vorhandene Datei mit demselben Namen und an derselben Position überschrieben wird, wie dies bei der hinzugefügten Datei der Fall ist.

falsch

Url

String

Die URL der Datei.

wahr

Komplexer GroupCreationInformation-Typ

Ein Objekt zum Vereinfachen der Erstellung einer websiteübergreifenden Gruppe.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Description

String

Dient zum Abrufen oder Festlegen einer Zeichenfolge mit der Beschreibung der zu erstellenden Gruppe.

wahr

Title

String

Dient zum Abrufen oder Festlegen einer Zeichenfolge mit dem Namen der zu erstellenden Gruppe.

wahr

Komplexer KeyValue-Typ

Stellt ein Verzeichnis der Schlüssel- und Wert-Paar dar.

Eigenschaften

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Key

String

Der Schlüssel.

wahr

Value

String

Der Wert.

wahr

ValueType

String

Der Werttyp

wahr

Komplexer Language-Typ

Stellt eine natürliche Sprache dar, die im Kontext von Microsoft SharePoint Foundation verwendet wird.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

DisplayName

String

Stellt eine natürliche Sprache dar, die im Kontext von Microsoft SharePoint Foundation verwendet wird.

wahr

LanguageTag

String

Ruft das Sprachtag für diese Sprache ab.

wahr

Lcid

Int32

Ruft den Gebietsschemabezeichner (Locale Identifier, LCID) für die Sprache ab.

falsch

Komplexer ListDataSource-Typ

Steht für Informationen im Zusammenhang mit einer Verbindung mit einer externen Datenquelle.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Properties

Collection(SP.KeyValue)

Ruft die Eigenschaften ab, die der Verbindung mit der Datenquelle zugeordnet sind.

wahr

Komplexer ListDataValidationExceptionValue-Typ

Die Ausnahme, die ausgelöst wird, wenn die Überprüfung der Daten für ein Listenfeld oder -element nicht erfolgreich ist.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

FieldFailures

Collection(SP.ListDataValidationFailure)

Die Überprüfungsfehler für ein Feld.

wahr

ItemFailure

SP.ListDataValidationFailure

Die Überprüfungsfehler für ein Listenelement.

wahr

Komplexer ListDataValidationFailure-Typ

Beschreibt einen spezifischen Überprüfungsfehler beim Einfügen oder Aktualisieren eines Listenelements.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

DisplayName

String

Ruft den Titel der Liste oder den Anzeigenamen des Felds ab, bei der bzw. bei dem ein Überprüfungsfehler aufgetreten ist.

wahr

Message

String

Ruft eine Meldung mit Fehlerinformationen ab.

wahr

Name

String

Ruft den Feldnamen oder die Listen-ID ab, für den bzw. für die der Überprüfungsfehler aufgetreten ist.

wahr

Reason

Int32

Ruft die Ursache für den Fehler ab.

falsch

ValidationType

Int32

Beschreibt die Art der Überprüfung, bei der ein Fehler aufgetreten ist.

falsch

Komplexer ListItemCollectionPosition-Typ

Gibt die erforderlichen Informationen zum Abrufen der nächsten Seite mit Daten für eine Listenansicht an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

PagingInfo

String

Dient zum Abrufen oder Festlegen eines Werts, der erforderliche Informationen (in Form von Name-Wert-Paaren) zum Abrufen der nächsten Seite mit Daten für eine Listenansicht angibt.

wahr

Komplexer ListItemCreationInformation-Typ

Gibt die Eigenschaften des neuen Listenelements an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

FolderUrl

String

Dient zum Abrufen oder Festlegen eines Werts, der den Ordner für das neue Listenelement angibt.

wahr

LeafName

String

Dient zum Abrufen oder Festlegen eines Werts, der den Namen des neuen Listenelements angibt. Falls es sich bei der übergeordneten Liste des Listenelements um eine Dokumentbibliothek handelt, muss dies der Name der Datei sein.

wahr

UnderlyingObjectType

Int32

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei dem neuen Listenelement um eine Datei oder um einen Ordner handelt.

falsch

Komplexer ListItemFormUpdateValue-Typ

Stellt die Eigenschaften eines Listenelementfelds und dessen Wert dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ErrorMessage

String

Das Ergebnis der Fehlermeldung, nachdem der Wert für das Feld überprüft wurde.

wahr

FieldName

String

Der interne Name des Felds.

wahr

FieldValue

String

Der Wert des Felds.

wahr

HasException

Boolean

Gibt an, ob ein Fehlerergebnis vorliegt, nachdem der Wert für das Feld überprüft wurde.

falsch

Komplexer MenuNode-Typ

Stellt einen Navigationsknoten in der Navigationshierarchie dar. Eine Navigationshierarchie ist eine Baumstruktur der Navigationsknoten.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

CustomProperties

Collection(SP.KeyValue)

Knoteneigenschaften.

wahr

FriendlyUrlSegment

String

Die URL des Navigationsknotens relativ zur URL des übergeordneten Navigationsknotens.

wahr

IsHidden

Boolean

Gibt an, ob der Knoten im Navigationsmenü ausgeblendet ist. Während des Bearbeitens sind alle Knoten vorübergehend eingeblendet.

falsch

Key

String

Der Bezeichner für den Navigationsknoten im Menübaum.

wahr

Nodes

Collection(SP.MenuNode)

Die untergeordneten Knoten.

wahr

NodeType

Int32

Der Typ des Navigationsknotens.

falsch

SimpleUrl

String

Die relative oder absolute URL des Navigationsknotens. Websiterelative URLs könnten mit dem Token "~site" beginnen und websitesammlungsrelative URLs können mit dem Token "~sitecollection" beginnen. Gilt nur für SimpleLink-Knotentypen.

wahr

Title

String

Der Titel des Navigationsknotens.

wahr

Komplexer MenuState-Typ

Stellt den Menüstatus des standardmäßigen SiteMapProvider ("SPSiteMapProvider") dar, bei dem die Sicherung beim Stammknoten der Website mit einer Tiefe von zehn Ebenen beginnt.

Folgende Parameter sind zur Abfrage des Menüstatus verfügbar:

menuNodeKey

Der Schlüssel des Startknotens. Wenn kein Schlüssel bereitgestellt wird, wird der Stammknoten verwendet.

depth

Die Tiefe der Sicherung. Der Standard lautet 10.

customProperties

(Optional implementiert von einem Siteübersicht-Datenanbieter.) Eine durch Komma getrennte Liste von benutzerdefinierten Eigenschaften, die zurückgegeben werden sollen. Verwenden Sie das Zeichen "\", um ein Kommatrennzeichen innerhalb von einer Eigenschaft zu umgehen.

mapProviderName

Gibt an, welcher Anbieter auf der Website ausgewählt wurde. Wenn kein SiteMapProvider verwendet wird, wird "CurrentNavSiteMapProviderNoEncode" verwendet.

Beispielanforderungen:
http://<site url>/_api/navigation/menustate?menuNodeKey='1006'&depth=5 gibt den Menüstatus des "SPSiteMapProvider" zurück, beginnend mit dem Knoten mit dem Schlüssel 1006 und einer Tiefe von 5.
http://<site url>/_api/navigation/menustate?depth=5&mapProviderName='CurrentNavSiteMapProviderNoEncode' gibt den Menüstatus des "CurrentNavSiteMapProviderNoEncode" aus dem Stammknoten des Anbieters zurück mit einer Tiefe von 5.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

FriendlyUrlPrefix

String

Gibt die websitesammlungsrelative URL für den Stammknoten des Menübaums an.

wahr

Nodes

Collection(SP.MenuNode)

Die untergeordneten Knoten des Stammknotens des Menübaums.

wahr

SimpleUrl

String

Die relative oder absolute URL des Navigationsknotens. Websiterelative URLs können mit dem Token "~site" beginnen und websitesammlungsrelative URLs können mit dem Token "~sitecollection" beginnen. Gilt nur für SimpleLink-Knotentypen.

wahr

SPSitePrefix

String

Die Zeichenfolge, die das Token "~sitecollection" in websitesammlungsrelativen Links ersetzt. Zum Abrufen des Befehls Link ausprobieren, um mit dem relativen Link ~sitecollection/Pages/MyPage.aspx zu arbeiten, kann dieser Wert so aussehen: https://contoso.com/sites/site1/.

wahr

SPWebPrefix

String

Die Zeichenfolge, die das Token "~site" in websiterelativen Links ersetzt. Zum Abrufen des Befehls Link ausprobieren, um mit dem relativen Link ~site/Pages/MyPage.aspx zu arbeiten, kann dieser Wert so aussehen: https://contoso.com/sites/site1/web1.

wahr

StartingNodeKey

String

Der Bezeichner des Stammknotens im Menübaum.

wahr

StartingNodeTitle

String

Der Titel des Stammknotens im Menübaum. (Beispiel: "Dokumentcenter")

wahr

Version

String

Ein implementierungsspezifischer Wert, den der Server verwendet, um externe Änderungen zu ermitteln. Dabei kann es sich beispielsweise um eine Änderung des Zeitstempels für eine Datenbank oder eine monoton ansteigende Versionsnummer wie "2009-06-15T20:45:30Z" handeln.

wahr

Komplexer NavigationNodeCreationInformation-Typ

Beschreibt einen neuen zu erstellenden Navigationsknoten.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

AsLastNode

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Navigationsknoten als letzter Knoten in der Auflistung erstellt wird.

falsch

IsExternal

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Navigationsknoten-URL unter Umständen Seiten außerhalb der Websitesammlung entspricht.

falsch

Title

String

Dient zum Abrufen oder Festlegen eines Werts, der den Ankertext für den Navigationslink angibt.

wahr

Url

String

Dient zum Abrufen oder Festlegen eines Werts, der die mit dem Navigationsknoten zu speichernde URL angibt.

wahr

Komplexer RelatedItem-Typ

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

IconUrl

String

wahr

ItemId

Int32

falsch

ListId

String

wahr

Title

String

wahr

Url

String

wahr

WebId

String

wahr

Komplexer RenderListDataParameters-Typ

Stellt die Parameter zum Rendern von Listendaten wie z. B. einer JavaScript Object Notation (JSON)-Zeichenfolge bereit.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

FolderServerRelativeUrl

String

Die URL des Ordners, aus dem Elemente zurückgegeben werden sollen.

wahr

Paging

String

Die Paging-Informationen.

wahr

ViewXml

String

Die Collaborative Application Markup Language (CAML) zum Anzeigen der XML.

wahr

Komplexer RoleDefinitionCreationInformation-Typ

Enthält Eigenschaften, die als Parameter zum Initialisieren einer Rollendefinition verwendet werden.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

BasePermissions

SP.BasePermissions

Dient zum Abrufen oder Festlegen eines Werts, der die Berechtigungen für die Rollendefinition angibt.

wahr

Description

String

Dient zum Abrufen oder Festlegen eines Werts, der eine Beschreibung der Rollendefinition angibt.

wahr

Eigenschaftsname

String

Dient zum Abrufen oder Festlegen eines Werts, der den Namen der Rollendefinition angibt.

wahr

Reihenfolge

Int32

Dient zum Abrufen oder Festlegen eines Werts, der die Anzeigereihenfolge für Rollen angibt.

falsch

Komplexer SimpleDataRow-Typ

Stellt eine Zeile in einer Datentabelle dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Cells

Collection(SP.KeyValue)

Die Zeilenzellen.

wahr

Komplexer SimpleDataTable-Typ

Stellt eine Datentabelle dar.

Eigenschaften

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Rows

Collection(SP.SimpleDataRow)

Die Zeilen in der Tabelle.

wahr

Komplexer TimeZoneInformation-Typ

Stellt Informationen über eine Zeitzone dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Bias

Int32

Die Minutenanzahl, die sich eine Zeitzone von der Universal Coordinated Time (UTC, koordinierte Weltzeit) unterscheidet. Ein positiver Wert gibt an, dass sich die Zeitzone nach der UTC befindet.

falsch

DaylightBias

Int32

Die Minutenanzahl, die dem Verschiebungswert während der Sommerzeit hinzugefügt wird.

falsch

StandardBias

Int32

Die Minutenanzahl, die dem Verschiebungswert außerhalb der Sommerzeit hinzugefügt wird.

falsch

Komplexer UpgradeInfo-Typ

Stellt die Informationen zum Upgrade der Website dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

ErrorFile

String

Der Speicherort der Datei, die Upgradefehler enthält.

wahr

Errors

Int32

Die Anzahl der Fehler, die während des Websitesammlungsupgrades aufgetreten sind.

falsch

LastUpdated

DateTime

DateTime der letzten Aktualisierung des Upgradeverlaufs.

falsch

LogFile

String

Der Speicherort der Datei, die das Upgradeprotokoll enthält.

wahr

RequestDate

DateTime

Die Angabe zu DateTime, zu der das Websitesammlungsupgrade angefordert wurde.

falsch

RetryCount

Int32

Gibt an, wie oft ein Upgrade der Websitesammlung versucht wurde.

falsch

StartTime

DateTime

Die Angabe zu DateTime, zu der ein Websitesammlungsupgrade gestartet wurde.

falsch

Status

Int32

Der aktuelle Status des Websitesammlungsupgrades.

falsch

UpgradeType

Int32

Der Typ des Websitesammlungsupgrades. Der Typ kann entweder ein Build (bei einem Build-Upgrade, Wert = 0) oder eine Version (bei einem Versionsupgrade, Wert = 1) sein.

falsch

Warnings

Int32

Die Anzahl der Warnungen, die während des Websitesammlungsupgrades aufgetreten sind.

falsch

Komplexer UsageInfo-Typ

Gibt Felder an, die für den Zugriff auf Informationen zur Websitesammlungsverwendung verwendet werden.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Bandwidth

Int64

Ruft einen Wert ab, der die von der Websitesammlung beanspruchte kumulative Bandbreite (in Bytes) während eines implementierungsspezifischen Zeitraums angibt.

falsch

DiscussionStorage

Int64

Ruft einen Wert ab, der die Gesamtmenge des Speicherplatzes auf dem Datenträger (in Bytes) angibt, der derzeit von der Websitesammlung zum Speichern von Webdiskussionskommentaren beansprucht wird.

falsch

Hits

Int64

Ruft einen Wert ab, der die kumulative Anzahl von Anforderungen für Seiten in der Websitesammlung während eines implementierungsspezifischen Zeitraums angibt.

falsch

Storage

Int64

Ruft einen Wert ab, der die Gesamtmenge des Speicherplatzes auf dem Datenträger (in Bytes) angibt, der derzeit von der Websitesammlung beansprucht wird.

falsch

StoragePercentageUsed

Double

Ruft einen Wert ab, der das Verhältnis zwischen der Menge an derzeit von der Websitesammlung beanspruchtem Speicherplatz auf dem Datenträger und dem maximalen Speicherplatz angibt, der im Websitesammlungskontingent angegeben ist.

falsch

Visits

Int64

Ruft einen Wert ab, der die kumulative Anzahl von Anforderungen für Seiten in der Websitesammlung ohne Verweis-URL oder mit Verweis-URL außerhalb der aktuellen Websitesammlung während eines implementierungsspezifischen Zeitraums angibt.

falsch

Komplexer UserCreationInformation-Typ

Parameter zum Einladen eines Benutzers.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Email

String

Dient zum Abrufen oder Festlegen eines Werts, der die E-Mail-Adresse für den zu erstellenden Benutzer angibt.

wahr

LoginName

String

Dient zum Abrufen oder Festlegen eines Werts, der den Anmeldenamen für den zu erstellenden Benutzer angibt.

wahr

Title

String

Dient zum Abrufen oder Festlegen eines Werts, der den Anzeigenamen für den zu erstellenden Benutzer angibt.

wahr

Komplexer UserIdInfo-Typ

Stellt Informationen zum eindeutigen Bezeichner eines Identitätsanbieters dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

NameId

String

Der eindeutiger Bezeichner des Identitätsanbieters.

wahr

NameIdIssuer

String

Der Anzeigename eines Identitätsanbieters, wie dieser in einer Serverfarm registriert ist.

wahr

Komplexer ViewCreationInformation-Typ

Gibt die Eigenschaften an, die zum Erstellen einer neuen Listenansicht verwendet werden.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Paged

Boolean

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

falsch

PersonalView

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob es sich bei der neuen Listenansicht um eine persönliche Ansicht handelt. Lautet der Wert falsch, handelt es sich bei der neuen Listenansicht um eine öffentliche Ansicht.

falsch

Query

String

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

wahr

RowLimit

Int32

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

falsch

SetAsDefaultView

Boolean

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

falsch

Title

String

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

wahr

ViewFields

Collection(String)

Dient zum Abrufen oder Festlegen des Werts, der die Auflistung interner Feldnamen für die Listenfelder in der neuen Listenansicht angibt.

wahr

ViewTypeKind

Int32

Dient zum Abrufen oder Festlegen eines Werts, der die Art der neuen Listenansicht angibt.

falsch

Komplexer WebCreationInformation-Typ

Gibt die Eigenschaften einer neuen Website an.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Description

String

Dient zum Abrufen oder Festlegen der Beschreibung der neuen Website.

wahr

Language

Int32

Dient zum Abrufen oder Festlegen der Gebietsschema-ID, die die Sprache der neuen Website angibt.

falsch

Title

String

Dient zum Abrufen oder Festlegen eines Werts, der den Titel der neuen Website angibt.

wahr

Url

String

Dient zum Abrufen oder Festlegen des URL-Blattnamens der neuen Website.

Die URL darf Folgendes nicht enthalten:
Die Zeichen ~, ", #, %, &, *, :, <, >, ?, \, {, | oder }
Die Zeichenfolge \x7f
Aufeinander folgende . oder / Zeichen,
die mit ., / oder _ beginnen und Zeichen,
  die auf . oder / enden

wahr

UseSamePermissionsAsParentSite

Boolean

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die neue Website Berechtigungen von der übergeordneten Website erbt.

falsch

WebTemplate

String

Dient zum Abrufen oder Festlegen eines Werts, der den Namen der Websitevorlage angibt, die zum Erstellen der neuen Website verwendet werden soll. Verwenden Sie die GetAvailableWebTemplates-Methode, um die Namen der auf der Website verfügbaren Webvorlagen abzurufen.

wahr

Komplexer WebInfoCreationInformation-Typ

Stellt Metadaten zur Websiteerstellung dar.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Beschreibung

String

Die Beschreibung der Website.

wahr

Language

Int32

Ein gültiger Gebietsschemabezeichner (Language Code Identifier, LCID) der Sprache, die auf der Website verwendet werden soll.

falsch

Title

String

Der Titel der Website.

wahr

Url

String

Die URL der Website.

Die URL darf Folgendes nicht enthalten:
Die Zeichen ~, ", #, %, &, *, :, <, >, ?, \, {, | oder }
Die Zeichenfolge \x7f
Aufeinander folgende . oder / Zeichen,
die mit ., / oder _ beginnen und Zeichen,
  die auf . oder / enden

wahr

UseUniquePermissions

Boolean

Gibt an, ob die Website Berechtigungen von der übergeordneten Website erbt.

falsch

WebTemplate

String

Der Name der Websitevorlage, der zum Erstellen der Website verwendet wird.

wahr

Komplexer WebRequestInfo-Typ

Gibt die Daten vom Aufrufer an, die für die Ausführung der ausgehenden Webanforderung benötigt werden.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Body

String

Ruft den Hauptteil der HTTP-Anforderungsmeldung ab oder legt diesen fest.

wahr

Headers

Collection(SP.KeyValue)

Ruft ein Wörterbuch ab oder legt ein Wörterbuch fest, das die Name-Wert-Paare für die Kopfzeilen enthält, die in der HTTP-Anforderung gesendet werden.

wahr

Method

String

Ruft die HTTP-Methode für die Webanforderung ab oder legt diese fest.

wahr

Url

String

Ruft die URL für die Webanforderung ab oder legt die URL fest.

wahr

Komplexer WebResponseInfo-Typ

Enthält eine Kopie der Antwort des Drittanbieterdiensts.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Body

String

Ruft den Hauptteil der HTTP-Antwort ab oder legt diesen fest.

true

Headers

Collection(SP.KeyValue)

Ruft die Kopfzeilen der HTTP-Antwort ab oder legt sie fest.

wahr

StatusCode

Int32

Ruft den Statuscode der HTTP-Antwort ab oder legt diesen fest.

falsch

Komplexer XmlSchemaFieldCreationInformation-Typ

Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können.

Eigenschaftsname

Typ

Beschreibung

Nullwerte zulassen

Options

Int32

Die Optionen zum Hinzufügen des Felds. Unter AddFieldOptions in der .NET-Clientobjekt-Modellreferenz finden Sie eine Liste mit Werten.

>fals

SchemaXml

String

Eine Zeichenfolge von Collaborative Application Markup Language (CAML), die das Schema enthält.

wahr

Hinweise zur Implementierung

Für Parameter des Typs Nullable kann ein Nullwert eingegeben werden, indem Sie den Parameter nicht in die Abfragezeichenfolge der URI einbeziehen.

Siehe auch

Konzepte

REST-API-Referenz und Beispiele

Weitere Ressourcen

Einführung in den SharePoint 2013 REST-Dienst

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