Share via


Felder der REST-API-Referenz

Erfahren Sie mehr über auf Felder bezogene Ressourcen und Endpunkte in der SharePoint-REST-API.

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

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

Informationen zu den Anforderungsbeispielen in diesem Artikel

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

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

  • Wenn Sie die domänenübergreifende Bibliothek verwenden, müssen Sie das Anforderungsformat ändern. Es kann beispielsweise folgendermaßen aussehen.

    executor.executeAsync({
      url: "<app web url>/_api/SP.AppContextSite(@target)/web/fields?@target='<host web url>'",
      method: "POST",
      body: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
      headers: {
        "accept": "application/json;odata=verbose",
        "content-type": "application/json;odata=verbose"
      },
      success: successHandler,
      error: errorHandler
    });
    
  • Wenn Sie OAuth verwenden, fügen Sie eine Authorization-Kopfzeile ("Authorization": "Bearer " + <access token>) hinzu, um das OAuth-Zugriffstoken zu senden.

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

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

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

Tipp

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

Feldressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Stellt ein Feld in einer SharePoint-Liste dar.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Felds mit Feldschema. Zum Senden eines komplexen Schemas können Sie die CreateFieldAsXml-Methode verwenden.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type=\"UserMulti\" Required=\"TRUE\"
    UserSelectionMode=\"PeopleAndGroups\" UserSelectionScope=\"0\" Mult=\"TRUE\" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Möglichkeiten zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Internal stakeholders' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

Feldeigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

CanBeDeleted

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob das Feld gelöscht werden kann.

DefaultValue

String

RW

Ja

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

Description

String

RW

Ja

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

Direction

String

RW

Ja

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

EnforceUniqueValues

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob in einer Liste oder Bibliotheksspalte eindeutige Feldwerte erforderlich sind.

EntityPropertyName

String

R

Ja

Ruft den Namen der Entitätseigenschaft für die Listenelemententität ab, die dieses Feld verwendet.

FieldTypeKind

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Art des Felds angibt. Stellt einen FieldType-Wert dar. Unter FieldType finden Sie in der .NET-Clientobjekt-Modellreferenz eine Liste mit Feldwerten.

Filterbar

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob die Listenelemente in der Liste nach dem Feldwert gefiltert werden können.

FromBaseType

Boolean

R

Ja

Ruft einen Boolean-Wert ab, der angibt, ob das Feld von einem Basisfeldtyp abgeleitet wird.

Group

String

RW

Ja

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

Hidden

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld in Listenansichten und -formularen ausgeblendet ist.

ID

GUID

R

Ja

Ruft einen Wert ab, der den Feldbezeichner angibt.

Indexed

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob das Feld indiziert ist.

InternalName

String

R

Ja

Ruft einen Wert ab, der den internen Feldnamen angibt.

JSLink

String

RW

Ja

Dient zum Abrufen oder Festlegen des Namens einer externen JS-Datei mit Clientrenderinglogik für Felder dieses Typs.

ReadOnlyField

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Wert des Felds schreibgeschützt ist.

Erforderlich

Boolean

RW

Ja

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

SchemaXml

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der das XML-Schema angibt, das das Feld definiert.

SchemaXmlWithResourceTokens

String

R

Nein

Ruft das Schema ab, das das Feld definiert und Ressourcentoken enthält.

Scope

String

RW

Ja

Ruft einen Wert ab, der die serverrelative URL der Liste oder Website angibt, zu der das Feld gehört.

Sealed

Boolean

RW

Ja

Ruft einen Wert ab, der angibt, ob Eigenschaften für das Feld geändert werden können und ob das Feld gelöscht werden kann.

Sortable

Boolean

RW

Ja

Ruft einen Wert ab, der angibt, ob die Listenelemente in der Liste nach dem Feldwert sortiert werden können.

StaticName

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der einen anpassbaren Bezeichner des Felds angibt.

Title

String

RW

Ja

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

TypeAsString

String

RW

Ja

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

TypeDisplayName

String

R

Ja

Ruft einen Wert ab, der den Anzeigenamen für die Art des Felds angibt.

TypeShortDescription

String

R

Ja

Ruft einen Wert ab, der die Beschreibung für die Art des Felds angibt.

ValidationFormula

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Datenüberprüfungskriterien für den Wert des Felds angibt.

ValidationMessage

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Fehlermeldung angibt, die im Falle eines Datenüberprüfungsfehlers für das Feld zurückgegeben wird.

Feldmethoden

DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

DeleteObject-Methode

Die empfohlene Vorgehensweise zum Löschen eines Felds ist das Senden einer DELETE-Anforderung an den Field-Ressourcenendpunkt, wie unter Feldanforderungsbeispiele erläutert.

SetShowInDisplayForm-Methode

Legt den Wert der ShowInDisplayForm-Eigenschaft für dieses Feld fest.

Endpunkt

/setshowindisplayform(<boolean>)

Parameter

Typ: Boolean
true zum Anzeigen des Felds im Formular; andernfalls false.

HTTP method

POST

Antwort

Keine

  -Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowindisplayform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

SetShowInEditForm-Methode

Legt den Wert der ShowInEditForm-Eigenschaft für dieses Feld fest.

Endpunkt

/setshowineditform(<boolean>)

Parameter

Typ: Boolean
true zum Anzeigen des Felds im Formular; andernfalls false.

HTTP method

POST

Antwort

Keine

  -Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowineditform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

SetShowInNewForm-Methode

Legt den Wert der ShowInNewForm-Eigenschaft für dieses Feld fest.

Endpunkt

/setshowinnewform(<boolean>)

Parameter

Typ: Boolean
true zum Anzeigen des Felds im Formular; andernfalls false.

HTTP method

POST

Antwort

Keine

  -Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')
    /setshowinnewform(false)",
  type: "POST",
  headers: { "X-RequestDigest": <form digest value> },
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "__metadata":{,
        "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":false,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Title",
      "Filterable":true,
      "FromBaseType":true,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
      "Indexed":false,
      "InternalName":"Title",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Type=\"Text\" Name=\"Title\" DisplayName=\"Task Name\" Required=\"TRUE\" SourceID=\"https://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" FromBaseType=\"TRUE\" Sealed=\"TRUE\" ColName=\"nvarchar1\" />",
      "Scope":"/Lists/Backlog items",
      "Sealed":true,
      "Sortable":true,
      "StaticName":"Title",
      "Title":"Task Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":255
    }}

