Interacting with folder entities
Make use of the folder entity data pages to interact with your SharePoint folders
directly from your Pega application. In addition to
creating, renaming, and deleting folders, you can use these data pages to retrieve folder
metadata and information about folder items, properties, and fields. When referenced, the D_SPOnlineCreateFolder data page posts
information to create a new folder. For example,
When referenced, the D_SPOnlineRenameFolder data page posts
information to update the title of an existing folder. For example,
When referenced, the D_SPOnlineDeleteFolder data page posts
information to delete an folder. For example,
When referenced, the D_SPOnlineGetFolderMetadata data page
returns metadata for a single folder. For example,
When referenced, the D_SPOnlineGetFolderItems data page returns
a list of items from a single folder. For example,
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_SPOnlineGetFolderProperties data page
returns the properties of a single folder. For example,
When referenced, the D_SPOnlineGetFolderFields data page returns
the fields of a single folder. For example,
Creating a folder
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineCreateFolder Int-SPO-Folder https://{site url}/_api/web/folders 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ NewFolderName Specifies a new folder name. ✅ Renaming a folder
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineRenameFolder Int-SPO-RenameFolder https://{site url}/_api/web/lists 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ NewFolderName Specifies a new folder name. ✅ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ Deleting a folder
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineDeleteFolder Int-SPO-DeleteFolder https://{site
url}/_api/web/GetFolderbyServerRelativeUrl('<folder
path>') 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ IfMatchHeader Specifies a valid ETag value to use during
the operation. The default value is
*. ✅ Retrieving folder metadata
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetFolderMetadata Int-SPO-Folder ○ https://{site
url}/_api/web/GetFolderByServerRelativeUrl('<folder
path>') 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ Retrieving a list of folder items
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetFolderItems Pega-API-Storage-Object https://{site
url}/_api/web/GetFolderByServerRelativeUrl(‘<folder
path>’)?$expand=Folders,Files 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ FoldersOnly Provides a choice (checkbox) to retrieve
only folders. ❌ 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 folder properties
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetFolderProperties Int-SPO-FolderProperties https://{site
url}/_api/web/GetFolderByServerRelativeUrl('<folder
path>')/properties 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅ Retrieving folder fields
Data page details
Data page Data type SharePoint API HTTP method D_SPOnlineGetFolderFields Int-SPO-FolderFields https://{site
url}/_api/web/GetFolderByServerRelativeUrl('<folder
path>')/ListItemAllFields 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. ❌ FolderPath Specifies the folder path. Documents/Test.✅
Previous topic Interacting with list item entities Next topic Interacting with file entities