columnDefinition 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示 网站、 列表 或 contentType 中的列。
默认情况下，不显示 列的hidden columnDefinitions 和字段值。 若要在列出 columnDefinitions 时看到这些内容，请在 $select 语句中添加 hidden。 若要在 listItems 上显示字段值时看到它们，请在$select语句中按名称添加所需的列。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 列出网站中的列 | columnDefinition 集合 | 获取网站中 columnDefinition 对象及其属性的列表。 |
| 列出列表中的列 | columnDefinition 集合 | 在列表中获取 columnDefinition 对象及其属性 的列表。 |
| 列出内容类型中的列 | columnDefinition 集合 | 获取内容类型中的 columnDefinition 对象及其属性的列表。 |
| 为网站创建 columnDefinition | columnDefinition | 在网站中创建新的 columnDefinition 对象。 |
| 为列表创建 columnDefinition | columnDefinition | 在列表中创建新的 columnDefinition 对象。 |
| 为内容类型创建 columnDefinition | columnDefinition | 在内容类型中创建新的 columnDefinition 对象。 |
| 获取 columnDefinition | columnDefinition | 读取 columnDefinition 对象的属性和关系。 |
| 更新 columnDefinition | columnDefinition | 更新 columnDefinition 对象的属性。 |
| Delete columnDefinition | None | 删除 columnDefinition 对象。 |
属性
列可以包含各种类型的数据。 以下属性表示列存储的数据类型以及该数据的其他设置。 与类型相关的属性 (布尔值、calculated、choice、currency、dateTime、lookup、number、personOrGroup、text) 是相互排斥的 -- 一列只能指定其中一个属性。
| 属性 | 类型 | 说明 |
|---|---|---|
| columnGroup | string | 对于网站列，此列所属的组的名称。 可以帮助组织相关的列。 |
| description | string | 面向用户的列描述。 |
| displayName | string | 面向用户的列名称。 |
| enforceUniqueValues | 布尔值 | 如果 true为 ，则没有两个列表项对此列具有相同的值。 |
| hidden | 布尔值 | 指定列是否显示在用户界面中。 |
| id | string | 列的唯一标识符。 |
| indexed | 布尔值 | 指定列值是否可用于排序和搜索。 |
| name | string | 在 listItem 上的 fields 中显示的面向 API 的列名称。 对于面向用户的名称，请参阅 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 枚举。 请注意，最常见的字段类型在上表中表示。 但是，此 beta API 仍然缺少一些。 在这些情况下，不会填充列类型 facet，列将仅具有其基本属性。
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"}
}