List リソース

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

list リソースは [site][] 内のリストを表します。 このリソースには、テンプレートとフィールドの定義を含め、リストの最上位レベルのプロパティが含まれています。

リスト上のタスク

list リソースで使用可能なタスクを次に示します。

以下の例はすべて、https://graph.microsoft.com/beta/sites/{site-id} などのサイトに対する相対指定です。

共通タスク	HTTP メソッド
サイト内のリストを取得する	GET /sites/{site-id}/lists
リストを作成する	投稿 /リスト
リストを取得する	GET /lists/{list-id}
リスト アイテムを列挙する	GET /lists/{list-id}/items
リスト アイテムを更新する	PATCH /lists/{list-id}/items/{item-id}
リスト アイテムを削除する	DELETE /lists/{list-id}/items/{item-id}
リスト アイテムを作成する	POST /lists/{list-id}
最近のアクティビティを取得する	GET /lists/{list-id}/activities
WebSocket チャネルを取得する	GET /lists/{list-id}/subscriptions/socketIo
コンテンツ タイプを一覧表示する	GET /lists/{list-id}/contentTypes
サイトからコンテンツ タイプのコピーを追加する	POST /lists/{list-id}/contentTypes/addCopy
列を一覧表示する	GET /lists/{list-id}/columns
列を作成する	POST /lists/{list-id}/columns
リスト操作	GET /lists/{list-id}/operations

プロパティ

list リソースには以下のプロパティがあります。

プロパティ	型	説明
columns	Collection(columnDefinition)	このリストのフィールド定義のコレクションです。
contentTypes	Collection(contentType)	このリスト内に存在するコンテンツ タイプのコレクションです。
displayName	string	リストの表示可能なタイトルです。
list	listInfo	リストに関する追加の詳細を示します。
system	systemFacet	存在する場合は、これがシステム管理対象のリストであることを示しています。

次のプロパティは、baseItem から継承しています。

プロパティ名	種類	説明
id	string	アイテムの一意識別子。読み取り専用です。
name	string	アイテムの名前。
createdBy	identitySet	このアイテムの作成者の ID です。読み取り専用です。
createdDateTime	DateTimeOffset	アイテムが作成された日時。読み取り専用です。
説明	string	アイテムの説明テキストです。
lastModifiedBy	identitySet	このアイテムの最終変更者の ID です。読み取り専用です。
lastModifiedDateTime	DateTimeOffset	アイテムが最後に変更された日時。読み取り専用です。
webUrl	string (URL)	ブラウザーでアイテムを表示する URL。読み取り専用です。

リレーションシップ

list リソースには、他のリソースと次のような関係があります。

リレーションシップ	型	説明
activities	itemActivity コレクション	このリスト内で行われた最近のアクティビティです。
drive	drive	ドキュメント ライブラリにのみ存在します。driveItems で drive リソースとしてリストへのアクセスを許可します。
items	Collection(listItem)	リストに含まれているすべてのアイテム。
subscriptions	subscription コレクション	リストのサブスクリプションのセット。
operations	richLongRunningOperation コレクション	リストの実行時間の長い操作のコレクション。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
  "columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
  "contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
  "displayName": "title of list",
  "drive": { "@odata.type": "microsoft.graph.drive" },
  "items": [ { "@odata.type": "microsoft.graph.listItem" } ],
  "list": {
    "@odata.type": "microsoft.graph.listInfo",
    "hidden": false,
    "template": "documentLibrary | genericList | survey | links | announcements | contacts ..."
  },
  "system": false,
  "subscriptions": [ {"@odata.type": "microsoft.graph.subscription"} ],

  /* inherited from baseItem */
  "id": "string",
  "name": "name of list",
  "createdBy": { "@odata.type": "microsoft.graph.identitySet" },
  "createdDateTime": "timestamp",
  "description": "description of list",
  "eTag": "string",
  "lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" },
  "lastModifiedDateTime": "timestamp",
  "webUrl": "url to visit the list in a browser"
}