Table of Contents

Retrieve a flat list of fields from Pega APIs


Only available versions of this content are shown in the dropdown

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.
Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.