List resource type
Namespace: microsoft.graph
Represents a list in a site. This resource contains the top level properties of the list, including template and field definitions.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get list | list | Get the metadata for a list. |
| Create list | list | Create a new list in a site. |
| Get items | listItem collection | Get the collection of listItems in a list. |
| Update | listItem | Update the properties on a listItem. |
| Delete | None | Delete a listItem from a list. |
| Create item | listItem | Create a new listItem in a list. |
| Get websocket endpoint | subscription | Get near-real-time change notifications for a drive and list using socket.io. |
| List operations | richLongRunningOperation collection | Get a list of rich long-running operations associated with a list. |
Properties
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | Identity of the creator of this item. Read-only. Inherited from baseItem. |
| createdDateTime | DateTimeOffset | The date and time when the item was created. Read-only. Inherited from baseItem. |
| description | String | The descriptive text for the item. Inherited from baseItem. |
| displayName | String | The displayable title of the list. |
| eTag | String | ETag for the item. Inherited from baseItem. |
| id | String | The unique identifier of the item. Read-only. Inherited from baseItem. |
| lastModifiedBy | identitySet | Identity of the last modifier of this item. Read-only. Inherited from baseItem. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the item was last modified. Read-only. Inherited from baseItem. |
| list | listInfo | Contains more details about the list. |
| name | String | The name of the item. Read-only. Inherited from baseItem. |
| parentReference | itemReference | Parent information if the item has a parent. Read-write. Inherited from baseItem. |
| sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
| system | systemFacet | If present, indicates that the list is system-managed. Read-only. |
| webUrl | String | URL that displays the item in the browser. Read-only. Inherited from baseItem. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| columns | columnDefinition collection | The collection of field definitions for this list. |
| contentTypes | contentType collection | The collection of content types present in this list. |
| drive | drive | Allows access to the list as a drive resource with driveItems. Only present on document libraries. |
| items | listItem collection | All items contained in the list. |
| operations | richLongRunningOperation collection | The collection of long-running operations on the list. |
| subscriptions | subscription collection | The set of subscriptions on the list. |
JSON representation
The following JSON representation shows the resource type.
{
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"eTag": "String",
"id": "String (identifier)",
"lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" },
"lastModifiedDateTime": "String (timestamp)",
"list": { "@odata.type": "microsoft.graph.listInfo" },
"name": "String",
"parentReference": { "@odata.type": "microsoft.graph.itemReference" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"system": "Boolean",
"webUrl": "String"
}