columnDefinition リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
サイト、リスト、または 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 オブジェクトのプロパティを更新します。 |
| columnDefinition を削除する | なし | columnDefinition オブジェクトを削除します。 |
プロパティ
列には、さまざまな種類のデータを保持できます。 次のプロパティは、列に保持されるデータの種類と、そのデータに関する追加の設定を示します。 型関連のプロパティ (ブール値、計算、選択、通貨、dateTime、lookup、number、personOrGroup、text) は相互に排他的です。列には、指定できるプロパティの 1 つだけです。
| プロパティ | 型 | 説明 |
|---|---|---|
| columnGroup | string | サイト列の場合、この列が属するグループの名前。 関連する列を整理するのに役立ちます。 |
| description | string | 列に関するユーザー向けの説明。 |
| displayName | string | 列を示すユーザー向けの名前。 |
| enforceUniqueValues | ブール型 |
true場合、この列に同じ値を持つリスト アイテムが 2 つありません。 |
| hidden | ブール型 | この列がユーザー インターフェイスに表示されるかどうかを指定します。 |
| id | string | 列の一意識別子。 |
| indexed | ブール型 | 列の値を、並べ替えと検索に使用できるかどうかを指定します。 |
| name | string | listItem の fields に表示される、列を示す API 向けの名前。 ユーザー向けの名前については displayName をご覧ください。 |
| readOnly | ブール型 | 列の値を変更できるかどうかを指定します。 |
| required | ブール型 | 列の値が省略可能でないかどうかを指定します。 |
| boolean | booleanColumn | この列にはブール値が格納されます。 |
| calculated | calculatedColumn | この列のデータは、他の列に基づいて計算されます。 |
| choice | choiceColumn | この列には、選択肢リストからのデータが格納されます。 |
| currency | currencyColumn | この列には通貨値が格納されます。 |
| dateTime | dateTimeColumn | この列には日時の値が格納されます。 |
| defaultValue | defaultColumnValue | この列の既定値です。 |
| geolocation | 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 列挙に対応します。 最も一般的なフィールド型は、前の表で表されていることに注意してください。 ただし、このベータ API には、まだいくつかがありません。 そのような場合、どの列タイプ ファセットも入力されず、基本的なプロパティだけが列に含まれます。
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"}
}