Skip to main content

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

Retrieve a flat list of fields from Pega Digital Experience APIs (8.3)

Updated on May 3, 2021

You can now use the flatListOfFields parameter to retrieve a list of the fields in a case or flow action. With this parameter, you avoid parsing all the layout information for the Pega Digital Experience API, making it easier for you to see only what you need to build your user interface.

The following Pega Digital Experience APIs support the flatListOfFields parameter:

  • GET /casetypes/{ID}
  • GET /assignments/{ID}/actions/{actionID}
  • GET /cases/{ID}/actions/{actionID}

Specify the level of detail that you need in the list by setting the parameter's values to Full or Basic. Full returns the full level of information, including the control format and modes. Basic returns basic information about the property, such as the type, reference, and value.

You can test the flatListOfFields parameter in the Parameters section of the Pega Digital Experience API, for example, GET /casetypes/{ID}, as shown in the following figure.

List of fields in the Parameters section
Parameters section

For more information, see Retrieve a flat list of fields from Pega APIs.

  • Previous topic Configure your environment for optimal performance during data migration (8.3)
  • Next topic Configure data source simulations from Integration Designer (8.3)

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us