Справочные материалы по интерфейсу API службы REST для полей

Статья
09/29/2016

Ознакомьтесь с ресурсами и конечными точками API REST SharePoint, связанными с полями.

Дата последнего изменения: 9 марта 2015 г.

Область применения: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

О примерах запросов в этой статье

В примерах в этой статье используются запросы jQuery AJAX. Выполните следующие действия, прежде чем пытаться использовать примеры:

Замените <URL-адрес сайта> и другие заполнители, такие как идентификаторы, имена или пути объектов SharePoint.

Если вы используете междоменную библиотеку, необходимо изменить формат запроса. Например, он может выглядеть следующим образом.

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.

Ресурс Field

URI конечной точки | Свойства | Методы | Представление OData

Представляет поле в списке SharePoint.

URI конечной точки

http://<URL-адрес сайта>/_api/web/fields('<идентификатор поля>')
http://<URL-адрес сайта>/_api/web/lists(guid'<идентификатор поля>')/fields('<идентификатор поля>')

Поддерживаемые методы 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
});

Или же можно использовать метод GetByTitle ресурса FieldCollection, чтобы получить поле по его заголовку (он чувствителен к регистру). Пример: …/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
});

Свойства Field

Чтобы получить свойство, отправьте запрос 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	Да	Получает или задает значение, указывающее значение поля по умолчанию.
Описание	String	RW	Да	Получает или задает значение, указывающее описание поля.
Direction	String	RW	Да	Получает или задает значение, указывающее порядок чтения поля.
EnforceUniqueValues	Boolean	RW	Да	Получает или задает значение, указывающее, требуется ли уникальность значений полей в столбце списка или библиотеки.
EntityPropertyName	String	R	Да	Получает имя свойства сущности элемента списка, использующей это поле.
FieldTypeKind	Int32	RW	Да	Получает или задает значение, указывающее тип поля. Представляет значение FieldType. Список значений типов полей см. в описании FieldType в справочнике по клиентской объектной модели .NET.
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	Да	Получает или задает значение, которое указывает сообщение об ошибке, возвращаемое при сбое проверки данных в поле.

Методы Field

DeleteObject
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Метод DeleteObject

Рекомендуемый способ удалить поле — отправить запрос DELETE в конечную точку ресурса Field, как показано в разделе Примеры запросов Field.

Метод SetShowInDisplayForm

Задает значение свойства ShowInDisplayForm для данного поля.

Конечная точка	/setshowindisplayform(<логическое значение>)
Параметры	Тип: 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 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 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

В следующем примере ресурс Field представлен в формате JSON.

    {"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-запросов

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

Или же можно использовать метод GetByInternalNameOrTitle или GetByTitle ресурса FieldCollection, чтобы получить поле по его заголовку (он чувствителен к регистру). Пример: …/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. Список значений типов полей см. в описании FieldType в справочнике по клиентской объектной модели .NET.

Методы FieldCalculated

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldCalculated представлен в формате JSON.

    {"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'<идентификатор поля>')/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
});

Или же можно использовать метод GetByTitle или GetByInternalNameOrTitle ресурса FieldCollection, чтобы получить поле по его заголовку (он чувствителен к регистру). Пример: …/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
});

$.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 Идентификатор поля подстановки для связи с этим зависимым полем подстановки. 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
});

Или же можно добавить поле, отправив запрос POST конечной точке ресурса FieldCollection, как показано в разделе Примеры запросов 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
});

Метод GetById

Получает поле с указанным идентификатором.

Конечная точка	/getbyid('<идентификатор поля>')
Параметры	Тип: String Идентификатор поля.
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
});

Или же можно передать идентификатор поля ресурсу 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

В следующем примере ресурс FieldCollection представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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	Возвращено с ресурсом	Описание
В разделе Свойства Field описываются свойства, наследуемые от SP.Field.
EnableLookup	Boolean	RW	Да	Получает или задает значение, указывающее, может ли поле подстановки ссылаться на это поле.

Методы FieldComputed

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldComputed представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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	Возвращено с ресурсом	Описание
В разделе Свойства Field описываются свойства, наследуемые от SP.Field.
DateTimeCalendarType	Int32	RW	Да	Получает или задает значение, указывающее тип календаря поля. Представляет значение CalendarType: григорианский (локализованный) = 1, летоисчисление по правлениям японских императоров = 3, тайваньский календарь = 4, эра Тангун (корейский) = 5, Хиджра (арабский лунный) = 6, тайский = 7, еврейский лунный = 8, григорианский ближневосточный календарь (французский) = 9, григорианский (арабский) = 10, григорианский (транслитерированный английский) = 11, григорианский (транслитерированный французский) = 12, корейский и японский лунный = 14, китайский лунный = 15, эра Сака = 16.
DisplayFormat	Int32	RW	Да	Получает или устанавливает формат даты и времени, отображаемых в поле. Представляет значение DateTimeFieldFormatType: DateOnly = 0, DateTime = 1.
FriendlyDisplayFormat	Int32	RW	Да	Представляет значение DateTimeFieldFriendlyFormat: не указано = 0, отключено (стандартный абсолютный) = 1, относительный (стандартный понятный относительный) = 2.

