Ressource ListList resource

La ressource list représente une liste dans un site.The list resource represents a list in a site. Cette ressource contient les propriétés de niveau supérieur de la liste, y compris les définitions de modèle et de champ.This resource contains the top level properties of the list, including template and field definitions.

Tâches dans une listeTasks on a list

Les tâches suivantes peuvent être exécutées sur les ressources list.The following tasks are available for list resources. Remarque : cette version bêta vous permet uniquement d’accéder aux listes. Vous ne pouvez pas en créer ni les mettre à jour.Note: This beta only allows navigating lists, not creating or updating them. Toutefois, vous pouvez créer ou mettre à jour des éléments de liste.You can, however, create or update list items.

Tous les exemples ci-dessous concernent un site, par exemple : 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}.

Tâche couranteCommon task Méthode HTTPHTTP method
Obtenir une listeGet list GET /lists/{list-id}GET /lists/{list-id}
Énumérer les éléments de listeEnumerate list items GET /lists/{list-id}/itemsGET /lists/{list-id}/items
Mettre à jour l’élément de la listeUpdate list item PATCH /lists/{list-id}/items/{item-id}PATCH /lists/{list-id}/items/{item-id}
Supprimer l’élément de listeDelete list item DELETE /lists/{list-id}/items/{item-id}DELETE /lists/{list-id}/items/{item-id}
Créer un élément de listeCreate list item POST /lists/{list-id}POST /lists/{list-id}

Représentation JSONJSON representation

Voici une représentation JSON de la ressource 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,

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

PropriétésProperties

La ressource list possède les propriétés suivantes.The list resource has the following properties.

Nom de la propriétéProperty name TypeType DescriptionDescription
displayNamedisplayName stringstring Titre affichable de la liste.The displayable title of the list.
listlist listInfolistInfo Fournit des informations supplémentaires sur la liste.Provides additional details about the list.
systemsystem systemFacetsystemFacet Indique s’il s’agit d’une liste gérée par le système, le cas échéant.If present, indicates that this is a system-managed list. En lecture seule.Read-only.

Les propriétés suivantes sont héritées de la ressource baseItem.The following properties are inherited from baseItem.

Nom de la propriétéProperty name TypeType DescriptionDescription
idid chaînestring Identificateur unique de l’élément. En lecture seule.The unique identifier of the item. Read-only.
namename stringstring Nom de l’élément.The name of the item.
createdBycreatedBy identitySetidentitySet Identité du créateur de cet élément.Identity of the creator of this item. En lecture seule.Read-only.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset Date et heure de création de l’élément. En lecture seule.The date and time the item was created. Read-only.
descriptiondescription stringstring Description de l’élément.The descriptive text for the item.
eTageTag stringstring ETag pour l’élément. En lecture seule.ETag for the item. Read-only.
lastModifiedBylastModifiedBy identitySetidentitySet Identité du dernier modificateur de cet élément.Identity of the last modifier of this item. En lecture seule.Read-only.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset Date et heure de dernière modification de l’élément. En lecture seule.The date and time the item was last modified. Read-only.
parentReferenceparentReference itemReferenceitemReference Informations de l’élément parent, si l’élément possède un parent. En lecture-écriture.Parent information, if the item has a parent. Read-write.
sharepointIdssharepointIds sharepointIdssharepointIds Renvoie les identificateurs utiles pour garantir la compatibilité de SharePoint REST. En lecture seule.Returns identifiers useful for SharePoint REST compatibility. Read-only.
webUrlwebUrl chaîne (URL)string (url) URL qui affiche l’élément dans le navigateur. En lecture seule.URL that displays the item in the browser. Read-only.

RelationsRelationships

La ressource list a les relations suivantes avec les autres ressources.The list resource has the following relationships to other resources.

Nom de la relationRelationship name TypeType DescriptionDescription
lecteurdrive drivedrive Présent uniquement dans les bibliothèques de documents.Only present on document libraries. Permet d’accéder à la liste comme s’il s’agissait d’une ressource drive avec les ressources driveItem.Allows access to the list as a drive resource with driveItems.
itemsitems Collection(listItem)Collection(listItem) Tous les éléments contenus dans le lecteur.All items contained in the list.
colonnescolumns Collection(columnDefinition)Collection(columnDefinition) Collection des définitions de champ pour cette liste.The collection of field definitions for this list.
contentTypescontentTypes Collection(contentType)Collection(contentType) Collection de types de contenu présents dans cette liste.The collection of content types present in this list.