通过

字段 REST API 引用

  • 项目

了解 SharePoint REST API 中与字段相关的资源和终结点。

上次修改时间：2015年3月9日

适用范围：apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

关于本文中的请求示例

本文中的示例使用 jQuery AJAX 请求。在尝试使用示例之前，请执行以下操作：

  • 更改 <网站 URL> 和其他占位符数据，例如 SharePoint 实体的任何 ID、名称或路径。

  • 如果您使用跨域库，您将需要更改请求格式。例如，它可能如下所示：

    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
});

  • 如果您使用 OAuth，请添加 Authorization 标头 ("Authorization": "Bearer " + <access token>) 以发送 OAuth 访问令牌。

  • 在请求示例中，从 url 和 data 属性值中删除换行符。将换行符添加到示例中，使其更易于读取。

  • 如果您希望服务器以 Atom 格式返回响应，请删除 "accept": "application/json; odata=verbose" 标头。

请参阅 REST 请求如何因环境而异获取有关更改请求的详细信息。请参阅其他资源获取有关使用跨域库、OAuth 和 SharePoint REST 服务的详细信息的链接。

提示

SharePoint Online REST 服务支持使用 OData $batch 查询选项，将多个请求组合到对服务的单个调用中。有关详细信息和代码示例链接，请参阅使用 REST API 发出批处理请求。内部部署 SharePoint 尚不支持此选项。

字段资源

终结点 URI  |  属性  |  方法  |  OData 表示

表示 SharePoint 列表中的字段。

终结点 URI

http://<网站 url>/_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByTitle 方法，以根据其标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建字段

$.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 请求示例：创建一个字段，包括字段架构。要发送复杂架构，您可以使用 CreateFieldAsXml 方法。

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除字段

$.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
});

字段属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

CanBeDeleted

Boolean

R

可访问

获取一个值，该值指定是否可以删除该字段。

DefaultValue

String

RW

可访问

获取或设置一个值，该值指定字段的默认值。

Description

String

RW

可访问

获取或设置一个值，该值指定字段的说明。

Direction

String

RW

可访问

获取或设置一个值，该值指定字段的读取顺序。

EnforceUniqueValues

Boolean

RW

可访问

获取或设置一个值，该值指定列表或库列中是否需要唯一字段值。

EntityPropertyName

String

R

可访问

获取使用此字段的列表项实体的实体属性的名称。

FieldTypeKind

Int32

RW

可访问

获取或设置一个值，该值指定字段的类型。 表示 FieldType 值。有关字段类型值列表，请参阅 .NET 客户端对象模型引用中的 FieldType。

Filterable

Boolean

R

可访问

获取一个值，该值指定是否可按字段值筛选列表中的列表项。

FromBaseType

Boolean

R

可访问

获取一个 Boolean 值，该值指示此字段是否派生自基字段类型。

Group

String

RW

可访问

获取或设置一个值，该值指定字段组。

Hidden

Boolean

RW

可访问

获取或设置一个值，该值指定字段在列表视图和列表表单中是否处于隐藏状态。

Id

GUID

R

可访问

获取指定字段标识符的值。

Indexed

Boolean

RW

可访问

获取或设置一个布尔值，该值指定字段是否编入索引。

InternalName

String

R

可访问

获取一个值，该值指定字段内部名称。

JSLink

String

RW

可访问

获取或设置外部 JS 文件的名称，该文件包含此类型的字段的任何客户端呈现逻辑。

ReadOnlyField

Boolean

RW

可访问

获取或设置一个值，该值指定字段值是否是只读状态。

Required

Boolean

RW

可访问

获取或设置一个值，该值指定此字段是否需要值。

SchemaXml

String

RW

可访问

获取或设置一个值，该值指定用于定义字段的 XML 架构。

SchemaXmlWithResourceTokens

String

R

不可访问

获取定义字段并包含资源令牌的架构。

Scope

String

RW

可访问

获取一个值，该值指定字段所属的列表或网站相对于服务器的 URL。

Sealed

Boolean

RW

可访问

获取一个值，该值指定是否可以更改该字段的属性以及是否可以删除该字段。

Sortable

Boolean

RW

可访问

获取一个值，该值指定列表中的列表项是否可按字段值排序。

StaticName

String

RW

可访问

获取或设置一个值，该值指定字段的可自定义标识符。

Title

String

RW

可访问

获取或设置一个值，该值指定字段的显示名称。

TypeAsString

String

RW

可访问

获取或设置一个值，该值指定字段的类型。

TypeDisplayName

String

R

可访问

获取一个值，该值指定字段类型的显示名称。

