columnDefinition 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示网站、 [列表或][] contentType 中的 [列][]。

方法

方法	返回类型	说明
列出网站中的列	columnDefinition 集合	获取网站中的 columnDefinition 对象及其属性 的列表。
列出列表中的列	columnDefinition 集合	获取 list 中的 columnDefinition 对象及其属性 的列表。
列出内容类型中的列	columnDefinition 集合	获取内容类型 中的 columnDefinition 对象及其 属性的列表。
为网站创建 columnDefinition	columnDefinition	在网站 中创建新的 columnDefinition 对象。
为列表创建 columnDefinition	columnDefinition	在列表中 创建新的 columnDefinition 对象。
为内容类型创建 columnDefinition	columnDefinition	在内容 类型中创建新的 columnDefinition 对象。
获取 columnDefinition	columnDefinition	读取 columnDefinition 对象的属性和 关系。
更新 columnDefinition	columnDefinition	更新 columnDefinition 对象 的属性。
删除 columnDefinition	无	删除 columnDefinition 对象。

属性

列可以包含各种类型的数据。 以下属性表示列存储的数据类型以及该数据的其他设置。 与类型相关的属性 (布尔值、计算值、选项、货币、dateTime、lookup、number、personOrGroup、text) 相互排斥 - 列只能指定其中一个。

属性	类型	说明
columnGroup	string	对于网站列，此列所属的组的名称。 可以帮助组织相关的列。
说明	string	面向用户的列描述。
displayName	string	面向用户的列名称。
enforceUniqueValues	Boolean	如果 true为 ，则没有两个列表项对此列具有相同的值。
hidden	Boolean	指定列是否显示在用户界面中。
id	string	列的唯一标识符。
indexed	Boolean	指定列值是否可用于排序和搜索。
name	string	在 listItem 上的 fields 中显示的面向 API 的列名称。 对于面向用户的名称，请参阅 displayName。
readOnly	Boolean	指定是否可以修改列值。
required	Boolean	指定列值是否可选。
boolean	booleanColumn	此列存储布尔值。
calculated	calculatedColumn	根据其他列计算此列的数据。
choice	choiceColumn	此列存储所选列表中的数据。
currency	currencyColumn	此列存储货币值。
dateTime	dateTimeColumn	此列存储日期时间值。
defaultValue	defaultColumnValue	此列的默认值。
地理位置	geolocationColumn	此列存储地理位置。
lookup	lookupColumn	从网站中的另一个源查找此列的数据。
number	numberColumn	此列存储数值。
personOrGroup	personOrGroupColumn	此列存储个人或组值。
text	textColumn	此列存储文本值。
isDeletable	Boolean	指示是否可以删除此列。
propagateChanges	Boolean	如果 true为 ，则对此列所做的更改将传播到实现该列的列表。
isReorderable	Boolean	指示是否可以对列中的值进行重新排序。 只读。
isSealed	Boolean	指定是否可以更改列。
validation	columnValidation	此列存储该列的验证公式和消息。
hyperlinkOrPicture	hyperlinkOrPictureColumn	此列存储超链接或图片值。
term	termColumn	此列存储分类术语。
sourceContentType	contentTypeInfo	从其继承此列的 ContentType。 仅用于提取 contentTypes 列。
thumbnail	thumbnailColumn	此列存储缩略图值。
type	columnTypes	对于网站栏，列的类型。 只读。
contentApprovalStatus	contentApprovalStatusColumn	此列存储内容审批状态。

关系

关系	类型	说明
sourceColumn	columnDefinition	内容类型列的源列。

注意： 这些属性对应于 [SPFieldType SharePoint枚举][]。 请注意，最常见的字段类型在上表中表示。 但是，此 beta API 仍然缺少一些。 在这些情况下，不会填充列类型 facet，列将仅具有其基本属性。

JSON 表示形式

下面是 columnDefinition 资源的 JSON 表示形式。

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

备注

默认情况下，不显示 hidden 列的 ColumnDefinitions 和字段值。 若要在列出 columnDefinitions 时看到这些内容，请在 $select 语句中添加 hidden。 若要在 listItems 上显示 字段 值时看到这些内容，请在 $select 语句中添加名称所需的列。