FieldCalculated-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Gibt ein berechnetes Feld an. Erbt von SP.Field. Feldwert = 17.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiel

GET-Anforderungsbeispiel: Abrufen eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'FieldTypeKind': 17, 'Title':
    'Days Remaining', 'Formula': '=DATEDIF([Start Date],[End Date],"d")', 'OutputType': 9 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Möglichkeiten zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden. Beispiele unterstützter Formeln finden Sie unter Formeln für berechnete Felder.

MERGE-Anforderungsbeispiel: Ändern eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCalculated' }, 'Title': 'Remaining', 'Formula':
    '=DATEDIF([Start Date],[End Date],"d")&" days"', 'OutputType': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldCalculated-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

DateFormat

Int32

RW

Ja

Dient zum Abrufen oder Festlegen des im Feld angezeigten Datums- und Uhrzeitformats. Stellt einen DateTimeFieldFormatType-Wert darf: DateOnly = 0, DateTime = 1.

Formula

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Formel für das Feld angibt.

OutputType

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der das Ausgabeformat für das Feld angibt. Stellt einen FieldType-Wert dar. Unter FieldType finden Sie in der .NET-Clientobjekt-Modellreferenz eine Liste mit Feldwerten.

FieldCalculated-Methoden

Methoden werden von SP.Field vererbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'ddb702c8-e343-479b-9fda-b71af9175031')",
        "type":"SP.FieldCalculated"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Remaining",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ddb702c8-e343-479b-9fda-b71af9175031",
      "Indexed":false,
      "InternalName":"Remaining",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":true,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Remaining\" Type=\"Calculated\" Required=\"FALSE\" ResultType=\"Number\" ID=\"{ddb702c8-e343-479b-9fda-b71af9175031}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Remaining\" Name=\"Remaining\" ColName=\"sql_variant6\" RowOrdinal=\"0\" ReadOnly=\"TRUE\" Version=\"1\"><Formula>=DATEDIF(Start_x0020_Date,End_x0020_Date,\"d\")</Formula><FieldRefs><FieldRef Name=\"End_x0020_Date\" /><FieldRef Name=\"Start_x0020_Date\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Remaining",
      "Title":"Remaining",
      "FieldTypeKind":17,
      "TypeAsString":"Calculated",
      "TypeDisplayName":"Calculated",
      "TypeShortDescription":"Calculated (calculation based on other columns)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateFormat":0,
      "Formula":"=DATEDIF([Start Date],[End Date],\"d\")",
      "OutputType":9
    }}

FieldCollection-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Stellt eine Sammlung von Feld-Ressourcen dar.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen aller Felder in einer Liste

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GET-Anforderungsbeispiel: Abrufen eines bestimmten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByTitle- oder GetByInternalNameOrTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abrufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Assigned To').

POST-Anforderungsbeispiel: Erstellen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments', 'FieldTypeKind': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Felds mit Feldschema. Zum senden eines komplexen Schemas können Sie die CreateFieldAsXml-Methode verwenden.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: { '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 20, 'Title':
    'Stakeholders', 'SchemaXml': '<Field Type="UserMulti" Required="TRUE"
    UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' },
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json; odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden. Beispiele, in denen die Vorgehensweise zum Ändern oder Löschen eines Felds erläutert werden, finden Sie unter Feldanforderungsbeispiele.

FieldCollection-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/schemaxml",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

SchemaXml

String

R

Nein

Gibt das XML-Schema der Feldauflistung an.

FieldCollection-Methoden

AddDependentLookupField
AddField
CreateFieldAsXml
GetById
GetByInternalNameOrTitle
GetByTitle

AddDependentLookupField-Methode

Fügt ein sekundäres Nachschlagefeld hinzu, das von einem primären Nachschlagefeld für die Beziehung mit der Liste abhängig ist, aus der die verwendeten Informationen stammen.

Endpunkt

/adddependentlookupfield(displayname, primarylookupfieldid, showfield)

Parameter

displayname

Typ: String
Der Titel des neuen Felds.

primarylookupfieldid

Typ: String
Die ID des Nachschlagfelds, dem dieses abhängige Nachschlagfeld zugeordnet werden soll.

showfield

Typ: String
Der Name des Felds aus der Zielliste, aus der Daten miteinbezogen werden sollen.

HTTP method

POST

Antwort

Typ: SP.Field
Das neue Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /adddependentlookupfield(displayname='Project', primarylookupfieldid='c3a92d97-2b77-4a25-9698-3ab54874bc6f', showfield='Title')",
  type: "POST",
  headers: {
    "X-RequestDigest": <form digest value>>,
    "accept": "application/json;odata=verbose"
  },
  success: successHandler,
  error: errorHandler
});

AddField-Methode

Fügt der Feldauflistung ein Feld hinzu.

Endpunkt

/addfield

Parameter

parameters

Typ: SP.FieldCreationInformation
-Eigenschaften, die das neue Feld definieren. Senden Sie diesen Parameter in dem Anforderungstext wie im Beispiel beschrieben.

HTTP method

POST

Antwort

Typ: SP.Field
Das neue Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'Title':
    'Impact', 'FieldTypeKind': 6, 'Required': true, 'Choices': { '__metadata': { 'type':
    'Collection(Edm.String)' }, 'results': [ 'High', 'Medium', 'Low' ] } } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Sie können auch ein Feld hinzufügen, indem Sie eine POST-Anforderung an den FieldCollection-Ressourcenendpunkt senden wie in den FieldCollection -Anforderungsbeispielen erläutert.

CreateFieldAsXml -Methode

Erstellt ein Feld auf der Grundlage des angegebenen Schemas, des angegebenen Boolean-Werts und der angegebenen Feldoptionen.

Endpunkt

/createfieldasxml

Parameter

parameters

Typ: SP.XmlSchemaFieldCreationInformation
Die Eigenschaften des neuen Felds. Senden Sie diesen Parameter im Anforderungstext wie im Beispiel erläutert.

HTTP method

POST

Antwort

