Recurso List

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

O recurso list representa uma lista em um site. Este recurso contém as propriedades de nível superior da lista, incluindo definições de modelo e campo.

Tarefas em list

As tarefas a seguir estão disponíveis para os recursos list.

Todos os exemplos abaixo são relativos a um site, por exemplo, https://graph.microsoft.com/beta/sites/{site-id}.

Tarefa comum	Método HTTP
Obter listas em um site	GET /sites/{site-id}/lists
Criar lista	POSTAR/listas
Obter lista	GET /lists/{list-id}
Enumerar itens de lista	GET /lists/{list-id}/items
Atualizar item de lista	PATCH /lists/{list-id}/items/{item-id}
Excluir item de lista	DELETE /lists/{list-id}/items/{item-id}
Criar item de lista	POST /lists/{list-id}
Obter atividades recentes	GET /lists/{list-id}/activities
Obter canal WebSocket	GET /lists/{list-id}/subscriptions/socketIo
Tipos de conteúdo de lista	GET /lists/{list-id}/contentTypes
Adicionar cópia do tipo de conteúdo do site	POST /lists/{list-id}/contentTypes/addCopy
Colunas de lista	GET /lists/{list-id}/columns
Criar coluna	POST /lists/{list-id}/columns
Listar operações	GET /lists/{list-id}/operations

Propriedades

O recurso list tem as seguintes propriedades.

Propriedade	Tipo	Descrição
columns	Collection(columnDefinition)	A coleção de definições de campo para esta lista.
contentTypes	Collection(contentType)	A coleção de tipos de conteúdo presentes nesta lista.
displayName	string	O título em exibição da lista.
list	listInfo	Fornece mais detalhes sobre a lista.
system	systemFacet	Se presente, indica que esta é uma lista gerenciada pelo sistema. Somente leitura.

As propriedades a seguir são herdadas do baseItem.

Nome da propriedade	Tipo	Descrição
id	string	O identificador exclusivo do item. Somente leitura.
name	string	O nome do item.
createdBy	identitySet	Identidade do criador deste item. Somente leitura.
createdDateTime	DateTimeOffset	A data e a hora da criação do item. Somente leitura.
description	string	O texto descritivo do item.
lastModifiedBy	identitySet	Identidade do último modificador deste item. Somente leitura.
lastModifiedDateTime	DateTimeOffset	A data e a hora que o item foi modificado pela última vez. Somente leitura.
webUrl	string (url)	A URL que exibe o item no navegador. Somente leitura.

Relações

O recurso list tem as seguintes relações com outros recursos.

Relação	Tipo	Descrição
activities	Conjunto itemActivity	As atividades recentes que ocorreram nesta lista.
drive	drive	Presente apenas em bibliotecas de documentos. Permite o acesso à lista como um recurso drive com driveItems.
items	Collection(listItem)	Todos os itens contidos na lista.
assinaturas	conjunto de [assinaturas][]	O conjunto de assinaturas na lista.
operations	Coleção richLongRunningOperation	A coleção de operações de execução longa para a lista.

Representação JSON

Veja a seguir uma representação JSON do recurso.

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