TypeShortDescription

String

R

可访问

获取一个值，该值指定字段类型的描述。

ValidationFormula

String

RW

可访问

获取或设置一个值，该值指定字段值的数据验证条件。

ValidationMessage

String

RW

可访问

获取或设置一个值，该值指定在字段的数据验证失败时返回的错误消息。

字段方法

DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

DeleteObject 方法

删除字段的建议方式是发送 DELETE 请求到 Field 资源终结点，如 Field 请求示例中所示。

SetShowInDisplayForm 方法

设置此字段 ShowInDisplayForm 属性的值。

终结点

/setshowindisplayform(<boolean>)

参数

类型：Boolean
true 可在表单中显示字段；否则请键入 false。

HTTP method

POST

响应

无

  请求示例

$.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 方法

设置此字段 ShowInEditForm 属性的值。

终结点

/setshowineditform(<boolean>)

参数

类型：Boolean
true 可在表单中显示字段；否则请键入 false。

HTTP method

POST

响应

无

  请求示例

$.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 方法

设置此字段 ShowInNewForm 属性的值。

终结点

/setshowinnewform(<boolean>)

参数

类型：Boolean
true 可在表单中显示字段；否则请键入 false。

HTTP method

POST

响应

无

  请求示例

$.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 表示

以下示例表示 JSON 格式的 Field 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

指定一个计算字段。 继承自 SP.Field。字段类型值 = 17。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取计算字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建计算字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。有关支持公式的示例，请参阅计算字段公式。

MERGE 请求示例：更改计算字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除计算字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

DateFormat

Int32

RW

可访问

获取或设置字段中显示的日期和时间格式。 表示 DateTimeFieldFormatType 值：DateOnly = 0，DateTime = 1。

Formula

String

RW

可访问

获取或设置一个值，该值指定字段的公式。

OutputType

Int32

RW

可访问

获取或设置一个值，该值指定字段的输出格式。 表示 FieldType 值。有关字段类型值列表，请参阅 .NET 客户端对象模型引用中的 FieldType。

FieldCalculated 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldCalculated 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

表示 Field 资源的集合。

终结点 URI

http://<网站 url>/_api/web/fields
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields

支持的 HTTP 方法

GET  |  POST

请求示例

GET 请求示例：获取列表中的所有字段

$.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 请求示例：获取特定字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByTitle 或 GetByInternalNameOrTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Assigned To')。

POST 请求示例：创建字段

$.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 请求示例：创建一个字段，包括字段架构。要发送复杂架构，您可以使用 CreateFieldAsXml 方法。

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。请参阅 Field 请求示例获取介绍如何更改或删除字段的示例。

FieldCollection 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

SchemaXml

String

R

不可访问

指定字段集合的 XML 架构。

FieldCollection 方法

AddDependentLookupField
AddField
CreateFieldAsXml
GetById
GetByInternalNameOrTitle
GetByTitle

AddDependentLookupField 方法

添加一个依赖主查阅字段的辅助查阅字段，以便与它从中获取信息的列表形成关系。

终结点

/adddependentlookupfield(displayname, primarylookupfieldid, showfield)

参数
displayname

类型：String
新字段的标题。

primarylookupfieldid

类型：String
此相关查找字段与其关联的查找字段的 ID。

showfield

类型：String
要包含其中数据的目标列表字段的名称。

HTTP method

POST

响应

类型：SP.Field
新字段。

  请求示例

$.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 方法

将字段添加到字段集合中。

终结点

/addfield

参数
parameters

类型：SP.FieldCreationInformation
定义新字段的属性。在请求正文中发送此参数，如以下示例中所示。

HTTP method

POST

响应

类型：SP.Field
新字段。

  请求示例

$.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
});

或者您可以通过向 FieldCollection 资源终结点发送一个 POST 请求来添加字段，如 FieldCollection 请求示例中所示。

CreateFieldAsXml 方法

基于指定的架构、Boolean 值和字段选项创建一个字段。

终结点

/createfieldasxml

参数
parameters

类型：SP.XmlSchemaFieldCreationInformation
新字段的属性。在请求正文中发送此参数，如以下示例中所示。

HTTP method

POST

响应

类型：SP.Field
新字段。

  请求示例

$.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
});

或者您可以通过向 FieldCollection 资源终结点发送一个 POST 请求来添加字段，如 FieldCollection 请求示例中所示。

GetById 方法

获取具有指定 ID 的字段。

终结点

/getbyid('<字段 id>')

参数

类型：String
字段的 ID。

HTTP method

GET

响应