Typ: SP.Field
Das neue Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type="UserMulti" Title="Stakeholders" DisplayName="Stakeholders"
    Required="FALSE" UserSelectionMode="PeopleAndGroups" UserSelectionScope="0" Mult="TRUE" />' } }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json; odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Sie können auch ein Feld hinzufügen, indem Sie eine POST-Anforderung an den FieldCollection-Ressourcenendpunkt senden wie in den FieldCollection -Anforderungsbeispielen erläutert.

GetById-Methode

Ruft das Feld mit der angegebenen ID ab.

Endpunkt

/getbyid('<Feld-ID>')

Parameter

Typ: String
Die ID des Felds.

HTTP method

GET

Antwort

Typ: SP.Field
Das angegebene Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyid('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können die Feld-ID auch auch an die FieldCollection-Ressource weitergeben. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1').

GetByInternalNameOrTitle-Methode

Gibt das erste Field -Objekt mit dem angegebenen internen Namen oder Titel aus der Auflistung zurück..

Endpunkt

/getbyinternalnameortitle('<interner Name oder Titel des Felds>')

Parameter

Typ: String
Der interne Name oder Titel des Felds (unter Berücksichtigung der Groß-/Kleinschreibung).

HTTP method

GET

Antwort

Typ: SP.Field
Das angegebene Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbyinternalnameortitle('AssignedTo')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

GetByTitle-Methode

Gibt das erste Feldobjekt in der Auflistung auf der Grundlage des Titels des angegebenen Felds zurück.

Endpunkt

/getbytitle('<Feldtitel>')

Parameter

Type: String
Der Titel des Felds (unter Berücksichtigung der Groß-/Kleinschreibung).

HTTP method

GET

Antwort

Typ: SP.Field
Das angegebene Feld.

  Anforderungsbeispiel

$.ajax({
  url: "http://<site url>/_api/web
    /lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields
    /getbytitle('Start Date')",
  type: "GET",
  headers: { "accept": "application/json; odata=verbose" },
  success: successHandler,
  error: errorHandler
});

OData-Darstellung

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

    {"d":{
      "results":[{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'03e45e84-1992-4d42-9116-26f756012634')",
          "type":"SP.Field"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"ContentTypeId",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":true,
        "Id":"03e45e84-1992-4d42-9116-26f756012634",
        "Indexed":false,
        "InternalName":"ContentTypeId",
        "JSLink":null,
        "ReadOnlyField":true,
        "Required":false,
        "SchemaXml":"<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="https://schemas.microsoft.com/sharepoint/v3" StaticName="ContentTypeId" ColName="tp_ContentTypeId" FromBaseType="TRUE" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"ContentTypeId",
        "Title":"Content Type ID",
        "FieldTypeKind":25,
        "TypeAsString":"ContentTypeId",
        "TypeDisplayName":"Content Type Id",
        "TypeShortDescription":"Content Type Id",
        "ValidationFormula":null,
        "ValidationMessage":null
        },{
        "__metadata":{
          "id":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "uri":"https://<site url>/_api/Web/Lists(guid'da58632f-faf0-4a78-8219-99c307747741')/Fields(guid'fa564e0f-0c70-4ab9-b863-0177e6ddd247')",
          "type":"SP.FieldText"
        },
        "CanBeDeleted":false,
        "DefaultValue":null,
        "Description":"",
        "Direction":"none",
        "EnforceUniqueValues":false,
        "EntityPropertyName":"Title",
        "Filterable":true,
        "FromBaseType":true,
        "Group":"Custom Columns",
        "Hidden":false,
        "Id":"fa564e0f-0c70-4ab9-b863-0177e6ddd247",
        "Indexed":false,
        "InternalName":"Title",
        "JSLink":"clienttemplates.js",
        "ReadOnlyField":false,
        "Required":true,
        "SchemaXml":"<Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Type="Text" Name="Title" DisplayName="Task Name" Required="TRUE" SourceID="https://schemas.microsoft.com/sharepoint/v3" StaticName="Title" FromBaseType="TRUE" Sealed="TRUE" ColName="nvarchar1" />",
        "Scope":"/Lists/Backlog items",
        "Sealed":true,
        "Sortable":true,
        "StaticName":"Title",
        "Title":"Task Name",
        "FieldTypeKind":2,
        "TypeAsString":"Text",
        "TypeDisplayName":"Single line of text",
        "TypeShortDescription":"Single line of text",
        "ValidationFormula":null,
        "ValidationMessage":null,
        "MaxLength":255
        },{
        ...
      }]
    }}

FieldComputed.Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Stellt ein Feld dar, dass vom Inhalt von anderen Feldern abhängt, jedoch ein benutzerdefiniertes Renderingmuster angeben kann. Erbt vom SP.Field. Feldtypwert = 12.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines berechneten Felds durch Verwenden der CreateFieldAsXml-Methode

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/createfieldasxml",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.XmlSchemaFieldCreationInformation' },
    'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="Title" /></FieldRefs></Field>' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  }
  success: successHandler,
  error: errorHandler
});

Nachdem Sie ein berechnetes Feld erstellt und die Schema-XML angegeben haben, müssen Sie die XSL-Renderingdatei erstellen. Weitere Informationen dazu finden Sie unter Übersicht zum XSLT-Listenansicht-Renderingsystem.

MERGE-Anforderungsbeispiel: Ändern eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldComputed' }, 'SchemaXml': '<Field Type=\"Computed\" DisplayName=\"Search\">
    <FieldRefs><FieldRef Name="ID" /><FieldRef Name="Title" /></FieldRefs></Field>' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines berechneten Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldComputed-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

EnableLookup

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob von einem Nachschlagefeld auf das Feld verwiesen werden kann.

FieldComputed-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'dceca14e-c897-4988-ae4f-f7c21bea80e5')",
        "type":"SP.FieldComputed"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Search",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"dceca14e-c897-4988-ae4f-f7c21bea80e5",
      "Indexed":false,
      "InternalName":"Search",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field Type=\"Computed\" DisplayName=\"Search\" ID=\"{dceca14e-c897-4988-ae4f-f7c21bea80e5}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Search\" Name=\"Search\"><FieldRefs><FieldRef Name=\"Title\" /></FieldRefs></Field>",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Search",
      "Title":"Search",
      "FieldTypeKind":12,
      "TypeAsString":"Computed",
      "TypeDisplayName":"Computed",
      "TypeShortDescription":"Computed",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "EnableLookup":false
    }}

