Skip to main content


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

Interacting with field entities

Updated on March 14, 2022

Make use of the field entity data pages to interact with fields in your SharePoint lists directly from your Pega application. You can use these data pages to retrieve fields and create list fields.

Retrieving fields by list ID

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldsByListIdInt-SPO-Fieldshttps://{site url}/_api/web/lists(guid’ListId’)/fieldsGET

Data page parameters

NameDescriptionRequired
IdSpecifies the ID value 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.
SelectFieldsSpecifies the fields to retrieve.
SelectItemsSpecifies the items to retrieve. You can use this filter to return results that match a simple logical expression.

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.

OrderBySpecifies the sorting (by field) and order (ascending or descending) in which the results are displayed.

For example, you can display the results sorted by title in a descending order, by specifying Title Desc for this parameter.

TopNItemsRetrieves the top n (integer value) results.
SkipUntilSkips over items until the specified item is reached, and then returns the rest.

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.

Retrieving fields by list title

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldsByListTitleInt-SPO-Fieldshttps://{site url}/_api/web/lists/getbytitle(’title’)/fieldsGET

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.
SelectFieldsSpecifies the fields to retrieve.
SelectItemsSpecifies the items to retrieve. You can use this filter to return results that match a simple logical expression.

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.

OrderBySpecifies the sorting (by field) and order (ascending or descending) in which the results are displayed.

For example, you can display the results sorted by title in a descending order, by specifying Title Desc for this parameter.

TopNItemsRetrieves the top n (integer value) results.
SkipUntilSkips over items until the specified item is reached, and then returns the rest.

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.

Retrieving a field by field ID and list ID

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldByIdAndListIdInt-SPO-FilteredFieldshttps://{site url}/_api/web/lists(guid ’listId’)/fields(guid ‘fieldId)GET

Data page parameters

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

Retrieving a field by field ID and list title

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldByIdAndListTitleInt-SPO-FilteredFieldshttps://{site url}/_api/web/lists/getbytitle(’listTitle’)/fields(guid ‘fieldId’)GET

Data page parameters

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

Retrieving a field by field title and list ID

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldByTitleAndListIdInt-SPO-FilteredFieldshttps://{site url}/_api/web/lists(guid ‘listId’)/fields/getbytitle(‘fieldTitle’)GET

Data page parameters

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

Retrieving a field by field title and list title

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineGetFieldByTitleAndListTitleInt-SPO-FilteredFieldshttps://{site url}/_api/web/lists/getbytitle(‘listTitle’)/fields/getbytitle(‘fieldTitle’)GET

Data page parameters

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

Creating a list field by list title

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineCreateListFieldByTitleInt-SPO-CreateListFieldhttps://<site_url>/_api/web/lists/getbytitle('ListTitle')/fieldsPOST

Data page parameters

NameDescriptionRequired
ListTitleSpecifies the title of the list for which you want to perform this operation.
ListFieldTitleSpecifies the title of the list field for which you want perform this operation.
FieldTypeKindSpecifies the enumeration for the field type. Requires an integer value.

For more information about available field types and their corresponding enumeration, refer to the SharePoint documentation.

RequiredSpecifies whether the value to retrieve requires the returned field to have a value.
EnforceUniqueValuesSpecifies whether the value to retrieve requires a unique field value in a list or library column.
StaticNameRetrieves the value with a set customizable field identifier.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

Creating a list field by list ID

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

Data page details

Data pageData typeSharePoint APIHTTP method
D_SPOnlineCreateListFieldByIdInt-SPO-CreateListFieldhttps://<site_url>/_api/web/lists(guid'ListId')/fieldsPOST

Data page parameters

NameDescriptionRequired
ListIdSpecifies the ID of the list for which you want to perform this operation.
ListFieldTitleSpecifies the title of the list field for which you want perform this operation.
FieldTypeKindSpecifies the enumeration for the field type. Requires an integer value.

For more information about available field types and their corresponding enumeration, refer to the SharePoint documentation.

RequiredSpecifies whether the value to retrieve requires the returned field to have a value.
EnforceUniqueValuesSpecifies whether the value to retrieve requires a unique field value in a list or library column.
StaticNameRetrieves the value with a set customizable field identifier.
SiteNameOverrides the default site in SPOnlineSetings.
AuthProfileOverrides the default authentication profile in the SPOnlineSetings data transform.

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