columndefinition リソースの種類columnDefinition resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

JSON 表記JSON representation

以下は、columndefinition リソースの JSON 表記です。Here is a JSON representation of a columnDefinition resource.

{
  "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" }
}

プロパティ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. 型に関連するプロパティ (boolean、演算、choice、currency、dateTime、lookup、number、個人、グループ、テキスト) は相互に排他的です。1つの列に指定できるのは1つだけです。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 name 種類Type 説明Description
columnGroupcolumnGroup stringstring サイト列の場合、この列が属するグループの名前。For site columns, the name of the group this column belongs to. 関連する列を整理するのに役立ちます。Helps organize related columns.
説明description stringstring 列に関するユーザー向けの説明。The user-facing description of the column.
displayNamedisplayName stringstring 列を示すユーザー向けの名前。The user-facing name of the column.
enforceUniqueValuesenforceUniqueValues booleanboolean True の場合、この列で 2 つのリスト アイテムの値を同じにすることはできません。If true, no two list items may have the same value for this column.
hiddenhidden booleanboolean この列がユーザー インターフェイスに表示されるかどうかを指定します。Specifies whether the column is displayed in the user interface.
idid stringstring 列の一意識別子。The unique identifier for the column.
indexedindexed booleanboolean 列の値を、並べ替えと検索に使用できるかどうかを指定します。Specifies whether the column values can used for sorting and searching.
namename stringstring listItemfields に表示される、列を示す API 向けの名前。The API-facing name of the column as it appears in the fields on a listItem. ユーザー向けの名前については displayName をご覧ください。For the user-facing name, see displayName.
readOnlyreadOnly boolbool 列の値を変更できるかどうかを指定します。Specifies whether the column values can be modified.
requiredrequired booleanboolean 列の値が省略不可であるかどうかを指定します。Specifies whether the column value is not optional.
booleanboolean booleanColumnbooleanColumn この列にはブール値が格納されます。This column stores boolean values.
calculatedcalculated calculatedColumncalculatedColumn この列のデータは、他の列に基づいて計算されます。This column's data is calculated based on other columns.
choicechoice choiceColumnchoiceColumn この列には、選択肢リストからのデータが格納されます。This column stores data from a list of choices.
currencycurrency currencyColumncurrencyColumn この列には通貨値が格納されます。This column stores currency values.
dateTimedateTime dateTimeColumndateTimeColumn この列には日時の値が格納されます。This column stores DateTime values.
defaultValuedefaultValue defaultColumnValuedefaultColumnValue この列の既定値です。The default value for this column.
地理位置情報geolocation geolocationcolumngeolocationColumn この列には、地理位置情報が格納されます。This column stores a geolocation.
lookuplookup lookupColumnlookupColumn この列のデータは、サイト内の別のソースから検索されます。This column's data is looked up from another source in the site.
numbernumber numberColumnnumberColumn この列には数値が格納されます。This column stores number values.
personOrGrouppersonOrGroup personOrGroupColumnpersonOrGroupColumn この列にはユーザーまたはグループの値が格納されます。This column stores Person or Group values.
texttext textColumntextColumn この列にはテキスト値が格納されます。This column stores text values.

注: これらのプロパティは、SharePoint のSPFieldType列挙に対応しています。Note: These properties correspond to SharePoint's SPFieldType enumeration. 最も一般的なフィールドの種類は上記の表で表されていますが、このベータ版 API にはまだ不足しています。While the most common field types are represented in the previous table, 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.

備考Remarks

hidden 列の ColumnDefinitions とフィールドの値は、既定では表示されません。ColumnDefinitions and field values for hidden columns are not shown by default. columnDefinitions を一覧表示するときにこれらが表示されるようにするには、$select ステートメントに hidden を含めます。To see them when listing columnDefinitions, include hidden in your $select statement. listItemsフィールド値を表示するときにこれらが表示されるようにするには、$select ステートメントに目的の列の名前を含めます。To see them when showing field values on listItems, include the desired columns by name in your $select statement.