FieldDateTime-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Gibt ein Feld mit Datums- und Uhrzeitwerten an. erbt vom SP.Field. Feldtypwert = 4.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Felds für Datum/Uhrzeit

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach internem Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Felds für Datum/Uhrzeit

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FieldTypeKind': 4,
    'Title': 'Handoff Date', 'DisplayFormat': 1 }";
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Felds für Datum/Uhrzeit

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldDateTime' }, 'FriendlyDisplayFormat': 2 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Felds für Datum/Uhrzeit

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldDateTime-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

DateTimeCalendarType

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Kalendertyp des Felds angibt. Stellt einen CalendarType-Wert dar: Gregorianischer Kalender (lokalisiert) = 1, Japan: Ära des Kaisers = 3, Taiwanesischer Kalender = 4, Koreanisch (Tangunzeit) = 5, Hijri (Arabischer Mondkalender) = 6, Thai = 7, Hebräischer Mondkalender = 8, Gregorianisch-französischer Kalender (Naher Osten) = 9, Gregorianischer Kalender (Arabisch) = 10, Gregorianisch (Englisch transkribiert) = 11, Gregorianisch (Französisch transkribiert) = 12, Koreanischer und Japanischer Mondkalender = 14, Chinesischer Mondkalender = 15, Indischer Kalender = 16.

DisplayFormat

Int32

RW

Ja

Dient zum Abrufen oder Festlegen des Formats der im Feld angezeigten Datums- und Uhrzeitangabe. Stellt einen DateTimeFieldFormatType-Wert dar: DateOnly = 0, DateTime = 1.

FriendlyDisplayFormat

Int32

RW

Ja

Stellt einen DateTimeFieldFriendlyFormat-Wert dar: Unspecified = 0, Disabled (standard absolute) = 1, Relative (standard friendly relative) = 2.

FieldDateTime-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'd6b835d3-820f-4926-85bd-7711cc31c4c8')",
        "type":"SP.FieldDateTime"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Handoff_x0020_Date",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"d6b835d3-820f-4926-85bd-7711cc31c4c8",
      "Indexed":false,
      "InternalName":"Handoff_x0020_Date",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Handoff Date\" Type=\"DateTime\" Required=\"FALSE\" ID=\"{d6b835d3-820f-4926-85bd-7711cc31c4c8}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Handoff_x0020_Date\" Name=\"Handoff_x0020_Date\" ColName=\"datetime3\" RowOrdinal=\"0\" Format=\"DateTime\" FriendlyDisplayFormat=\"Unspecified\" Version=\"9\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Handoff_x0020_Date",
      "Title":"Handoff Date",
      "FieldTypeKind":4,
      "TypeAsString":"DateTime",
      "TypeDisplayName":"Date and Time",
      "TypeShortDescription":"Date and Time",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DateTimeCalendarType":0,
      "DisplayFormat":1,
      "FriendlyDisplayFormat":0
    }}

FieldGeolocation-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Stellt ein Feld dar, das Werte zur geografischen Lage enthält. Erbt vom SP.Field. Feldtypwert = 31.

Weitere Informationen zum Verwenden von Speicherort-Feldern finden Sie unter Integrieren von Standort- und Kartenfunktionen in SharePoint 2013.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Speicherort-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Speicherort-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'FieldTypeKind': 31, 'Title': 'Location' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Speicherort-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'City' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderungen finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Speicherort-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldGeolocation-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

FieldGeolocation-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'aec4b49c-573e-42a5-8844-cb1a9e1a720e')",
        "type":"SP.FieldGeolocation"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Location",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"aec4b49c-573e-42a5-8844-cb1a9e1a720e",
      "Indexed":false,
      "InternalName":"Location",
      "JSLink":"Geolocationfieldtemplate.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Location\" Type=\"Geolocation\" Required=\"FALSE\" ID=\"{aec4b49c-573e-42a5-8844-cb1a9e1a720e}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Location\" Name=\"Location\" ColName=\"geography1\" RowOrdinal=\"0\" Version=\"3\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Location",
      "Title":"Location",
      "FieldTypeKind":31,
      "TypeAsString":"Geolocation",
      "TypeDisplayName":"Geolocation",
      "TypeShortDescription":"Geographic location that represents a point on a map",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

FieldGuid-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Erbt vom SP.Field. Feldtypwert = 14.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines GUID-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines GUID-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'FieldTypeKind': 14,
    'Title': 'Project ID' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines GUID-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldGuid' }, 'Title': 'Project GUID', 'EnforceUniqueValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderungen finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines GUID-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldGuid-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

FieldGuid-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'53f865f8-675b-47d2-b4d6-1c8803eb6295')",
        "type":"SP.FieldGuid"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_ID",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"53f865f8-675b-47d2-b4d6-1c8803eb6295",
      "Indexed":false,
      "InternalName":"Project_x0020_ID",
      "JSLink":null,
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project ID\" Type=\"Guid\" Required=\"FALSE\" ID=\"{53f865f8-675b-47d2-b4d6-1c8803eb6295}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_ID\" Name=\"Project_x0020_ID\" ColName=\"uniqueidentifier1\" RowOrdinal=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_ID",
      "Title":"Project ID",
      "FieldTypeKind":14,
      "TypeAsString":"Guid",
      "TypeDisplayName":"Guid",
      "TypeShortDescription":"Guid",
      "ValidationFormula":null,
      "ValidationMessage":null
    }}

FieldLookup- und FieldUser-Ressourcen

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Ressource

Beschreibung

Feldtypwert

FieldLookup

Gibt ein Nachschlagefeld an. Erbt vom SP.Field.

7

FieldUser

Gibt ein Feld an, das einen Benutzer enthält. Erbt vom SP.FieldLookup.

20

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Nachschlage- oder Benutzerfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Nachschlagefelds. Verwenden Sie die AddField-Methode zum Erstellen eines Nachschlagefelds.

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields/addfield",
  type: "POST",
  data: "{ 'parameters': { '__metadata': { 'type': 'SP.FieldCreationInformation' }, 'FieldTypeKind': 7,
    'Title': 'Project Rollup', 'LookupListId': '4635daeb-7206-4513-ad17-ea06e09187ad',
    'LookupFieldName': 'Title' } }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Benutzerfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUser' }, 'FieldTypeKind': 20,
    'Title': 'Owner', 'SelectionGroup': 7, 'SelectionMode': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden .

