Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Retrieve a flat list of fields from Pega APIs

Updated on April 5, 2022

Use the flatListOfFields parameter in Pega APIs to retrieve only a list of fields from a case instead of the full layout information that you do not plan to use. Use this parameter if you are building your own user interface (UI) and want to have more control over the look and feel of your application.

The flatListofFields parameter applies to the following Pega APIs:

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

Specify the level of detail that you want the Pega API to return by using the following values:

  • Basic: Returns only basic information about the fields, such as the name, value, whether the field is required, and whether there are errors. Use Basic if you are not displaying your UI to end users.
  • Full: Returns descriptions of the fields, for example, whether the field is a check box. Use Full if you are displaying your UI to end users but you do not need to parse extraneous layout information.
  • Empty string: If you do not specify Basic or Full, the Pega API returns the full layout information.

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