listItem resource
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents an item in a SharePoint list.
All items in a SharePoint document library can be represented as a listItem or driveItem resource.
Column values in the list are available through the fieldValueSet
dictionary.
Methods
The following tasks are available for listItem resources.
All examples below are relative to a list, eg: https://graph.microsoft.com/beta/sites/{site-id}/lists/{list-id}
.
Common task | HTTP method |
---|---|
Get | GET /items/{item-id} |
Get column values | GET /items/{item-id}?expand=fields |
Get analytics | GET /items/{item-id}/analytics |
Get activities by interval | GET /items/{item-id}/getActivitiesByInterval |
Create | POST /items |
Delete | DELETE /items/{item-id} |
Update | PATCH /items/{item-id} |
Update column values | PATCH /items/{item-id}/fields |
createLink | POST /items/{itemId}/createLink |
List documentSetVersions | GET /items/{item-id}/documentSetVersions |
Create documentSetVersion | POST /items/{item-id}/documentSetVersions |
Restore documentSetVersion | POST /items/{item-id}/documentSetVersions/{documentSetVersion-id}/restore |
Get delta | GET /items/{item-id}/delta |
Properties
The listItem resource has the following properties.
Property | Type | Description |
---|---|---|
contentType | contentTypeInfo | The content type of this list item |
The following properties are inherited from baseItem.
Property name | Type | Description |
---|---|---|
id | string | The unique identifier of the item. Read-only. |
name | string | The name / title of the item. |
createdBy | identitySet | Identity of the creator of this item. Read-only. |
createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. |
description | string | The descriptive text for the item. |
eTag | string | ETag for the item. Read-only. |
lastModifiedBy | identitySet | Identity of the last modifier of this item. Read-only. |
lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. |
parentReference | itemReference | Parent information, if the item has a parent. Read-write. |
sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
webUrl | string (url) | URL that displays the item in the browser. Read-only. |
Relationships
The listItem resource has the following relationships to other resources.
Relationship | Type | Description |
---|---|---|
activities | itemActivity collection | The list of recent activities that took place on this item. |
analytics | itemAnalytics resource | Analytics about the view activities that took place on this item. |
documentSetVersions | documentSetVersion collection | Version information for a document set version created by a user. |
driveItem | driveItem | For document libraries, the driveItem relationship exposes the listItem as a driveItem |
fields | fieldValueSet | The values of the columns set on this list item. |
versions | listItemVersion collection | The list of previous versions of the list item. |
JSON representation
The following is a JSON representation of the resource.
{
"contentType": { "@odata.type": "microsoft.graph.contentTypeInfo" },
"fields": { "@odata.type": "microsoft.graph.fieldValueSet" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
/* relationships */
"activities": [{"@odata.type": "microsoft.graph.itemActivity"}],
"analytics": { "@odata.type": "microsoft.graph.itemAnalytics" },
"documentSetVersions": [{"@odata.type": "microsoft.graph.documentSetVersion"}],
"driveItem": { "@odata.type": "microsoft.graph.driveItem" },
"versions": [{"@odata.type": "microsoft.graph.listItemVersion"}],
/* inherited from baseItem */
"id": "string",
"name": "name of resource",
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"createdDateTime": "timestamp",
"description": "description of resource",
"eTag": "string",
"lastModifiedBy": { "@odata.type": "microsoft.graph.identitySet" },
"lastModifiedDateTime": "timestamp",
"parentReference": { "@odata.type": "microsoft.graph.itemReference"},
"webUrl": "url"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for