Skip to content

GetProcessActivitiesDefinition#

Overview#

Service that provides the list of Process Activity Definitions for a specific Flow for the Flow View Definition Page. Supports filtering and pagination.

Input Object#

Name Type Description
Flowpath string The flowpath of the currently selected flow item in the flow.
FilterByMainStep bool Filter by main step checkbox.
Roles List Filter by roles.
Certifications List Filter by certifications.
Type string Filter by the type of the Process Activity Definition.
TextSearch string Search string to filter by the display name of the Process Activity Definition.
Version int Indicates the Flow Version.

Output Object#

Name Type Description
ProcessActivitiesDefinition List List of Process Activity Definitions filtered, sorted, and paginated.
TotalRows int Total number of records before pagination.

How it works#

  1. Validates the input object and mandatory fields (Flowpath and Version).
  2. Loads the Flow object based on Flowpath and Version.
  3. Retrieves all Process Activity Definitions associated with the flow.
  4. Filters PADs based on:
  5. Selected flowpath
  6. FilterByMainStep flag
  7. PAD type (Type)
  8. Text search on display name (TextSearch)
  9. Role names (Roles)
  10. Certification names (Certifications)
  11. Applies sorting rules.
  12. Applies pagination if PageSize and PageNumber are provided.
  13. Returns filtered, sorted, and paginated list along with the total row count.