Ресурс List

Пространство имен: microsoft.graph

Важно!

Api в /beta версии Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий .

Ресурс list представляет список в ресурсе site. Этот ресурс содержит высокоуровневые свойства списка, включая определения шаблонов и полей.

Задачи для ресурса list

Ниже перечислены задачи, доступные для ресурсов list.

Все приведенные ниже примеры относятся к сайту, например https://graph.microsoft.com/beta/sites/{site-id}.

Стандартная задача Метод HTTP
Получение списков на сайте GET /sites/{site-id}/lists
Создание списка POST /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 Коллекция (columnDefinition) Коллекция определений полей для данного списка.
contentTypes Коллекция (contentType) Коллекция типов контента в данном списке.
displayName строка Отображаемый заголовок списка.
list listInfo Предоставляет дополнительные сведения о списке.
system systemFacet Если это свойство задано, оно указывает, что данным списком управляет система. Только для чтения.

Ниже перечислены свойства, которые наследуются от ресурса baseItem.

Имя свойства Тип Описание
id string Уникальный идентификатор элемента. Только для чтения.
name строка Имя элемента.
createdBy identitySet Удостоверение создателя данного элемента. Только для чтения.
createdDateTime DateTimeOffset Дата и время создания элемента. Только для чтения.
description строка Текст с описанием элемента.
lastModifiedBy identitySet Удостоверение пользователя, который последним изменил данный элемент. Только для чтения.
lastModifiedDateTime DateTimeOffset Дата и время последнего изменения элемента. Только для чтения.
webUrl строка (url-адрес) URL-адрес для отображения элемента в браузере. Только для чтения.

Связи

Ниже перечислены связи ресурса list с другими ресурсами.

Связь Тип Описание
activities Коллекция itemActivity Последние действия, выполненные в списке.
drive drive Доступна только для библиотек документов. Разрешает доступ к списку как к ресурсу drive с объектами driveItem.
items Коллекция (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"
}