columnDefinition リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
サイト、リスト、または contentType [の][][列][]を[表します][]。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| サイト内の列を一覧表示する | columnDefinition コレクション | サイト内の columnDefinition オブジェクトとそのプロパティの一覧を取得 します。 |
| リスト内の列を一覧表示する | columnDefinition コレクション | リスト内の columnDefinition オブジェクトとそのプロパティの一覧を取得 します。 |
| コンテンツ タイプの列を一覧表示する | columnDefinition コレクション | コンテンツ タイプの columnDefinition オブジェクトとそのプロパティの一覧を 取得します。 |
| サイトの columnDefinition を作成する | columnDefinition | サイトに 新しい columnDefinition オブジェクトを作成 します。 |
| リストの columnDefinition を作成する | columnDefinition | リストに 新しい columnDefinition オブジェクトを作成 します。 |
| コンテンツ タイプの columnDefinition を作成する | columnDefinition | コンテンツ タイプに 新しい columnDefinition オブジェクトを 作成します。 |
| Get columnDefinition | columnDefinition | columnDefinition オブジェクトのプロパティとリレーションシップ を読み取 る。 |
| ColumnDefinition の更新 | columnDefinition | columnDefinition オブジェクトのプロパティを更新します。 |
| Delete columnDefinition | なし | columnDefinition オブジェクトを削除します。 |
プロパティ
列には、さまざまな種類のデータを保持できます。 次のプロパティは、列に保持されるデータの種類と、そのデータに関する追加の設定を示します。 型関連のプロパティ (ブール型、計算済み、選択肢、通貨、dateTime、ルックアップ、数値、personOrGroup、テキスト) は相互に排他的です。列には、指定できるプロパティの 1 つのみを指定できます。
| プロパティ | 型 | 説明 |
|---|---|---|
| columnGroup | string | サイト列の場合、この列が属するグループの名前。 関連する列を整理するのに役立ちます。 |
| 説明 | string | 列に関するユーザー向けの説明。 |
| displayName | string | 列を示すユーザー向けの名前。 |
| enforceUniqueValues | Boolean | 場合 trueは、この列の 2 つのリスト アイテムが同じ値を持つ可能性があります。 |
| hidden | Boolean | この列がユーザー インターフェイスに表示されるかどうかを指定します。 |
| id | string | 列の一意識別子。 |
| indexed | ブール値 | 列の値を、並べ替えと検索に使用できるかどうかを指定します。 |
| name | string | listItem の fields に表示される、列を示す API 向けの名前。 ユーザー向けの名前については displayName をご覧ください。 |
| readOnly | Boolean | 列の値を変更できるかどうかを指定します。 |
| required | Boolean | 列の値が省略可能かどうかを指定します。 |
| boolean | booleanColumn | この列にはブール値が格納されます。 |
| calculated | calculatedColumn | この列のデータは、他の列に基づいて計算されます。 |
| choice | choiceColumn | この列には、選択肢リストからのデータが格納されます。 |
| currency | currencyColumn | この列には通貨値が格納されます。 |
| dateTime | dateTimeColumn | この列には日時の値が格納されます。 |
| defaultValue | defaultColumnValue | この列の既定値です。 |
| 地理位置情報 | geolocationColumn | この列には位置情報が格納されます。 |
| lookup | lookupColumn | この列のデータは、サイト内の別のソースから検索されます。 |
| number | numberColumn | この列には数値が格納されます。 |
| personOrGroup | personOrGroupColumn | この列にはユーザーまたはグループの値が格納されます。 |
| text | textColumn | この列にはテキスト値が格納されます。 |
| isDeletable | Boolean | この列を削除できるかどうかを示します。 |
| propagateChanges | ブール値 | 場合 trueは、この列に対する変更は、列を実装するリストに反映されます。 |
| isReorderable | ブール値 | 列の値を並べ替え可能かどうかを示します。 読み取り専用です。 |
| isSealed | Boolean | 列を変更できるかどうかを指定します。 |
| 検証 | columnValidation | この列には、列の検証式とメッセージが格納されます。 |
| hyperlinkOrPicture | hyperlinkOrPictureColumn | この列には、ハイパーリンクまたは画像の値が格納されます。 |
| 用語 | termColumn | この列には分類用語が格納されます。 |
| sourceContentType | contentTypeInfo | この列の継承元の ContentType。 contentTypes 列をフェッチする場合にのみ使用します。 |
| thumbnail | thumbnailColumn | この列には、サムネイル値が格納されます。 |
| type | columnTypes | サイト列の場合は、列の種類を指定します。 読み取り専用です。 |
| contentApprovalStatus | contentApprovalStatusColumn | この列には、コンテンツ承認の状態が格納されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| sourceColumn | columnDefinition | コンテンツ タイプ列のソース列。 |
注: これらのプロパティは、SPFieldType 列挙SharePoint対応します。 最も一般的なフィールドの種類は、前の表で表されます。 ただし、このベータ版 API にはまだいくつかがありません。 そのような場合、どの列タイプ ファセットも入力されず、基本的なプロパティだけが列に含まれます。
JSON 表記
columnDefinition リソースの JSON 表記を次に示します。
{
"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" },
"isDeletable" : false,
"propagateChanges": false,
"isReorderable": false,
"isSealed": false,
"validation": { "@odata.type": "microsoft.graph.columnValidation" },
"hyperlinkOrPicture": { "@odata.type": "microsoft.graph.hyperlinkOrPictureColumn" },
"term": { "@odata.type": "microsoft.graph.termColumn" },
"sourceContentType": { "@odata.type": "microsoft.graph.contentTypeInfo" },
"thumbnail": { "@odata.type": "microsoft.graph.thumbnailColumn" },
"type": { "@odata.type": "microsoft.graph.columnTypes" },
"contentApprovalStatus": { "@odata.type": "microsoft.graph.contentApprovalStatusColumn" }
}
備考
hidden 列の ColumnDefinitions とフィールドの値は、既定では表示されません。
columnDefinitions を一覧表示するときにこれらが表示されるようにするには、$select ステートメントに hidden を含めます。
listItems の フィールド 値を表示するときにこれらが表示されるようにするには、$select ステートメントに目的の列の名前を含めます。
フィードバック
フィードバックの送信と表示