MERGE-Anforderungsbeispiel: Ändern eines Nachschlagefelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldLookup' }, 'AllowMultipleValues': true }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Nachschlage- oder Benutzerfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldLookup- und FieldUser-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.
Ein * gibt an, dass die Eigenschaft nicht vom FieldLookup geerbt wird.

AllowDisplay*

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob der Name des Benutzers in einer Umfrageliste angezeigt werden soll.
*Gilt nur für FieldUser.

AllowMultipleValues

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob im Nachschlagefeld mehrere Werte zulässig sind. Sie können keine Löscheinschränkung für ein Nachschlagefeld festlegen, der mehrere Werte zulässt.

IsRelationship

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob dieses Nachschlagefeld von SP.List.getRelatedFields aus der zum Nachschlagen verwendeten Liste zurückgegeben wird. Gibt immer false zurück, wenn das Feld eine sekundäre Spalte in einem Nachschlagevorgang mit mehreren Spalten darstellt. Sekundäre Spalten können nicht aus der Quellliste ermittelt werden. Unter IsRelationship in der .NET-Clientobjekt-Modellreferenz finden Sie weitere Informationen zu dieser Eigenschaft.

LookupField

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den internen Feldnamen des für Nachschlagewerte verwendeten Felds angibt.

LookupList

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Listenbezeichner der Liste mit dem Feld angibt, das für Nachschlagewerte verwendet werden soll.

LookupWebId

GUID

RW

Ja

Dient zum Abrufen oder Festlegen der ID der Website, die die Liste enthält, die die Quelle der Werte dieses Felds ist.

Anwesenheit*

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Anwesenheit für das Feld aktiviert ist.
*Gilt nur für FieldUser.

PrimaryFieldId

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Bezeichner des primären Nachschlagefelds angibt (sofern es sich um ein abhängiges Nachschlagefeld handelt). Andernfalls handelt es sich hierbei um eine leere Zeichenfolge.

RelationshipDeleteBehavior

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der das Löschverhalten des Nachschlagefelds angibt. Stellt einen RelationshipDeleteBehaviorType-Wert dar: None = 0, Cascade = 1, Restrict = 2. Unter RelationshipDeleteBehavior in der .NET-Clientobjekt-Modellreferenz finden Sie weitere Informationen zu dieser Eigenschaft.

SelectionGroup*

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Bezeichner der SharePoint-Gruppe angibt, deren Mitglieder als Werte des Felds ausgewählt werden können.
*Gilt nur für FieldUser.

SelectionMode*

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob Benutzer und Gruppen oder nur Benutzer ausgewählt werden können. Stellt einen FieldUserSelectionMode-Wert dar: PeopleOnly = 0, PeopleAndGroups = 1.
*Gilt nur für FieldUser.

FieldLookup- und FieldUser-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'2ee42785-f5b4-4af3-9011-96a9dea67d23')",
        "type":"SP.FieldLookup"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Rollup",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"2ee42785-f5b4-4af3-9011-96a9dea67d23",
      "Indexed":false,
      "InternalName":"Project_x0020_Rollup",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Rollup\" Type=\"Lookup\" Required=\"FALSE\" List=\"{4635DAEB-7206-4513-AD17-EA06E09187AD}\" ID=\"{2ee42785-f5b4-4af3-9011-96a9dea67d23}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Project_x0020_Rollup\" Name=\"Project_x0020_Rollup\" ColName=\"int1\" RowOrdinal=\"0\" ShowField=\"Title\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Rollup",
      "Title":"Project Rollup",
      "FieldTypeKind":7,
      "TypeAsString":"Lookup",
      "TypeDisplayName":"Lookup",
      "TypeShortDescription":"Lookup (information already on this site)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":true,
      "LookupField":"Title",
      "LookupList":"{4635DAEB-7206-4513-AD17-EA06E09187AD}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0
    }}

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'7feaefbb-c501-4539-8973-839da0d2e6f6')",
        "type":"SP.FieldUser"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Owner",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"7feaefbb-c501-4539-8973-839da0d2e6f6",
      "Indexed":false,
      "InternalName":"Owner",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Owner\" Type=\"User\" Required=\"FALSE\" List=\"UserInfo\" ID=\"{7feaefbb-c501-4539-8973-839da0d2e6f6}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Owner\" Name=\"Owner\" ColName=\"int2\" RowOrdinal=\"0\" UserSelectionScope=\"7\" UserSelectionMode=\"PeopleOnly\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Owner",
      "Title":"Owner",
      "FieldTypeKind":20,
      "TypeAsString":"User",
      "TypeDisplayName":"Person or Group",
      "TypeShortDescription":"Person or Group",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowMultipleValues":false,
      "IsRelationship":false,
      "LookupField":"",
      "LookupList":"{a63367c0-83e8-48eb-9b88-d2c0d2db001c}",
      "LookupWebId":"0d787dd7-3d5b-481f-93a3-085687dbb644",
      "PrimaryFieldId":null,
      "RelationshipDeleteBehavior":0,
      "AllowDisplay":true,
      "Presence":true,
      "SelectionGroup":7,
      "SelectionMode":0
    }

FieldMultiChoice-, FieldChoice- und FieldRatingScale-Ressourcen

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Ressource

Beschreibung

Feldtypwert

FieldMultiChoice

Gibt ein Feld an, das mindestens einen Wert aus einer Gruppe angegebener Werte enthält. Erbt vom SP.Field.

15

FieldChoice

Steht für ein Auswahlfeld-Steuerelement. Erbt vom SP.FieldMultiChoice.

6

FieldRatingScale

Gibt ein Feld mit Bewertungsskalawerten für eine Umfrageliste an. Erbt vom SP.FieldMultiChoice. Wird auch als GridChoice bezeichnet.

16

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Status').

