Skip to content

listitem-list.mdx

Latest commit

 

History

History
193 lines (139 loc) · 6.36 KB

listitem-list.mdx

File metadata and controls

193 lines (139 loc) · 6.36 KB

import Global from '../../_global.mdx'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

spo listitem list

Gets a list of items from the specified list

Usage

m365 spo listitem list [options]

Options

`-u, --webUrl <webUrl>`
: URL of the site from which the item should be retrieved.

`-i, --listId [listId]`
: ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.

`-t, --listTitle [listTitle]`
: Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.

`--listUrl [listUrl]`
: Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.

`-q, --camlQuery [camlQuery]`
: CAML query to use to query the list of items with.

`--fields [fields]`
: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both.

`-l, --filter [filter]`
: OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.

`-s, --pageSize [pageSize]`
: Number of list items to return. Specify `camlQuery` or `pageSize` but not both. The default value is 5000.

`-n, --pageNumber [pageNumber]`
: Page number to return if `pageSize` is specified (first page is indexed as value of 0).

Remarks

This command retrieves all items in the list, even if there are more than 5000. Use the pageSize and pageNumber options if you only want a specific amount of items. When using a CAML query, include a RowLimit-node to get all items. If you run into list view threshold exceptions, remove any Query-conditions or filters and also include a RowLimit-node.

pageNumber is specified as a 0-based index. A value of 2 returns the third page of items.

If you want to specify a lookup type in the properties option, define which columns from the related list should be returned.

Examples

Get all items from a list named Demo List

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x

Get all items from a list with ID 935c13a0-cc53-4103-8b48-c1d0828eaa7f

m365 spo listitem list --listId 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x

Get all items from list named Demo List. For each item, retrieve the value of the ID, Title and Modified fields

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"

Get all items from list named Demo List. For each item, retrieve the value of the ID, Title, Modified fields, and the value of lookup field Company

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"

From a list named Demo List get all items with title Demo list item using an OData filter

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"

From a list named Demo List get the first 100 items

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 100 --pageNumber 0

From a list named Demo List get the second batch of 10 items

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 1

Get all items from a list by server-relative URL

m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x

From a list named Demo List get all items with title Demo list item using a CAML query

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query><RowLimit Paged='TRUE'>5000</RowLimit></View>"

From a library named Demo Library with 5000+ files and folders, get all items recursively without running into a list view threshold exception, using a CAML query

m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View Scope='RecursiveAll'><Query></Query><ViewFields><FieldRef Name='Title'/></ViewFields><RowLimit Paged='TRUE'>5000</RowLimit></View>"

Response

[
  {
    "FileSystemObjectType": 0,
    "Id": 236,
    "ServerRedirectedEmbedUri": null,
    "ServerRedirectedEmbedUrl": "",
    "ContentTypeId": "0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803",
    "Title": "Test",
    "Modified": "2022-11-16T21:00:03Z",
    "Created": "2022-11-16T20:56:31Z",
    "AuthorId": 10,
    "EditorId": 10,
    "OData__UIVersionString": "6.0",
    "Attachments": true,
    "GUID": "cac57513-e870-4e7a-9f23-f4ea10e14f4e",
    "ComplianceAssetId": null,
    "OData__vti_ItemDeclaredRecord": null
  }
]
Id   Title
---  -----
236  Test

FileSystemObjectType,Id,ServerRedirectedEmbedUri,ServerRedirectedEmbedUrl,ContentTypeId,Title,Modified,Created,AuthorId,EditorId,OData__UIVersionString,Attachments,GUID,ComplianceAssetId,OData__vti_ItemDeclaredRecord
0,236,,,0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803,Test,2022-11-16T21:00:03Z,2022-11-16T20:56:31Z,10,10,6.0,1,cac57513-e870-4e7a-9f23-f4ea10e14f4e,,
# spo listitem list --webUrl "https://contoso.sharepoint.com" --listTitle "My List"

Date: 2/20/2023

## Demo Item (147)

Property | Value
---------|-------
FileSystemObjectType | 0
Id | 236
ServerRedirectedEmbedUri | null
ServerRedirectedEmbedUrl |
ContentTypeId | 0x01003CDBEB7138618C47A98D56499135D6EE0004C0F5794DEBCC4BAC981AC4AE1BD803
Title | Test
ComplianceAssetId | null
Modified | 2022-11-16T21:00:03Z
Created | 2022-11-16T20:56:31Z
AuthorId | 10
EditorId | 10
OData\_\_UIVersionString | 6.0
Attachments | false
GUID | cac57513-e870-4e7a-9f23-f4ea10e14f4e
OData__vti_ItemDeclaredRecord | null