Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 2.69 KB

GetPnPListItem.md

File metadata and controls

84 lines (69 loc) · 2.69 KB

#Get-PnPListItem Retrieves list items ##Syntax

Get-PnPListItem [-Fields <String[]>]
                [-PageSize <Int32>]
                [-Web <WebPipeBind>]
                -List <ListPipeBind>
Get-PnPListItem [-Id <Int32>]
                [-Fields <String[]>]
                [-Web <WebPipeBind>]
                -List <ListPipeBind>
Get-PnPListItem [-Query <String>]
                [-Web <WebPipeBind>]
                -List <ListPipeBind>
Get-PnPListItem [-UniqueId <GuidPipeBind>]
                [-Fields <String[]>]
                [-Web <WebPipeBind>]
                -List <ListPipeBind>

##Returns

Microsoft.SharePoint.Client.ListItem

##Parameters

Parameter Type Required Description
Fields String[] False The fields to retrieve. If not specified all fields will be loaded in the returned list object.
Id Int32 False The ID of the item to retrieve
List ListPipeBind True The list to query
PageSize Int32 False The number of items to retrieve per page request.
Query String False The CAML query to execute against the list
UniqueId GuidPipeBind False The unique id (GUID) of the item to retrieve
Web WebPipeBind False The web to apply the command to. Omit this parameter to use the current web.
##Examples

###Example 1

PS:> Get-PnPListItem -List Tasks

Retrieves all list items from the Tasks list

###Example 2

PS:> Get-PnPListItem -List Tasks -Id 1

Retrieves the list item with ID 1 from from the Tasks list. This parameter is ignored if the Query parameter is specified.

###Example 3

PS:> Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3

Retrieves the list item with unique id bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from from the tasks lists. This parameter is ignored if the Query parameter is specified.

###Example 4

PS:> Get-PnPListItem -List Tasks -Fields "Title","GUID"

Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object. This parameter is ignored if the Query parameter is specified.

###Example 5

PS:> Get-PnPListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>"

Retrieves all list items based on the CAML query specified.

###Example 6

PS:> Get-PnPListItem -List Tasks -PageSize 1000

Retrieves all list items from the Tasks list in pages of 1000 items. This parameter is ignored if the Query parameter is specified.