POST-Anforderungsbeispiel: Erstellen eines Mehrfachauswahlfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiChoice' }, 'FieldTypeKind': 15,
    'Title': 'Features', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'ECM', 'Workflow', 'Collaboration' ] }, 'FillInChoice': true, 'DefaultValue': 'ECM' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Auswahlfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'FieldTypeKind': 6,
    'Title': 'Scope', 'Choices': { '__metadata': { 'type': 'Collection(Edm.String)' },
    'results': [ 'Internal', 'External' ] }, 'EditFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Bewertungsskalafelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldRatingScale' }, 'FieldTypeKind': 16,
    'Title': 'How frequently do you use these features?', 'Choices':  { '__metadata':
    { 'type': 'Collection(Edm.String)' }, 'results': [ 'ECM', 'Workflow', 'Collaboration' ] },
    'GridTextRangeLow': 'Rarely', 'GridTextRangeAverage': 'Sometimes', 'GridTextRangeHigh': 'Often',
    'GridStartNumber': 1, 'GridEndNumber': 3, 'RangeCount': 3 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Auswahlfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'43c6d385-122f-4b77-a7cd-538ede2a047f')
    /fields('509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldChoice' }, 'DefaultValue': 'External', 'EditFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben eines Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldMultiChoice-, FieldChoice-, und FieldRatingScale-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.
Ein * gibt an, dass die Eigenschaft nicht von FieldMultiChoice geerbt wird.

Auswahl

Collection(Edm.String)

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der Werte angibt, die in dem Feld ausgewählt werden können.

EditFormat*

Int32

RW

Ja

Bestimmt, ob das Auswahlfeld in Form von Optionsschaltflächen (auch Optionsfelder genannt) oder als Dropdownliste angezeigt werden soll. Stellt einen ChoiceFormatType-Wert dar: Dropdown = 0, RadioButtons = 1.
*Gilt nur für FieldChoice.

FillInChoice

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld andere als die von der Choices-Eigenschaft angegebenen Werte akzeptiert.

GridEndNumber*

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Endnummer für die Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

GridNAOptionText*

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Anzeigetext für die Auswahl auf der Bewertungsskala angibt, die für die nicht zutreffende Option steht.
*Gilt nur für FieldRatingScale.

GridStartNumber*

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Startnummer für die Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

GridTextRangeAverage*

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den entsprechenden Anzeigetext für den Durchschnitt der Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

GridTextRangeHigh*

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den entsprechenden Anzeigetext für das obere Ende der Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

GridTextRangeLow*

String

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den entsprechenden Anzeigetext für das untere Ende der Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

Zuordnungen

String

R

Ja

Ruft einen Wert ab, der die entsprechenden internen Werte für Auswahlmöglichkeiten angibt.

RangeCount*

Int32

R

Ja

Ruft einen Wert ab, der die Anzahl von Optionen auf der Bewertungsskala angibt.
*Gilt nur für FieldRatingScale.

FieldMultiChoice-, FieldChoice- und FieldRatingScale-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellungen

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'de0a7921-f807-4806-a4b6-a611224f19e5')",
        "type":"SP.FieldMultiChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":"ECM",
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Features",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"de0a7921-f807-4806-a4b6-a611224f19e5",
      "Indexed":false,
      "InternalName":"Features",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":true,
      "SchemaXml":"<Field Type=\"MultiChoice\" DisplayName=\"Features\" Required=\"TRUE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" FillInChoice=\"TRUE\" ID=\"{de0a7921-f807-4806-a4b6-a611224f19e5}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Features\" Name=\"Features\" ColName=\"ntext6\" RowOrdinal=\"0\"><Default>ECM</Default><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Features",
      "Title":"Features",
      "FieldTypeKind":15,
      "TypeAsString":"MultiChoice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":true,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]}
    }}

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'509e9ac8-7ee6-4452-aaf9-1d2c42909187')",
        "type":"SP.FieldChoice"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Impact",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"509e9ac8-7ee6-4452-aaf9-1d2c42909187",
      "Indexed":false,
      "InternalName":"Impact",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Impact\" Type=\"Choice\" Required=\"FALSE\" ID=\"{509e9ac8-7ee6-4452-aaf9-1d2c42909187}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Impact\" Name=\"Impact\" ColName=\"nvarchar6\" RowOrdinal=\"0\" Version=\"1\"><CHOICES><CHOICE>High</CHOICE><CHOICE>Medium</CHOICE><CHOICE>Low</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Impact",
      "Title":"Impact",
      "FieldTypeKind":6,
      "TypeAsString":"Choice",
      "TypeDisplayName":"Choice",
      "TypeShortDescription":"Choice (menu to choose from)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["High","Medium","Low"]},
      "EditFormat":0
    }}

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "uri":"http://<site url>/_api/Web/Lists(guid'7804ea60-6093-489d-a483-bafd70ea01e9')/Fields(guid'8eac1672-8a47-4d44-a261-f5620db71402')",
        "type":"SP.FieldRatingScale"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"How_x0020_frequently_x0020_do_x02",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"8eac1672-8a47-4d44-a261-f5620db71402",
      "Indexed":false,
      "InternalName":"How_x0020_frequently_x0020_do_x02",
      "JSLink":"",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"How frequently do you use these features?\" Type=\"GridChoice\" Required=\"FALSE\" ID=\"{8eac1672-8a47-4d44-a261-f5620db71402}\" SourceID=\"{7804ea60-6093-489d-a483-bafd70ea01e9}\" StaticName=\"How_x0020_frequently_x0020_do_x02\" Name=\"How_x0020_frequently_x0020_do_x02\" ColName=\"ntext6\" RowOrdinal=\"0\" Version=\"2\" GridTxtRng1=\"Rarely\" GridTxtRng2=\"Sometimes\" GridTxtRng3=\"Often\" GridStartNum=\"1\" GridEndNum=\"3\"><CHOICES><CHOICE>ECM</CHOICE><CHOICE>Workflow</CHOICE><CHOICE>Collaboration</CHOICE></CHOICES></Field>",
      "Scope":"/Lists/Survey",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"How_x0020_frequently_x0020_do_x02",
      "Title":"How frequently do you use these features?",
      "FieldTypeKind":16,
      "TypeAsString":"GridChoice",
      "TypeDisplayName":"Rating Scale",
      "TypeShortDescription":"Rating Scale (a matrix of choices or a Likert scale)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "FillInChoice":false,
      "Mappings":null,
      "Choices":{"__metadata":{"type":"Collection(Edm.String)"},"results":["ECM","Workflow","Collaboration"]},
      "GridEndNumber":3,
      "GridNAOptionText":null,
      "GridStartNumber":1,
      "GridTextRangeAverage":"Sometimes",
      "GridTextRangeHigh":"Often",
      "GridTextRangeLow":"Rarely",
      "RangeCount":3
    }}

