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.
| 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
- Validates the input object and mandatory fields (Flowpath and Version).
- Loads the Flow object based on Flowpath and Version.
- Retrieves all Process Activity Definitions associated with the flow.
- Filters PADs based on:
- Selected flowpath
- FilterByMainStep flag
- PAD type (Type)
- Text search on display name (TextSearch)
- Role names (Roles)
- Certification names (Certifications)
- Applies sorting rules.
- Applies pagination if PageSize and PageNumber are provided.
- Returns filtered, sorted, and paginated list along with the total row count.