Skip to main content

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

Controls in DX API

Updated on February 7, 2022

Understand how you can adjust UI elements to your needs with REST API by learning how controls are supported in V1 Pega DX API.

Controls are the building blocks for layouts and appear in various types, such as a text area. The following example of an API response shows a Bug Description text area:

The values in the field element correspond with the control properties. For example, the value for the Visibility field corresponds with the value of the visible property.

API calls always return the type of a control as a field element that include the following parameters:

  • controlFormat that defines the style of a control, such as a text field.
  • mode that is a container element for additional information about the control.
For more comprehensive responses that include more parameters, use any of the following controls that DX API supports:
  • pxCheckbox
  • pxTextInput
  • pxEmail
  • pxUnitDays
  • pxAutoComplete
  • pxDropdown
  • pxRadioButtons
  • pxTextArea
  • pxDate
  • pxText
  • pxButton
  • pxLink
  • pxIcon
  • pxNumber
  • pxPhone
  • pxInteger
  • pxCurrency
  • pxURL

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