List リソース

名前空間: microsoft.graph

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

リスト上のタスク

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

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

共通タスク HTTP メソッド
リストを取得する 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}
WebSocket チャネルを取得する GET /lists/{list-id}/subscriptions/socketIo
リスト操作 GET /lists/{list-id}/operations

プロパティ

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

プロパティ名 種類 説明
displayName string リストの表示可能なタイトルです。
list listInfo リストに関する追加の詳細を示します。
system systemFacet 存在する場合は、これがシステム管理のリストであることを示しています。 読み取り専用です。

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

プロパティ名 種類 説明
createdBy identitySet このアイテムの作成者の ID です。 読み取り専用です。
createdDateTime DateTimeOffset アイテムが作成された日時。 読み取り専用です。
説明 string アイテムの説明テキストです。
eTag string アイテムの ETag。
id string アイテムの一意識別子。 読み取り専用です。
name string アイテムの名前。 読み取り専用です。
lastModifiedBy identitySet このアイテムの最終変更者の ID です。 読み取り専用です。
lastModifiedDateTime DateTimeOffset アイテムが最後に変更された日時。 読み取り専用です。
parentReference itemReference 親の情報 (アイテムに親がある場合)。 読み取り/書き込み。
sharepointIds sharepointIds SharePoint REST 互換性に役立つ識別子を返します。 読み取り専用です。
webUrl string (URL) ブラウザーでアイテムを表示する URL。 読み取り専用です。

リレーションシップ

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

リレーションシップ名 種類 説明
columns Collection(columnDefinition) このリストのフィールド定義のコレクションです。
contentTypes Collection(contentType) このリスト内に存在するコンテンツ タイプのコレクションです。
drive drive ドキュメント ライブラリにのみ存在します。 driveItemsdrive リソースとしてリストへのアクセスを許可します。
items Collection(listItem) リストに含まれているすべてのアイテム。
operations richLongRunningOperation コレクション リストに対する実行時間の長い操作のコレクション。
subscriptions Collection(subscription) リストのサブスクリプションのセット。

JSON 表記

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

{
  "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 | accessRequest ..."
  },
  "operations": [ { "@odata.type": "microsoft.graph.richLongRunningOperation" }],
  "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",
  "parentReference": { "@odata.type": "microsoft.graph.itemReference" },
  "sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
  "webUrl": "url to visit the list in a browser"
}