Interacting with list item entities
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. When referenced, the D_SPOnlineGetListItemsByListId data page
returns information for list items from a SharePoint list (identified by the list
ID). When referenced, the D_SPOnlineGetListItemsByListTitle data page
returns information for list items from a SharePoint list (identified by the 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). 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). When referenced, the D_SPOnlineCreateListItemByListId data page
posts information to create a new list item in a SharePoint list (identified by the list
ID). When referenced, the D_SPOnlineCreateListItemByListTitle data
page posts information to create a new list item in a SharePoint list (identified by the
list title). 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). 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). 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). 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). When referenced, the D_SPOnlineGetListItemAttachments data page
returns the attachment information of a list item. When referenced, the D_SPOnlineGetListItemAttachments data page
returns the attachment content (in the Base64 encoded format) of a list item. For example,
When referenced, the D_SPOnlineCreateListItemAttachment data
page posts information to add an attachment to a list item. For example,
When referenced, the D_SPOnlineUdpateListItemAttachment data
page posts information to update the attachment content of a list item. For example,
When referenced, the D_SPOnlineDeleteListItemAttachment data
page posts information to delete an attachment from a list item. For example,
Retrieving list items by list ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemsByListId Int-SPO-ListItems https://{site url}/web/lists(guid'List
ID')/items GET Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Retrieving list items by list title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemsByListTitle Int-SPO-ListItems https://{site
url}/web/lists/getbytitle('listTitle')/items GET Data page parameters
Name Description Required ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Retrieving a list item by list item ID and list title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemByIdAndListTitle Int-SPO-FilteredListItems https://{site
url}/web/lists/getbytitle('ListTitle')/items(ItemId) GET Data page parameters
Name Description Required ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ItemId Specifies the list item ID. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Retrieving a list item by list item ID and list ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemByIdAndListId Int-SPO-FilteredListItems https://{site
url}/web/lists(guid'listId')/items(itemId) GET Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ ItemId Specifies the list item ID. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Creating a list item by list ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineCreateListItemByListId Int-SPO-CreateListItem https://{site
url}/web/lists(guid'listId')/items POST Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ ListItemTitle Specifies the list item title. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Creating a list item by list title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineCreateListItemByListTitle Int-SPO-CreateListItem https://{site
url}/web/lists/getbytitle('listTitle')/items POST Data page parameters
Name Description Required ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemTitle Specifies the list item title. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Renaming a list item by list item ID and list ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineRenameListItemByIdAndListId Int-SPO-UpdateListItem https://{site url}/web/lists(guid
'listId')/items(itemId) POST Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ ItemId Specifies the list item ID. ✅ NewTitle Specifies the new list item title. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ Renaming a list item by list item ID and list title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineRenameListItemByIdAndListTitle Int-SPO-UpdateListItem https://{site
url}/web/lists/getbytitle('listTitle')/items(itemId) POST Data page parameters
Name Description Required ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ItemId Specifies the list item ID. ✅ NewTitle Specifies the new list item title. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ Deleting a list item by list item ID and list ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteListItemByIdAndListId Int-SPO-DeleteListItem https://{site
url}/web/lists(guid'listId')/items(itemId) POST Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ ItemId Specifies the list item ID. ✅ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Deleting a list item by list item ID and list title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteListItemByIdAndListTitle Int-SPO-DeleteListItem https://{site
url}/web/lists/getbytitle('listTitle')/items(itemId) POST Data page parameters
Name Description Required ListTitle Specifies the ID of the list for which you want
to perform this operation. ✅ ItemId Specifies the list item ID. ✅ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ Retrieving attachment information of a list item
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemAttachments Int-SPO-ListItemAttachments https://{site
url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles GET Data page parameters
Name Description Required SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemId Specifies the list item ID. ✅ Retrieving attachment content of a list item
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListItemAttachments Int-SPO-ListItemAttachment https://{site
url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles(‘FileName’)/$value GET Data page parameters
Name Description Required SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemId Specifies the list item ID. ✅ FileName Specifies the attachment name along
with the corresponding file extension. contact-form.txt.✅ Creating an attachment for a list item
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineCreateListItemAttachment Int-SPO-CreateListItemAttachment https://{site
url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles/add(FileName='FileName') POST Data page parameters
Name Description Required SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemId Specifies the list item ID. ✅ FileName Specifies the attachment name along
with the corresponding file extension. contact-form.txt.✅ FileContent Specifies the content of the
attachment in the Base64 encoded format. ✅ Updating attachment content of a list item
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineUdpateListItemAttachment Int-SPO-UpdateListItemAttachment https://{site
url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles(‘FileName’)/$value POST Data page parameters
Name Description Required SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemId Specifies the list item ID. ✅ FileName Specifies the attachment name along
with the corresponding file extension. contact-form.txt.✅ FileContent Specifies the content of the
attachment in the Base64 encoded format. ✅ Deleting an attachment from a list item
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteListItemAttachment Int-SPO-DeleteListItemAttachment https://{site
url}/_api/web/lists/getbytitle/(’ListTitle’)/items(ListItemId)/AttachmentFiles/getByFileName(‘FileName') POST Data page parameters
Name Description Required SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListItemId Specifies the list item ID. ✅ FileName Specifies the attachment name along
with the corresponding file extension. contact-form.txt.✅
Previous topic Interacting with field entities Next topic Interacting with folder entities