FieldMultiLineText-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Gibt ein Feld an, das mehrere Textzeilen enthalten kann. Erbt vom SP.Field. Feldtypwert = 3.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines mehrzeiligen Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines mehrzeiligen Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'FieldTypeKind': 3,
    'Title': 'Justification', 'NumberOfLines': 8 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines mehrzeiligen Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'RichText': true }",
  headers: {
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderungen finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines mehrzeiligen Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldMultiLineText-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

AllowHyperlink

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob ein Link als Feldwert zulässig ist.

AppendOnly

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob alle Änderungen an dem Wert des Felds in Listenformularen angezeigt werden.

NumberOfLines

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die Anzahl der anzuzeigenden Textzeilen für das Feld angibt.

RestrictedMode

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld eine Teilmenge umfangreicher Formatierungen unterstützt.

RichText

Boolean

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld umfangreiche Formatierungen unterstützt.

WikiLinking

Boolean

R

Ja

Ruft einen Wert ab, der angibt, ob ein implementierungsspezifischer Mechanismus zum Verknüpfen von Wiki-Seiten unterstützt wird.

FieldMultiLineText-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'c9569638-28a9-498d-9ed7-8151f54da247')",
        "type":"SP.FieldMultiLineText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Justification",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"c9569638-28a9-498d-9ed7-8151f54da247",
      "Indexed":false,
      "InternalName":"Justification",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Justification\" Type=\"Note\" Required=\"FALSE\" ID=\"{c9569638-28a9-498d-9ed7-8151f54da247}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Justification\" Name=\"Justification\" ColName=\"ntext8\" RowOrdinal=\"0\" NumLines=\"8\" Version=\"3\" AllowHyperlink=\"TRUE\" RichText=\"TRUE\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":false,
      "StaticName":"Justification",
      "Title":"Justification",
      "FieldTypeKind":3,
      "TypeAsString":"Note",
      "TypeDisplayName":"Multiple lines of text",
      "TypeShortDescription":"Multiple lines of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "AllowHyperlink":false,
      "AppendOnly":false,
      "NumberOfLines":8,
      "RestrictedMode":true,
      "RichText":true,
      "WikiLinking":false
    }}

FieldNumber- und FieldCurrency-Ressourcen

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Ressource

Beschreibung

Feldtypwert

FieldNumber

Gibt ein Feld mit Zahlenwerten an. Erbt vom SP.Field.

9

FieldCurrency

Gibt ein Feld mit Währungswerten an. Erbt vom SP.FieldNumber.

10

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Zahlen- oder Währungsfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Zahlenfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'FieldTypeKind': 9, 'Title': 'Target',
    'Minimum Value': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

POST-Anforderungsbeispiel: Erstellen eines Währungsfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldCurrency' }, 'FieldTypeKind': 10, 'Title': 'Est Cost',
    'CurrencyLocaleId': 2058, 'Minimum Value': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Zahlen- oder Währungsfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldNumber' }, 'Minimum Value': 0, 'Maximum Value': 10000 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Zahlen- oder Währungsfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldNumber- und FieldCurrency-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unterFeldeigenschaften.
Ein * gibt an, dass die Eigenschaft nicht vom FieldNumber geerbt wird.

CurrencyLocaleId*

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den Gebietsschemabezeichner (Language Code Identifier, LCID) zum Formatieren des Feldwerts angibt. Hier finden Sie eine Liste der Gebietsschema-IDs.
*Gilt nur für FieldCurrency.

MaximumValue

Double

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den zulässigen Mindestwert für das Feld angibt.

MinimumValue

Double

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der den zulässigen Mindestwert für das Feld angibt.

FieldNumber- und FieldCurrency-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'6b98a3a1-0b14-4495-b184-4de33c32de92')",
        "type":"SP.FieldNumber"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Target",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"6b98a3a1-0b14-4495-b184-4de33c32de92",
      "Indexed":false,
      "InternalName":"Target",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Target\" Type=\"Number\" Required=\"FALSE\" ID=\"{6b98a3a1-0b14-4495-b184-4de33c32de92}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Target\" Name=\"Target\" ColName=\"float1\" RowOrdinal=\"0\" Min=\"1\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Target",
      "Title":"Target",
      "FieldTypeKind":9,
      "TypeAsString":"Number",
      "TypeDisplayName":"Number",
      "TypeShortDescription":"Number (1, 1.0, 100)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue":1
    }}

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "uri":"http://<site url>/_api/Web/Lists(guid'b784e682-3373-4c29-b3c2-373bdb71ce93')/Fields(guid'63ea3717-a47f-4cec-858d-7fcae10de409')",
        "type":"SP.FieldCurrency"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Est_x0020_Cost",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"63ea3717-a47f-4cec-858d-7fcae10de409",
      "Indexed":false,
      "InternalName":"Est_x0020_Cost",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Est Cost\" Type=\"Currency\" Required=\"FALSE\" ID=\"{63ea3717-a47f-4cec-858d-7fcae10de409}\" SourceID=\"{b784e682-3373-4c29-b3c2-373bdb71ce93}\" StaticName=\"Est_x0020_Cost\" Name=\"Est_x0020_Cost\" ColName=\"float3\" RowOrdinal=\"0\" LCID=\"2058\" Min=\"0\" Version=\"1\" />",
      "Scope":"/Lists/Targets",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Est_x0020_Cost",
      "Title":"Est Cost",
      "FieldTypeKind":10,
      "TypeAsString":"Currency",
      "TypeDisplayName":"Currency",
      "TypeShortDescription":"Currency ($, ¥, €)",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaximumValue":1.7976931348623157e+308,
      "MinimumValue": 0,
      "CurrencyLocaleId":2058
    }}

FieldText-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Gibt ein Feld an, das eine einzelne Textzeile enthält. Erbt vom SP.Field. Feldtypwert = 2.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'FieldTypeKind': 2,
    'Title': 'Project Name', 'MaxLength': '22' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldText' }, 'Title': 'Code Name', 'MaxLength': '15' }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines Textfelds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldText-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

MaxLength

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der die maximal zulässige Anzahl von Zeichen für den Feldwert angibt.

