Recurso ListList resource

Namespace: microsoft.graphNamespace: microsoft.graph

O recurso list representa uma lista em um site.The list resource represents a list in a site. Este recurso contém as propriedades de nível superior da lista, incluindo definições de modelo e campo.This resource contains the top level properties of the list, including template and field definitions.

Tarefas em listTasks on a list

As tarefas a seguir estão disponíveis para os recursos list.The following tasks are available for list resources. Observação: esta versão beta só permite navegar por listas, não criar ou atualizá-las.Note: This beta only allows navigating lists, not creating or updating them. Você pode, no entanto, criar ou atualizar itens de lista.You can, however, create or update list items.

Todos os exemplos a seguir referem-se a um site: https://graph.microsoft.com/v1.0/sites/{site-id}.All examples below are relative to a site, eg: https://graph.microsoft.com/v1.0/sites/{site-id}.

Tarefa comumCommon task Método HTTPHTTP method
Obter listaGet list GET /lists/{list-id}GET /lists/{list-id}
Criar listaCreate list POSTAR/listasPOST /lists
Enumerar itens de listaEnumerate list items GET /lists/{list-id}/itemsGET /lists/{list-id}/items
Atualizar item de listaUpdate list item PATCH /lists/{list-id}/items/{item-id}PATCH /lists/{list-id}/items/{item-id}
Excluir item de listaDelete list item DELETE /lists/{list-id}/items/{item-id}DELETE /lists/{list-id}/items/{item-id}
Criar item de listaCreate list item POST /lists/{list-id}POST /lists/{list-id}
Obter canal WebSocketGet WebSocket channel GET /lists/{list-id}/subscriptions/socketIoGET /lists/{list-id}/subscriptions/socketIo

Representação JSONJSON representation

Veja a seguir uma representação JSON de um recurso list.Here is a JSON representation of a list resource.

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

PropriedadesProperties

O recurso list tem as seguintes propriedades.The list resource has the following properties.

Nome da propriedadeProperty name TipoType DescriçãoDescription
displayNamedisplayName stringstring O título em exibição da lista.The displayable title of the list.
listlist listInfolistInfo Fornece mais detalhes sobre a lista.Provides additional details about the list.
systemsystem systemFacetsystemFacet Se estiver presente, indica que se trata de uma lista gerenciada pelo sistema.If present, indicates that this is a system-managed list. Somente leitura.Read-only.

As propriedades a seguir são herdadas do baseItem.The following properties are inherited from baseItem.

Nome da propriedadeProperty name TipoType DescriçãoDescription
idid stringstring O identificador exclusivo do item. Somente leitura.The unique identifier of the item. Read-only.
namename stringstring O nome do item.The name of the item.
createdBycreatedBy identitySetidentitySet Identidade do criador desse item.Identity of the creator of this item. Somente leitura.Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset A data e a hora da criação do item. Somente leitura.The date and time the item was created. Read-only.
descriptiondescription stringstring O texto descritivo do item.The descriptive text for the item.
eTageTag stringstring ETag do item. Somente leitura.ETag for the item. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Identidade da última pessoa que alterou esse item.Identity of the last modifier of this item. Somente leitura.Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset A data e a hora que o item foi modificado pela última vez. Somente leitura.The date and time the item was last modified. Read-only.
parentReferenceparentReference itemReferenceitemReference Informações do pai, se o item tiver um pai. Leitura e gravação.Parent information, if the item has a parent. Read-write.
sharepointIdssharepointIds sharepointIdssharepointIds Retorna os identificadores úteis para fins de compatibilidade do REST do SharePoint. Somente leitura.Returns identifiers useful for SharePoint REST compatibility. Read-only.
webUrlwebUrl string (url)string (url) A URL que exibe o item no navegador. Somente leitura.URL that displays the item in the browser. Read-only.

RelaçõesRelationships

O recurso list tem as seguintes relações com outros recursos.The list resource has the following relationships to other resources.

Nome da relaçãoRelationship name TipoType DescriçãoDescription
drivedrive drivedrive Presente somente em bibliotecas de documentos.Only present on document libraries. Permite o acesso à lista como um recurso de [unidade][] com driveItems.Allows access to the list as a drive resource with driveItems.
itemsitems Collection(listItem)Collection(listItem) Todos os itens contidos na lista.All items contained in the list.
columnscolumns Collection(columnDefinition)Collection(columnDefinition) A coleção de definições de campo para esta lista.The collection of field definitions for this list.
contentTypescontentTypes Collection(contentType)Collection(contentType) A coleção de tipos de conteúdo presentes nesta lista.The collection of content types present in this list.
assinaturassubscriptions Conjunto(assinatura)Collection(subscription) O conjunto de assinaturas na lista.The set of subscriptions on the list.