Interacting with list entities
Make use of the list entity data pages to interact with your SharePoint lists
directly from your Pega application. In addition to
retrieving all or single lists, you can use these data pages to create, rename, and delete
lists. When referenced, the D_SPOnlineGetAllLists data page returns
information for all lists from a SharePoint site. For example, in an ID eq 2
expression, ID is the field name,
eq is the equality operator, and
2 is the matching value. For
more information about the supported operators and query
options, refer to the SharePoint documentation. For
example, you can display the results sorted by title in a
descending order, by specifying Title
Desc for this parameter. For example, if you sort by
title in a descending order and configure the data page to skip
titles until K, the call retrieves all
titles that start with the letters from the
K to
A range. When referenced, the D_SPOnlineGetListById data page returns
information for a single list (identified by the list ID) from a SharePoint
site. For
example, you can display the results sorted by title in a
descending order, by specifying Title
Desc for this parameter. For example, if you sort by
title in a descending order and configure the data page to skip
titles until K, the call retrieves all
titles that start with the letters from the
K to
A range. When referenced, the D_SPOnlineGetListByTitle data page returns
information for a single list (identified by the list title) from a SharePoint
site. For example, in an ID eq 2
expression, ID is the field name,
eq is the equality operator, and
2 is the matching value. For
more information about the supported operators and query
options, refer to the SharePoint documentation. For
example, you can display the results sorted by title in a
descending order, by specifying Title
Desc for this parameter. When referenced, the D_SPOnlineCreateList data page posts
information to create a new SharePoint list. For more
information about the available list template types and their
corresponding ID numbers, refer to the SharePoint
documentation. When referenced, the D_SPOnlineRenameList data page posts
information to update the title of an existing SharePoint list. When referenced, the D_SPOnlineDeleteListById data page posts
information to delete an existing SharePoint list (identified by the list ID). When referenced, the D_SPOnlineDeleteListByTitle data page posts
information to delete an existing SharePoint list (identified by the list
title).Retrieving all lists
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetAllLists Int-SPO-Lists https://{site url}/_api/web/lists 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. ❌ SelectFields Specifies the fields to retrieve. ❌ SelectItems Specifies the items to retrieve. You can use
this filter to return results that match a simple logical
expression. ❌ OrderBy Specifies the sorting (by field) and order
(ascending or descending) in which the results are displayed. ❌ TopNItems Retrieves the top n
(integer value) results. ❌ SkipUntil Skips over items until the specified item is
reached, and then returns the rest. ❌ Retrieving a list by ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListById Int-SPO-FilteredLists https://{site
url}/_api/web/lists(guid’ListId’) GET Data page parameters
Name Description Required Id Specifies the ID value of the list to retrieve. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ SelectFields Specifies the fields to retrieve. ❌ OrderBy Specifies the sorting (by field) and order
(ascending or descending) in which the results are displayed. ❌ TopNItems Retrieves the top n
(integer value) results. ❌ SkipUntil Skips over items until the specified item is
reached, and then returns the rest. ❌ Retrieving a list by title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetListByTitle Int-SPO-FilteredLists https://{site
url}/_api/web/lists/getbytitle(’title’) GET Data page parameters
Name Description Required Title Specifies the title value of the list to
retrieve. ✅ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ SelectFields Specifies the fields to retrieve. ❌ SelectItems Specifies the items to retrieve. You can use
this filter to return results that match a simple logical
expression. ❌ OrderBy Specifies the sorting (by field) and order
(ascending or descending) in which the results are displayed. ❌ Creating a list
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineCreateList Int-SPO-CreateList https://<site_url>/_api/web/lists POST Data page parameters
Name Description Required ListTitle Specifies the title of the list for which you
want to perform this operation. ✅ ListDescription Specifies the description of the list to
create. ❌ SiteName Overrides the default site in
SPOnlineSetings. ❌ AuthProfile Overrides the default authentication profile
in the SPOnlineSetings data transform. ❌ BaseTemplate Specifies the template number that
determines which list template type to create. ❌ Renaming a list
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineRenameList Int-SPO-UpdateList https://<site_url>/_api/web/lists(guid'ListGUID') POST Data page parameters
Name Description Required ListId Specifies the ID of the list for which you want
to perform this operation. ✅ ListNewTitle Specifies the new title for the list that
you want to update. ✅ 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 by ID
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteListById Int-SPO-DeleteListByGuid https://<site_url>/_api/web/lists(guid'ListGuid') POST 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. ❌ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ Deleting a list by title
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteListByTitle Int-SPO-DeleteListByTitle https://<site_url>/_api/web/lists/getbytitle('ListTitle') POST 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. ❌ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅
Previous topic Using the SharePoint Online component Next topic Interacting with field entities