FieldText-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{,
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'bab9754a-3779-4862-8a8f-efcfef4fe073')",
        "type":"SP.FieldText"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Project_x0020_Name",
      "Filterable":true,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"bab9754a-3779-4862-8a8f-efcfef4fe073",
      "Indexed":false,
      "InternalName":"Project_x0020_Name",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Project Name\" Type=\"Text\" Required=\"FALSE\" ID=\"{bab9754a-3779-4862-8a8f-efcfef4fe073}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Project_x0020_Name\" Name=\"Project_x0020_Name\" ColName=\"nvarchar5\" RowOrdinal=\"0\" MaxLength=\"22\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Project_x0020_Name",
      "Title":"Project Name",
      "FieldTypeKind":2,
      "TypeAsString":"Text",
      "TypeDisplayName":"Single line of text",
      "TypeShortDescription":"Single line of text",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "MaxLength":22
    }}

FieldUrl-Ressource

Endpunkt-URI  |  Eigenschaften  |  Methoden  |  OData-Darstellung

Gibt ein Feld an, das eine URL enthält. Erbt vom SP.Field. Feldtypwert = 11.

Endpunkt-URI

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

Unterstützte HTTP-Methoden

GET  |  POST  |  DELETE  |  MERGE  |  PUT

Anforderungsbeispiele

GET-Anforderungsbeispiel: Abrufen eines URL-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Sie können auch die GetByInternalNameOrTitle- oder GetByTitle-Methode aus der FieldCollection-Ressource verwenden, um ein Feld nach dem internen Namen oder Titel (unter Berücksichtigung der Groß-/Kleinschreibung) abzurufen. Beispiel: …/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date').

POST-Anforderungsbeispiel: Erstellen eines URL-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'FieldTypeKind': 11,
    'Title': 'Avatar', 'DisplayFormat': 1 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "accept": "application/json;odata=verbose",
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>
  },
  success: successHandler,
  error: errorHandler
});

Weitere Optionen zum Erstellen eines Felds finden Sie unter FieldCollection-Methoden.

MERGE-Anforderungsbeispiel: Ändern eines URL-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  data: "{ '__metadata': { 'type': 'SP.FieldUrl' }, 'Title': 'Team pics', 'DisplayFormat': 0 }",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "content-type": "application/json;odata=verbose",
    "content-length": <length of body data>,
    "X-HTTP-Method": "MERGE"
  },
  success: successHandler,
  error: errorHandler
});

Weitere Informationen zum Angeben des Feldtyps in einer MERGE- oder PUT-Anforderung finden Sie unter Hinweise zur Implementierung.

DELETE-Anforderungsbeispiel: Löschen eines URL-Felds

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')",
  type: "POST",
  headers: { 
    "X-RequestDigest": <form digest value>,
    "X-HTTP-Method": "DELETE"
  },
  success: successHandler,
  error: errorHandler
});

FieldUrl-Eigenschaften

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

$.ajax({
  url: "http://<site url>/_api/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')
    /fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')/<property name>",
  type: "GET",
  headers: { "accept": "application/json;odata=verbose" },
  success: successHandler,
  error: errorHandler
});

Eigenschaft

Typ

R/W

Mit Ressource zurückgegeben

Beschreibung

Vom SP.Field geerbte Eigenschaften finden Sie unter Feldeigenschaften.

DisplayFormat

Int32

RW

Ja

Dient zum Abrufen oder Festlegen eines Werts, der das Anzeigeformat für den Wert im Feld angibt. Stellt einen UrlFieldFormatType-Wert dar: Hyperlink = 0, Image = 1.

FieldUrl-Methoden

Methoden werden vom SP.Field geerbt.

DeleteObject  (oder senden Sie eine DELETE-Anforderung an den Feldendpunkt)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData-Darstellung

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

    {"d":{
      "__metadata":{
        "id":"Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "uri":"http://<site url>/_api/Web/Lists(guid'47f89cf2-359d-4792-9dc4-8da877a5050a')/Fields(guid'ac80888e-9373-4886-8496-2ee2461cdf03')",
        "type":"SP.FieldUrl"
      },
      "CanBeDeleted":true,
      "DefaultValue":null,
      "Description":"",
      "Direction":"none",
      "EnforceUniqueValues":false,
      "EntityPropertyName":"Avatar",
      "Filterable":false,
      "FromBaseType":false,
      "Group":"Custom Columns",
      "Hidden":false,
      "Id":"ac80888e-9373-4886-8496-2ee2461cdf03",
      "Indexed":false,
      "InternalName":"Avatar",
      "JSLink":"clienttemplates.js",
      "ReadOnlyField":false,
      "Required":false,
      "SchemaXml":"<Field DisplayName=\"Avatar\" Type=\"URL\" Required=\"FALSE\" ID=\"{ac80888e-9373-4886-8496-2ee2461cdf03}\" SourceID=\"{47f89cf2-359d-4792-9dc4-8da877a5050a}\" StaticName=\"Avatar\" Name=\"Avatar\" ColName=\"nvarchar13\" RowOrdinal=\"0\" ColName2=\"nvarchar14\" RowOrdinal2=\"0\" Format=\"Image\" Version=\"1\" />",
      "Scope":"/Lists/Team tasks",
      "Sealed":false,
      "Sortable":true,
      "StaticName":"Avatar",
      "Title":"Avatar",
      "FieldTypeKind":11,
      "TypeAsString":"URL",
      "TypeDisplayName":"Hyperlink or Picture",
      "TypeShortDescription":"Hyperlink or Picture",
      "ValidationFormula":null,
      "ValidationMessage":null,
      "DisplayFormat":1
    }}

Hinweise zur Implementierung

Zum Ändern einer geerbten Eigenschaft kann der type-Wert in den Textdaten den übergeordneten Feldtypen, der das Feld definiert oder den untergeordneten Feldtyp angeben, der sei erbt. Die folgenden Textdaten ändern beispielweise die Title-Eigenschaft für Felder, die vom SP.Field: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }" abgeleitet werden. Um jedoch die Eigenschaft zu ändern, die nicht geerbt wird, müssen Sie den Feldtyp angeben, der die Eigenschaft enthält. Die folgenden Textdaten geben beispielsweise den SP.FieldMultiLineText-Typ an, da sie auch die NumberOfLines-Eigenschaft ändern: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"

Zusätzliche Ressourcen