Методы FieldDateTime

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldDateTime представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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

В следующем примере ресурс SP.FieldGeolocation представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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

В следующем примере ресурс SP.FieldGuid представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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, если поле представляет вторичный столбец в подстановке из нескольких столбцов. Вторичные столбцы не обнаруживаются из исходного списка. Дополнительные сведения об этом свойстве см. в описании IsRelationship в справочнике по клиентской объектной модели .NET.
LookupField	String	RW	Да	Получает или задает значение, которое указывает внутреннее имя поля, используемого для значений подстановки.
LookupList	String	RW	Да	Получает или задает значение, указывающее идентификатор списка, который содержит поле, используемое в качестве значений подстановки.
LookupWebId	GUID	RW	Да	Получает или задает идентификатор веб-сайта, содержащего список, который является источником значения данного поля.
Presence*	Boolean	RW	Да	Получает или задает значение, указывающее, включено ли для поля присутствие. * Применимо только к FieldUser.
PrimaryFieldId	String	RW	Да	Получает или задает значение, указывающее идентификатор основного поля подстановки, если это зависимое поле. В противном случае это пустая строка.
RelationshipDeleteBehavior	Int32	RW	Да	Получает или задает значение, указывающее поведение поля подстановки при удалении. Представляет значение RelationshipDeleteBehaviorType: нет = 0, каскад = 1, ограничение = 2. Дополнительные сведения об этом свойстве см. в описании RelationshipDeleteBehavior в справочнике по клиентской объектной модели .NET.
SelectionGroup*	Int32	RW	Да	Получает или задает значение, указывающее идентификатор группы SharePoint, члены которой можно выбирать в качестве значений поля. * Применимо только к FieldUser.
SelectionMode*	Int32	RW	Да	Получает или задает значение, указывающее, можно ли выбирать пользователей и группы либо же только пользователей. Представляет значение FieldUserSelectionMode: PeopleOnly = 0, PeopleAndGroups = 1. * Применимо только к FieldUser.

Методы FieldLookup и FieldUser

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldLookup представлен в формате JSON.

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

В следующем примере ресурс SP.FieldUser представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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

В следующем примере ресурс SP.FieldMultiChoice представлен в формате JSON.

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

В следующем примере ресурс SP.FieldChoice представлен в формате JSON.

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

В следующем примере ресурс SP.FieldRatingScale представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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	Да	Получает значение, указывающее, поддерживается ли зависящий от реализации механизм связывания вики-страниц.

Методы FieldMultiLineText

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldMultiLineText представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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	Да	Получает или задает значение, указывающее код языка для форматирования значения поля. См. список региональных идентификаторов. * Применимо только к FieldCurrency.
MaximumValue	Double	RW	Да	Получает или задает значение, указывающее минимальное значение поля.
MinimumValue	Double	RW	Да	Получает или задает значение, указывающее минимальное значение поля.

Методы FieldNumber и FieldCurrency

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldNumber представлен в формате JSON.

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

В следующем примере ресурс SP.FieldCurrency представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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

В следующем примере ресурс SP.FieldText представлен в формате JSON.

    {"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-запросов

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

Пример запроса 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: гиперссылка = 0, изображение = 1.

Методы FieldUrl

Методы наследуются от объекта SP.Field.

DeleteObject (или отправьте запрос DELETE конечной точке поля)
SetShowInDisplayForm
SetShowInEditForm
SetShowInNewForm

Представление OData

В следующем примере ресурс SP.FieldUrl представлен в формате JSON.

    {"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 в данных текста запроса можно указать тип родительского поля, которое определяет поле, или тип дочернего поля, которое наследует его. Например, следующие данные меняют свойство Title для любого поля, производного от SP.Field: "{ '__metadata': { 'type': 'SP.Field' }, 'Title': 'Comments' }". Однако чтобы изменить ненаследуемое поле, необходимо указать тип поля, содержащий свойство. Например, следующие данные задают тип SP.FieldMultiLineText, так как также меняется и свойство NumberOfLines: "{ '__metadata': { 'type': 'SP.FieldMultiLineText' }, 'Title': 'Comments', 'NumberOfLines': 6 }"