类型：SP.Field
指定字段。

  请求示例

$.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
});

或者您可以将字段 ID 传递到 FieldCollection 资源。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields('1d22ea11-1e32-424e-89ab-9fedbadb6ce1')。

GetByInternalNameOrTitle 方法

从集合中返回第一个具有指定的内部名称或标题的 Field 对象。

终结点

/getbyinternalnameortitle('<字段内部名称或标题>')

参数

类型：String
字段的内部名称或标题（区分大小写）。

HTTP method

GET

响应

类型：SP.Field
指定字段。

  请求示例

$.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 方法

基于指定字段的标题返回集合中的第一个字段对象。

终结点

/getbytitle('<字段标题>')

参数

类型：String
字段的标题（区分大小写）。

HTTP method

GET

响应

类型：SP.Field
指定字段。

  请求示例

$.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 表示

以下示例表示 JSON 格式的 FieldCollection 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

表示内容依赖于其他字段的字段，但可以指定自定义呈现属性。继承自 SP.Field。字段类型值 = 12。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取计算字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：使用 CreateFieldAsXml 方法创建计算字段

$.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
});

创建计算字段并指定架构 XML 后，您必须创建 XSL 呈现文件。请参阅 XSLT 列表视图呈现系统概述。

MERGE 请求示例：更改计算字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除计算字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

EnableLookup

Boolean

RW

可访问

获取或设置一个值，该值指定查阅字段是否可引用该字段。

FieldComputed 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldComputed 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

指定包含日期和时间值的字段。 继承自 SP.Field。字段类型值 = 4。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取日期时间字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建日期时间字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改日期时间字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除日期时间字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

DateTimeCalendarType

Int32

RW

可访问

获取或设置一个值，该值指定字段的日历类型。 表示 CalendarType 值：Gregorian (localized) = 1，Japanese Emperor Era = 3，Taiwan Calendar = 4，Korean Tangun Era = 5，Hijri (Arabic Lunar) = 6，Thai = 7，Hebrew Lunar = 8，Gregorian (Middle East French) = 9，Gregorian (Arabic) = 10，Gregorian (Transliterated English) = 11，Gregorian (Transliterated French) = 12，Korean and Japanese Lunar = 14，Chinese Lunar = 15，Saka Era = 16。

DisplayFormat

Int32

RW

可访问

获取或设置字段中显示的日期和时间的格式。 表示 DateTimeFieldFormatType 值：DateOnly = 0，DateTime = 1。

FriendlyDisplayFormat

Int32

RW

可访问

表示 DateTimeFieldFriendlyFormat 值：Unspecified = 0，Disabled (standard absolute) = 1，Relative (standard friendly relative) = 2。

FieldDateTime 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldDateTime 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

表示包含地理位置值的字段。 继承自 SP.Field。字段类型值 = 31。

要了解有关使用位置字段的详细信息，请参阅集成 SharePoint 2013 中的位置和映射功能。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取位置字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建位置字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改位置字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除位置字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

FieldGeolocation 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldGeolocation 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

继承自 SP.Field。字段类型值 = 14。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取 GUID 字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建 GUID 字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改 GUID 字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除 GUID 字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

