Тип ресурса columnDefinition

Статья
04/18/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Представляет столбец на сайте, в списке или contentType.

По умолчанию значения столбцов и значения полей для hidden столбцов не отображаются. Чтобы увидеть их при перечислении ресурсов columnDefinition, включите параметр hidden в оператор $select. Чтобы увидеть их при отображении значений полей в listItems, добавьте нужные столбцы по имени в инструкцию $select .

Методы

Метод	Тип возвращаемых данных	Описание
Вывод списка столбцов на сайте	Коллекция columnDefinition	Получение списка объектов columnDefinition и их свойств на сайте.
Список столбцов в списке	Коллекция columnDefinition	Получение списка объектов columnDefinition и их свойств в списке.
Вывод списка столбцов в типе контента	Коллекция columnDefinition	Получение списка объектов columnDefinition и их свойств в типе контента.
Создание columnDefinition для сайта	columnDefinition	Создайте объект columnDefinition на сайте.
Создание columnDefinition для списка	columnDefinition	Создайте объект columnDefinition в списке.
Создание columnDefinition для типа контента	columnDefinition	Создайте объект columnDefinition в типе контента.
Получение columnDefinition	columnDefinition	Чтение свойств и связей объекта columnDefinition .
Обновление columnDefinition	columnDefinition	Обновление свойств объекта columnDefinition .
Удаление columnDefinition	Нет	Удаление объекта columnDefinition .

Свойства

В столбцах могут храниться данные различных типов. Перечисленные ниже свойства указывают тип данных, которые хранятся в столбце, а также дополнительные параметры этих данных. Свойства, связанные с типами (логическое, вычисляемое, выбор, валюта, dateTime, подстановка, число, personOrGroup, текст) являются взаимоисключающими. В столбце может быть указан только один из них.

Свойство	Тип	Описание
columnGroup	строка	Для столбцов сайтов это имя группы, к которой принадлежит данный столбец. Помогает упорядочивать связанные столбцы.
description	строка	Описание столбца, которое видит пользователь.
displayName	строка	Имя столбца, которое видит пользователь.
enforceUniqueValues	Логический	Если `true`задано значение , ни один из двух элементов списка не может иметь одинаковое значение для этого столбца.
hidden	Логический	Указывает, отображается ли столбец в пользовательском интерфейсе.
id	string	Уникальный идентификатор столбца.
indexed	Логический	Указывает, можно ли использовать значения столбцов для сортировки и поиска.
name	строка	Используемое в API имя столбца из свойства fields объекта listItem. Имя, которое видит пользователь, указывается в свойстве displayName.
readOnly	Логический	Указывает, можно ли менять значения в столбце.
required	Логический	Указывает, является ли значение столбца необязательным.
boolean	booleanColumn	В этом столбце хранятся логические значения.
calculated	calculatedColumn	Данные в этом столбце вычисляются относительно других столбцов.
choice	choiceColumn	В этом столбце хранятся данные из списка вариантов.
currency	currencyColumn	В этом столбце хранятся денежные значения.
dateTime	dateTimeColumn	В этом столбце хранятся значения даты и времени.
defaultValue	defaultColumnValue	Значение по умолчанию для этого столбца.
Географического расположения	geolocationColumn	В этом столбце хранится географическое расположение.
lookup	lookupColumn	Данные в этом столбце берутся из другого источника на сайте.
number	numberColumn	В этом столбце хранятся числовые значения.
personOrGroup	personOrGroupColumn	В этом столбце хранятся значения людей или групп.
text	textColumn	В этом столбце хранятся текстовые значения.
isDeletable	Логический	Указывает, можно ли удалить этот столбец.
propagateChanges	Логический	Если `true`задано значение , изменения этого столбца будут распространяться в списки, реализующие столбец.
isReorderable	Логический	Указывает, можно ли изменить порядок значений в столбце. Только для чтения.
isSealed	Логический	Указывает, можно ли изменить столбец.
Проверки	columnValidation	В этом столбце хранятся формула проверки и сообщение для столбца.
hyperlinkOrPicture	hyperlinkOrPictureColumn	В этом столбце хранятся значения гиперссылок или рисунков.
Термин	termColumn	В этом столбце хранятся термины таксономии.
sourceContentType	contentTypeInfo	ContentType, от которого наследуется этот столбец. Используется только для получения столбцов contentTypes.
thumbnail	thumbnailColumn	В этом столбце хранятся значения эскизов.
type	columnTypes	Для столбцов сайта — тип столбца. Только для чтения.
contentApprovalStatus	contentApprovalStatusColumn	В этом столбце хранится состояние утверждения содержимого.

Связи

Связь	Тип	Описание
sourceColumn	columnDefinition	Исходный столбец для столбца типа контента.

Примечание: Эти свойства соответствуют перечислению SharePoint SPFieldType . Обратите внимание, что наиболее распространенные типы полей представлены в предыдущей таблице. Однако некоторые из этих бета-версий API по-прежнему отсутствуют. При использовании этих типов не заполняются никакие аспекты типа столбца, а сам столбец обладает только основными свойствами.

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

Ниже указано представление ресурса в формате JSON.

{
  "boolean": {"@odata.type": "microsoft.graph.booleanColumn"},
  "calculated": {"@odata.type": "microsoft.graph.calculatedColumn"},
  "choice": {"@odata.type": "microsoft.graph.choiceColumn"},
  "columnGroup": "String",
  "contentApprovalStatus": {"@odata.type": "microsoft.graph.contentApprovalStatusColumn"},
  "currency": {"@odata.type": "microsoft.graph.currencyColumn"},
  "dateTime": {"@odata.type": "microsoft.graph.dateTimeColumn"},
  "defaultValue": {"@odata.type": "microsoft.graph.defaultColumnValue"},
  "description": "String",
  "displayName": "String",
  "enforceUniqueValues": "Boolean",
  "geolocation": {"@odata.type": "microsoft.graph.geolocationColumn"},
  "hidden": "Boolean",
  "hyperlinkOrPicture": {"@odata.type": "microsoft.graph.hyperlinkOrPictureColumn"},
  "id": "String (identifier)",
  "indexed": "Boolean",
  "isDeletable": "Boolean",
  "isReorderable": "Boolean",
  "isSealed": "Boolean",
  "lookup": {"@odata.type": "microsoft.graph.lookupColumn"},
  "name": "staticNameForApi",
  "number": {"@odata.type": "microsoft.graph.numberColumn"},
  "personOrGroup": {"@odata.type": "microsoft.graph.personOrGroupColumn"},
  "propagateChanges": "Boolean",
  "readOnly": "Boolean",
  "required": "Boolean",
  "sourceContentType": {"@odata.type": "microsoft.graph.contentTypeInfo"},
  "term": {"@odata.type": "microsoft.graph.termColumn"},
  "text": {"@odata.type": "microsoft.graph.textColumn"},
  "thumbnail": {"@odata.type": "microsoft.graph.thumbnailColumn"},
  "type": {"@odata.type": "microsoft.graph.columnTypes"},
  "validation": {"@odata.type": "microsoft.graph.columnValidation"}
}