columnDefinition 资源类型
命名空间:microsoft.graph
表示 网站、 列表或 contentType 中的列。
默认情况下,不显示 列的hidden
columnDefinitions 和字段值。 若要列出隐藏 的 columnDefinitions,请在 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 对象的属性。 |
Delete columnDefinition | None | 删除 columnDefinition 对象。 |
属性
列可以包含各种类型的数据。 以下属性表示列存储的数据类型以及该数据的其他设置。 类型相关的属性 (布尔值、calculated、choice、currency、dateTime、lookup、number、personOrGroup、text、term、hyperlinkOrPicture、thumbnail 和 contentApprovalStatus) 是相互排斥的:列只能指定其中一个列。
属性名称 | 类型 | 说明 |
---|---|---|
boolean | booleanColumn | 此列存储布尔值。 |
calculated | calculatedColumn | 根据其他列计算此列的数据。 |
choice | choiceColumn | 此列存储所选列表中的数据。 |
columnGroup | string | 对于网站列,此列所属的组的名称。 可以帮助组织相关的列。 |
contentApprovalStatus | contentApprovalStatusColumn | 此列存储内容审批状态。 |
currency | currencyColumn | 此列存储货币值。 |
dateTime | dateTimeColumn | 此列存储日期时间值。 |
defaultValue | defaultColumnValue | 此列的默认值。 |
说明 | string | 面向用户的列描述。 |
displayName | string | 面向用户的列名称。 |
enforceUniqueValues | 布尔值 | 如果 true 为 ,则没有两个列表项对此列具有相同的值。 |
地理位置 | geolocationColumn | 此列存储地理位置。 |
hidden | 布尔值 | 指定列是否显示在用户界面中。 |
hyperlinkOrPicture | hyperlinkOrPictureColumn | 此列存储超链接或图片值。 |
isDeletable | 布尔值 | 指示是否可以删除此列。 |
isReorderable | 布尔值 | 指示是否可以对列中的值重新排序。 只读。 |
id | string | 列的唯一标识符。 |
indexed | 布尔值 | 指定列值是否可用于排序和搜索。 |
isSealed | 布尔值 | 指定是否可以更改列。 |
lookup | lookupColumn | 从网站中的另一个源查找此列的数据。 |
名称 | string | 在 listItem 上的 fields 中显示的面向 API 的列名称。 对于面向用户的名称,请参阅 displayName。 |
number | numberColumn | 此列存储数值。 |
personOrGroup | personOrGroupColumn | 此列存储个人或组值。 |
propagateChanges | 布尔值 | 如果为“true”,则对此列的更改将传播到实现该列的列表。 |
readOnly | 布尔值 | 指定是否可以修改列值。 |
required | 布尔值 | 指定列值是否不是可选的。 |
sourceContentType | contentTypeInfo | 从中继承此列的 ContentType。 仅在 contentTypes 列响应中显示。 只读。 |
术语 | termColumn | 此列存储分类术语。 |
text | textColumn | 此列存储文本值。 |
thumbnail | thumbnailColumn | 此列存储缩略图值。 |
type | columnTypes | 对于网站栏,为列的类型。 只读。 |
验证 | columnValidation | 此列存储列的验证公式和消息。 |
关系
属性名称 | 类型 | 说明 |
---|---|---|
sourceColumn | columnDefinition | 内容类型列的源列。 |
注意: 这些属性对应于 SharePoint SPFieldType 枚举。 请注意,最常见的字段类型在上表中表示。 但是,此 API 仍然缺少一些。 在这些情况下,不会填充列类型 facet,列将仅具有其基本属性。 网站和列表列响应将不包含 isDeletable、 propagateChanges、 isReorderable、 isSealed、 validation、 hyperlinkOrPicture、 term、 sourceContentType、 thumbnail、 type、 contentApprovalStatus 和 sourceColumn 属性。
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" },
"readOnly": "Boolean",
"required": "Boolean",
"propagateChanges": "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" }
}