Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Interacting with list item entities

Updated on March 14, 2022

Make use of the list item entity data pages to interact with items in your SharePoint lists directly from your Pega application. In addition to retrieving multiple or single list items, you can use these data pages to create, rename, and delete list items. Moreover, these data pages give you the ability to interact with attachments in list items.

Retrieving list items by list ID

When referenced, the D_SPOnlineGetListItemsByListId data page returns information for list items from a SharePoint list (identified by the list ID).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemsByListIdInt-SPO-ListItemshttps://{site url}/web/lists(guid'List ID')/itemsGET

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Retrieving list items by list title

When referenced, the D_SPOnlineGetListItemsByListTitle data page returns information for list items from a SharePoint list (identified by the list title).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemsByListTitleInt-SPO-ListItemshttps://{site url}/web/lists/getbytitle('listTitle')/itemsGET

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the title of the list for which you want to perform this operation.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Retrieving a list item by list item ID and list title

When referenced, the D_SPOnlineGetListItemByIdAndListTitle data page returns information for a single list item from a SharePoint list (identified by the list item ID and list title).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemByIdAndListTitleInt-SPO-FilteredListItemshttps://{site url}/web/lists/getbytitle('ListTitle')/items(ItemId)GET

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the title of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Retrieving a list item by list item ID and list ID

When referenced, the D_SPOnlineGetListItemByIdAndListTitle data page returns information for a single list item from a SharePoint list (identified by the list item ID and list ID).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemByIdAndListIdInt-SPO-FilteredListItemshttps://{site url}/web/lists(guid'listId')/items(itemId)GET

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Creating a list item by list ID

When referenced, the D_SPOnlineCreateListItemByListId data page posts information to create a new list item in a SharePoint list (identified by the list ID).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineCreateListItemByListIdInt-SPO-CreateListItemhttps://{site url}/web/lists(guid'listId')/itemsPOST

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
ListItemTitleSpecifies the list item title.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Creating a list item by list title

When referenced, the D_SPOnlineCreateListItemByListTitle data page posts information to create a new list item in a SharePoint list (identified by the list title).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineCreateListItemByListTitleInt-SPO-CreateListItemhttps://{site url}/web/lists/getbytitle('listTitle')/itemsPOST

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemTitleSpecifies the list item title.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Renaming a list item by list item ID and list ID

When referenced, the D_SPOnlineRenameListItemByIdAndListId data page posts information to update the title of an existing list item in a SharePoint list (identified by the list item ID and list ID).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineRenameListItemByIdAndListIdInt-SPO-UpdateListItemhttps://{site url}/web/lists(guid 'listId')/items(itemId)POST

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
NewTitleSpecifies the new list item title.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
IfMatchHeaderSpecifies a valid ETag value to use during the operation. The default value is *.

Renaming a list item by list item ID and list title

When referenced, the D_SPOnlineRenameListItemByIdAndListTitle data page posts information to update the title of an existing list item in a SharePoint list (identified by the list item ID and list title).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineRenameListItemByIdAndListTitleInt-SPO-UpdateListItemhttps://{site url}/web/lists/getbytitle('listTitle')/items(itemId)POST

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the title of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
NewTitleSpecifies the new list item title.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
IfMatchHeaderSpecifies a valid ETag value to use during the operation. The default value is *.

Deleting a list item by list item ID and list ID

When referenced, the D_SPOnlineDeleteListItemByIdAndListId data page posts information to delete an existing list item in a SharePoint list (identified by the list item ID and list ID).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineDeleteListItemByIdAndListIdInt-SPO-DeleteListItemhttps://{site url}/web/lists(guid'listId')/items(itemId)POST

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
IfMatchHeaderSpecifies a valid ETag value to use during the operation. The default value is *.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Deleting a list item by list item ID and list title

When referenced, the D_SPOnlineDeleteListItemByIdAndListTitle data page posts information to delete an existing list item in a SharePoint list (identified by the list item ID and list title).

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineDeleteListItemByIdAndListTitleInt-SPO-DeleteListItemhttps://{site url}/web/lists/getbytitle('listTitle')/items(itemId)POST

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the ID of the list for which you want to perform this operation.
ItemIdSpecifies the list item ID.
IfMatchHeaderSpecifies a valid ETag value to use during the operation. The default value is *.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Retrieving attachment information of a list item

When referenced, the D_SPOnlineGetListItemAttachments data page returns the attachment information of a list item.

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemAttachmentsInt-SPO-ListItemAttachmentshttps://{site url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFilesGET

Data page parameters

NameDescriptionRequired
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemIdSpecifies the list item ID.

Retrieving attachment content of a list item

When referenced, the D_SPOnlineGetListItemAttachments data page returns the attachment content (in the Base64 encoded format) of a list item.

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetListItemAttachmentsInt-SPO-ListItemAttachmenthttps://{site url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles(‘FileName’)/$valueGET

Data page parameters

NameDescriptionRequired
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemIdSpecifies the list item ID.
FileNameSpecifies the attachment name along with the corresponding file extension.

For example, contact-form.txt.

Creating an attachment for a list item

When referenced, the D_SPOnlineCreateListItemAttachment data page posts information to add an attachment to a list item.

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineCreateListItemAttachmentInt-SPO-CreateListItemAttachmenthttps://{site url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles/add(FileName='FileName')POST

Data page parameters

NameDescriptionRequired
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemIdSpecifies the list item ID.
FileNameSpecifies the attachment name along with the corresponding file extension.

For example, contact-form.txt.

FileContentSpecifies the content of the attachment in the Base64 encoded format.

Updating attachment content of a list item

When referenced, the D_SPOnlineUdpateListItemAttachment data page posts information to update the attachment content of a list item.

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineUdpateListItemAttachmentInt-SPO-UpdateListItemAttachmenthttps://{site url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles(‘FileName’)/$valuePOST

Data page parameters

NameDescriptionRequired
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemIdSpecifies the list item ID.
FileNameSpecifies the attachment name along with the corresponding file extension.

For example, contact-form.txt.

FileContentSpecifies the content of the attachment in the Base64 encoded format.

Deleting an attachment from a list item

When referenced, the D_SPOnlineDeleteListItemAttachment data page posts information to delete an attachment from a list item.

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineDeleteListItemAttachmentInt-SPO-DeleteListItemAttachmenthttps://{site url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles/getByFileName(‘FileName')POST

Data page parameters

NameDescriptionRequired
SiteName Overrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListItemIdSpecifies the list item ID.
FileNameSpecifies the attachment name along with the corresponding file extension.

For example, contact-form.txt.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us