FieldGuid 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldGuid 资源。

    {"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 和 FieldUser 资源

终结点 URI  |  属性  |  方法  |  OData 表示

资源

说明

字段类型值

FieldLookup

指定查阅字段。 继承自 SP.Field。

7

FieldUser

指定包含用户的字段。 继承自 SP.FieldLookup。

20

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取查找或用户字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建查找字段。使用 AddField 方法创建一个查找字段。

$.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 请求示例：创建用户字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改查找字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除查找或用户字段

$.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 和 FieldUser 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关继承自 SP.Field 的属性，请参阅字段属性。
* 表示属性并非继承自 FieldLookup。

AllowDisplay*

Boolean

RW

可访问

获取或设置一个值，该值指定是否在调查列表中显示用户姓名。
*仅适用于 FieldUser。

AllowMultipleValues

Boolean

RW

可访问

获取或设置一个值，该值指定查阅字段是否允许多个值。 您无法对允许多个值的查找字段设置删除限制。

IsRelationship

Boolean

RW

可访问

获取或设置一个值，该值指定此查阅字段是否是 SP.List.getRelatedFields 从所查阅的列表中返回的。 如果字段表示多列查找中的第二列，始终返回 false。第二列无法从源列表发现。有关此属性的详细信息，请参阅 .NET 客户端对象模型引用中的 IsRelationship。

LookupField

String

RW

可访问

获取或设置一个值，该值指定用作查阅值的字段的内部字段名称。

LookupList

String

RW

可访问

获取或设置一个用于指定列表的列表标识符的值，该列表包含要用作查阅值的字段。

LookupWebId

GUID

RW

可访问

获取或设置网站的 ID，该网站包含为此字段值来源的列表。

Presence*

Boolean

RW

可访问

获取或设置一个值，该值指定是否对此字段启用状态。
*仅适用于 FieldUser。

PrimaryFieldId

String

RW

可访问

获取或设置一个值，该值指定主查阅字段标识符（如果它是依赖查阅字段）。否则，它是一个空字符串。

RelationshipDeleteBehavior

Int32

RW

可访问

获取或设置一个值，该值指定查阅字段的删除行为。 表示 RelationshipDeleteBehaviorType 值：None = 0，Cascade = 1，Restrict = 2。有关此属性的详细信息，请参阅 .NET 客户端对象模型引用中的 RelationshipDeleteBehavior。

SelectionGroup*

Int32

RW

可访问

获取或设置一个值，该值指定可以选择其成员作为字段值的 SharePoint 组的标识符。
*仅适用于 FieldUser。

SelectionMode*

Int32

RW

可访问

获取或设置一个值，该值指定是可以选择用户和组，还是只能选择用户。 表示 FieldUserSelectionMode 值：PeopleOnly = 0，PeopleAndGroups = 1。
*仅适用于 FieldUser。

FieldLookup 和 FieldUser 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldLookup 资源。

    {"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
    }}

以下示例表示 JSON 格式的 SP.FieldUser 资源。

    {"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 和 FieldRatingScale 资源

终结点 URI  |  属性  |  方法  |  OData 表示

资源

说明

字段类型值

FieldMultiChoice

指定一个字段，该字段包含一组指定值中的一个或多个值。 继承自 SP.Field。

15

FieldChoice

表示选项字段控件。 继承自 SP.FieldMultiChoice。

6

FieldRatingScale

指定包含调查列表的评估范围值的字段。 继承自 SP.FieldMultiChoice。也称为 GridChoice。

16

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Status')。

POST 请求示例：创建多个选择字段

$.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 请求示例：创建选择字段

$.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 请求示例：创建评估范围字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改选择字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除字段

$.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 和 FieldRatingScale 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关继承自 SP.Field 的属性，请参阅字段属性。
* 表示属性并非继承自 FieldMultiChoice。

Choices

Collection(Edm.String)

RW

可访问

获取或设置一个值，该值指定可供在字段中选择的值。

EditFormat*

Int32

RW

可访问

确定是将选项字段显示为选项按钮（也称为"单选按钮"）还是显示为下拉列表。 表示 ChoiceFormatType 值：Dropdown = 0，RadioButtons = 1。
*仅适用于 FieldChoice。

FillInChoice

Boolean

RW

可访问

获取或设置一个值，该值指定字段是否可接受 Choices 属性指定的值以外的值。

GridEndNumber*

Int32

RW

可访问

获取或设置一个值，该值指定评级范围的结束编号。
*仅适用于 FieldRatingScale。

GridNAOptionText*

String

RW

可访问

获取或设置一个值，该值指定与评估范围中的选项对应的显示文本，以指示不适用的选项。
*仅适用于 FieldRatingScale。

GridStartNumber*

Int32

RW

可访问

获取或设置一个值，该值指定评估范围的起始编号。
*仅适用于 FieldRatingScale。

GridTextRangeAverage*

String

RW

可访问

获取或设置一个值，该值指定与评估范围的平均值对应的显示文本。
*仅适用于 FieldRatingScale。

GridTextRangeHigh*

String

RW

可访问

获取或设置一个值，该值指定与评估范围的最大值对应的显示文本。
*仅适用于 FieldRatingScale。

GridTextRangeLow*

String

RW

可访问

获取或设置一个值，该值指定与评估范围的最小值对应的显示文本。
*仅适用于 FieldRatingScale。

Mappings

String

R

可访问

获取一个值，该值指定与选项对应的内部值。

RangeCount*

Int32

R

可访问

获取一个值，该值指定评估范围中的选项数目。
*仅适用于 FieldRatingScale。

FieldMultiChoice、FieldChoice 和 FieldRatingScale 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldMultiChoice 资源。

    {"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"]}
    }}

以下示例表示 JSON 格式的 SP.FieldChoice 资源。

    {"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
    }}

以下示例表示 JSON 格式的 SP.FieldRatingScale 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

指定可以包含多行文本的字段。 继承自 SP.Field。字段类型值 = 3。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取多行文本字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建多行文本字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改多行文本字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除多行文本字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

