Screens
API Reference for ProcessMaker Screen API
Last updated
Was this helpful?
API Reference for ProcessMaker Screen API
Last updated
Was this helpful?
Display a listing of the Screen Categories.
/screen_categories
Filter results by string. Searches Name, Description, and Status. All fields must match exactly.
Field to order results by
asc
, desc
Updates the current element
/screen_categories/{screen_category_id}
ID of screen category to return
Represents a business screen category definition.
ACTIVE
, INACTIVE
Get a list of Screens.
/screens
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
, desc
Include data from related models in payload. Comma separated list.
Comma separated list of fields to exclude from the response
Update a Screen.
/screens/{screens_id}
ID of screen to return
Class Screen
No body
duplicate a Screen.
/screens/{screens_id}/duplicate
ID of screen to return
Class Screen