columnDefinition resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a column in a site, list or contentType.
By default, columnDefinitions and field values for hidden columns are not shown. To see them when listing columnDefinitions, include hidden in your $select statement. To see them when showing field values on listItems, include the desired columns by name in your $select statement.
Methods
Properties
Columns can hold data of various types. The following properties indicate what type of data a column stores, as well as additional settings for that data. The type-related properties (boolean, calculated, choice, currency, dateTime, lookup, number, personOrGroup, text) are mutually exclusive -- a column can only have one of them specified.
| Property | Type | Description |
|---|---|---|
| columnGroup | string | For site columns, the name of the group this column belongs to. Helps organize related columns. |
| description | string | The user-facing description of the column. |
| displayName | string | The user-facing name of the column. |
| enforceUniqueValues | Boolean | If true, no two list items may have the same value for this column. |
| hidden | Boolean | Specifies whether the column is displayed in the user interface. |
| id | string | The unique identifier for the column. |
| indexed | Boolean | Specifies whether the column values can used for sorting and searching. |
| name | string | The API-facing name of the column as it appears in the fields on a listItem. For the user-facing name, see displayName. |
| readOnly | Boolean | Specifies whether the column values can be modified. |
| required | Boolean | Specifies whether the column value isn't optional. |
| boolean | booleanColumn | This column stores boolean values. |
| calculated | calculatedColumn | This column's data is calculated based on other columns. |
| choice | choiceColumn | This column stores data from a list of choices. |
| currency | currencyColumn | This column stores currency values. |
| dateTime | dateTimeColumn | This column stores DateTime values. |
| defaultValue | defaultColumnValue | The default value for this column. |
| geolocation | geolocationColumn | This column stores a geolocation. |
| lookup | lookupColumn | This column's data is looked up from another source in the site. |
| number | numberColumn | This column stores number values. |
| personOrGroup | personOrGroupColumn | This column stores Person or Group values. |
| text | textColumn | This column stores text values. |
| isDeletable | Boolean | Indicates whether this column can be deleted. |
| propagateChanges | Boolean | If true, changes to this column will be propagated to lists that implement the column. |
| isReorderable | Boolean | Indicates whether values in the column can be reordered. Read-only. |
| isSealed | Boolean | Specifies whether the column can be changed. |
| validation | columnValidation | This column stores validation formula and message for the column. |
| hyperlinkOrPicture | hyperlinkOrPictureColumn | This column stores hyperlink or picture values. |
| term | termColumn | This column stores taxonomy terms. |
| sourceContentType | contentTypeInfo | ContentType from which this column is inherited from. Used only to fetch contentTypes columns. |
| thumbnail | thumbnailColumn | This column stores thumbnail values. |
| type | columnTypes | For site columns, the type of column. Read-only. |
| contentApprovalStatus | contentApprovalStatusColumn | This column stores content approval status. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| sourceColumn | columnDefinition | The source column for content type column. |
Note: These properties correspond to the SharePoint SPFieldType enumeration. Note that the most common field types are represented in the previous table. However, this beta API is still missing some. In those cases, none of the column type facets will be populated, and the column will only have its basic properties.
JSON representation
The following is a JSON representation of the resource.
{
"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"}
}
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for