AllowHyperlink

Boolean

RW

可访问

获取或设置一个值，该值指定是否允许将超链接用作字段值。

AppendOnly

Boolean

RW

可访问

获取或设置一个值，该值指定是否在列表表单上显示对字段值所做的所有更改。

NumberOfLines

Int32

RW

可访问

获取或设置一个值，该值指定要对字段显示的文本行数。

RestrictedMode

Boolean

RW

可访问

获取或设置一个值，该值指定字段是否支持富格式子集。

RichText

Boolean

RW

可访问

获取或设置一个值，该值指定字段是否支持富格式。

WikiLinking

Boolean

R

可访问

获取一个值，该值指定是否支持用于链接 Wiki 页面的特定于实现的机制。

FieldMultiLineText 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldMultiLineText 资源。

    {"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 和 FieldCurrency 资源

终结点 URI  |  属性  |  方法  |  OData 表示

资源

说明

字段类型值

FieldNumber

指定包含数字值的字段。 继承自 SP.Field。

9

FieldCurrency

指定包含货币值的字段。 继承自 SP.FieldNumber。

10

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取数字或货币字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建数字字段

$.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 请求示例：创建货币字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改数字或货币字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除数字或货币字段

$.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 和 FieldCurrency 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关继承自 SP.Field 的属性，请参阅字段属性。
* 表示属性并非继承自 FieldNumber。

CurrencyLocaleId*

Int32

RW

可访问

获取或设置一个值，该值指定用于设置字段值格式的语言代码标识符 (LCID)。 请参阅区域设置 ID 列表。
*仅适用于 FieldCurrency。

MaximumValue

Double

RW

可访问

获取或设置一个值，该值指定字段允许的最小值。

MinimumValue

Double

RW

可访问

获取或设置一个值，该值指定字段允许的最小值。

FieldNumber 和 FieldCurrency 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldNumber 资源。

    {"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
    }}

以下示例表示 JSON 格式的 SP.FieldCurrency 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

指定包含单行文本的字段。 继承自 SP.Field。字段类型值 = 2。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取文本字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建文本字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改文本字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除文本字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

MaxLength

Int32

RW

可访问

获取或设置一个值，该值指定字段值允许的最大字符数。

FieldText 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldText 资源。

    {"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 资源

终结点 URI  |  属性  |  方法  |  OData 表示

指定包含 URL 的字段。 继承自 SP.Field。字段类型值 = 11。

终结点 URI

http://<网站 url>_api/web/fields('<字段 id>')
http://<网站 url>/_api/web/lists(guid'<列表 id>')/fields('<字段 id>')

支持的 HTTP 方法

GET  |  POST  |  DELETE  |  MERGE  |  PUT

请求示例

GET 请求示例：获取 URL 字段

$.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
});

或者您可以使用 FieldCollection 资源中的 GetByInternalNameOrTitle 或 GetByTitle 方法，以根据其内部名称或标题（区分大小写）获取字段。示例：…/web/lists(guid'da58632f-faf0-4a78-8219-99c307747741')/fields/getbytitle('Start Date')。

POST 请求示例：创建 URL 字段

$.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
});

有关创建字段的其他方式，请参阅 FieldCollection 方法。

MERGE 请求示例：更改 URL 字段

$.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
});

有关在 MERGE 或 PUT 请求中指定字段类型的信息，请参阅实现说明。

DELETE 请求示例：删除 URL 字段

$.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 属性

若要获取属性，请向属性终结点发送 GET 请求，如以下示例所示。

$.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
});

属性

类型

R/W

返回资源

说明

有关从 SP.Field 继承的属性，请参阅字段属性。

DisplayFormat

Int32

RW

可访问

获取或设置一个值，该值指定字段中的值的显示格式。 表示 UrlFieldFormatType 值：Hyperlink = 0，Image = 1。

FieldUrl 方法

方法继承自 SP.Field。

DeleteObject（或向字段终结点发送一个 DELETE 请求）
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

OData 表示

以下示例表示 JSON 格式的 SP.FieldUrl 资源。

    {"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
    }}

实现说明

要更改继承的属性，正文数据中的 type 值可以指定定义字段的父字段类型或继承它的子字段类型。例如，以下正文数据将更改派生自 SP.Field: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }" 的任何字段的 Title 属性。但是，要更改并非继承的属性，必须指定包含属性的字段类型。例如，以下正文数据指定 SP.FieldMultiLineText 类型，因为它也会更改 NumberOfLines 属性："{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"

其他资源