Recurso de listaList resource

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

El recurso list representa una lista en un [sitio][].The list resource represents a list in a site. Este recurso contiene las propiedades de nivel superior de la lista, incluidas las definiciones de plantilla y campo.This resource contains the top level properties of the list, including template and field definitions.

Tareas en una listaTasks on a list

Las tareas siguientes están disponibles para los recursos list.The following tasks are available for list resources. Nota: Esta versión beta solo permite navegar por listas, no permite crearlas ni actualizarlas.Note: This beta only allows navigating lists, not creating or updating them. En cambio, puede crear o actualizar elementos de lista.You can, however, create or update list items.

Todos los ejemplos siguientes son relativos a un sitio, por ejemplo: 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}.

Tarea comúnCommon task Método HTTPHTTP method
Obtener listaGet list GET /lists/{list-id}GET /lists/{list-id}
Crear listaCreate list PUBLICACIONES / listasPOST /lists
Enumerar elementos de listaEnumerate list items GET /lists/{list-id}/itemsGET /lists/{list-id}/items
Actualizar elemento de listaUpdate list item PATCH /lists/{list-id}/items/{item-id}PATCH /lists/{list-id}/items/{item-id}
Eliminar elemento de listaDelete list item DELETE /lists/{list-id}/items/{item-id}DELETE /lists/{list-id}/items/{item-id}
Crear elemento de listaCreate list item POST /lists/{list-id}POST /lists/{list-id}
Obtenga el canal WebSocketGet WebSocket channel Obtenga/lists/{list-id}/subscriptions/socketIoGET /lists/{list-id}/subscriptions/socketIo

Representación JSONJSON representation

A continuación se incluye una representación JSON del 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"
}

PropiedadesProperties

El recurso list tiene las siguientes propiedades.The list resource has the following properties.

Nombre de propiedadProperty name TipoType DescripciónDescription
displayNamedisplayName stringstring El título que se puede mostrar de la lista.The displayable title of the list.
listlist listInfolistInfo Proporciona detalles adicionales sobre la lista.Provides additional details about the list.
systemsystem systemFacetsystemFacet Si está presente, indica que se trata de una lista administrada por el sistema.If present, indicates that this is a system-managed list. Solo lectura.Read-only.

Las siguientes propiedades se heredan de baseItem.The following properties are inherited from baseItem.

Nombre de propiedadProperty name TipoType DescripciónDescription
idid stringstring El identificador único del elemento. Solo lectura.The unique identifier of the item. Read-only.
namename stringstring Nombre del elemento.The name of the item.
createdBycreatedBy identitySetidentitySet Identidad del creador de este elemento.Identity of the creator of this item. Solo lectura.Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset La fecha y la hora de creación del elemento. Solo lectura.The date and time the item was created. Read-only.
descriptiondescription stringstring Texto descriptivo del elemento.The descriptive text for the item.
eTageTag stringstring ETag para el elemento. Solo lectura.ETag for the item. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Identidad del usuario que modificó por última vez este elemento.Identity of the last modifier of this item. Solo lectura.Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Fecha y hora de la última modificación del elemento. Solo lectura.The date and time the item was last modified. Read-only.
parentReferenceparentReference itemReferenceitemReference Información primaria, si el elemento tiene un elemento primario. Lectura y escritura.Parent information, if the item has a parent. Read-write.
sharepointIdssharepointIds sharepointIdssharepointIds Devuelve los identificadores útiles para la compatibilidad con REST de SharePoint. Solo lectura.Returns identifiers useful for SharePoint REST compatibility. Read-only.
webUrlwebUrl string (url)string (url) Dirección URL que muestra el elemento en el explorador. Solo lectura.URL that displays the item in the browser. Read-only.

RelacionesRelationships

El recurso list tiene las siguientes relaciones con otros recursos.The list resource has the following relationships to other resources.

Nombre de la relaciónRelationship name TipoType DescripciónDescription
drivedrive drivedrive Solo está presente en bibliotecas de documentos.Only present on document libraries. Permite el acceso a la lista como un recurso drive con objetos driveItems.Allows access to the list as a drive resource with driveItems.
itemsitems Collection(listItem)Collection(listItem) Todos los elementos que se incluyen en la lista.All items contained in the list.
columnscolumns Collection(columnDefinition)Collection(columnDefinition) La colección de definiciones de campo de esta lista.The collection of field definitions for this list.
contentTypescontentTypes Collection(contentType)Collection(contentType) La colección de tipos de contenido presentes en esta lista.The collection of content types present in this list.
suscripcionessubscriptions Colección([suscripción de][])Collection(subscription) El conjunto de suscripciones de la lista.The set of subscriptions on the list.