List リソースList resource

重要

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.

list リソースは site 内のリストを表します。The list resource represents a list in a site. このリソースには、テンプレートとフィールドの定義を含め、リストの最上位レベルのプロパティが含まれています。This resource contains the top level properties of the list, including template and field definitions.

リスト上のタスクTasks on a list

list リソースで使用可能なタスクを次に示します。The following tasks are available for list resources. 注: このベータ版では、リスト上の移動だけが可能であり、リストの作成や更新はできません。Note: This beta only allows navigating lists, not creating or updating them. ただし、[リスト アイテム]の listItem の作成または更新は可能です。You can, however, create or update list items.

以下のすべての例は、https://graph.microsoft.com/beta/sites/{site-id} などのサイトからの相対指定です。All examples below are relative to a site, eg: https://graph.microsoft.com/beta/sites/{site-id}.

共通タスクCommon task HTTP メソッドHTTP method
リストを取得するGet list GET /lists/{list-id}GET /lists/{list-id}
リスト アイテムを列挙するEnumerate list items GET /lists/{list-id}/itemsGET /lists/{list-id}/items
リスト アイテムを更新するUpdate list item PATCH /lists/{list-id}/items/{item-id}PATCH /lists/{list-id}/items/{item-id}
リスト アイテムを削除するDelete list item DELETE /lists/{list-id}/items/{item-id}DELETE /lists/{list-id}/items/{item-id}
リスト アイテムを作成するCreate list item POST /lists/{list-id}POST /lists/{list-id}
最近のアクティビティを取得するGet recent activities GET /lists/{list-id}/activitiesGET /lists/{list-id}/activities

JSON 表記JSON representation

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

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

  /* 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"
}

プロパティProperties

list リソースには以下のプロパティがあります。The list resource has the following properties.

プロパティ名Property name 種類Type 説明Description
columnscolumns Collection(columnDefinition)Collection(columnDefinition) このリストのフィールド定義のコレクションです。The collection of field definitions for this list.
contentTypescontentTypes Collection(contentType)Collection(contentType) このリスト内に存在するコンテンツ タイプのコレクションです。The collection of content types present in this list.
displayNamedisplayName stringstring リストの表示可能なタイトルです。The displayable title of the list.
listlist listInfolistInfo リストに関する追加の詳細を示します。Provides additional details about the list.
systemsystem systemFacetsystemFacet 存在する場合は、これがシステム管理のリストであることを示しています。If present, indicates that this is a system-managed list. 読み取り専用です。Read-only.

次のプロパティは、baseItem から継承しています。The following properties are inherited from baseItem.

プロパティ名Property name 種類Type 説明Description
idid stringstring アイテムの一意識別子。読み取り専用です。The unique identifier of the item. Read-only.
namename stringstring アイテムの名前。The name of the item.
createdBycreatedBy identitySetidentitySet このアイテムの作成者の ID です。Identity of the creator of this item. 読み取り専用です。Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset アイテムが作成された日時。読み取り専用です。The date and time the item was created. Read-only.
説明description stringstring アイテムの説明テキストです。The descriptive text for the item.
lastModifiedBylastModifiedBy identitySetidentitySet このアイテムの最終変更者の ID です。Identity of the last modifier of this item. 読み取り専用です。Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset アイテムが最後に変更された日時。読み取り専用です。The date and time the item was last modified. Read-only.
webUrlwebUrl string (URL)string (url) ブラウザーでアイテムを表示する URL。読み取り専用です。URL that displays the item in the browser. Read-only.

リレーションシップRelationships

list リソースには、他のリソースと次のような関係があります。The list resource has the following relationships to other resources.

リレーションシップ名Relationship name 種類Type 説明Description
activitiesactivities itemActivity コレクションitemActivity collection このリスト内で行われた最近のアクティビティです。The recent activities that took place within this list.
ドライブdrive drivedrive ドキュメント ライブラリにのみ存在します。Only present on document libraries. driveItems を含む drive リソースとしてリストにアクセスできます。Allows access to the list as a drive resource with driveItems.
itemsitems Collection(listItem)Collection(listItem) リストに含まれているすべてのアイテム。All items contained in the list.