Endpoint: /api/v1/rpa/process

The /api/v1/rpa/process endpoint retrieves, creates, updates, or deletes RPA processes within the system. This endpoint serves as the primary interface for managing process definitions and accessing the related metadata, versions, and execution properties.

Method: GET

This method retrieves a list or details of RPA processes, optionally filtered by environment, status, or other parameters.

Query Parameters

Query parameters determine and control the information returned in the response.


Property	Data type	Scope	Description
Name	String	Optional	Exact name of the process. Note: This field is case sensitive.
Status	String	Optional	Status of the process. Possible values: Draft Finalized
Environment	String	Required	Default

Response Body

Response body returns a list of RPA processes that match the specified criteria (if any).


Property	Description
Count	The number of processes.
Processes	An array of the process objects, each representing a distinct workflow or automation defined within the system. These are the properties related to the process and version are listed below: Process Properties Id : Unique identifier for the process. Name: The name of the process. Current Version : The most recent or the currently active version of the process. Versions : The deployed versions of the process. Each version includes metadata such as the version number, creation date, status ( draft or published), and change history or the associated configurations. Expanded : Indicates whether the process details are fully expanded or collapsed in the response. Possible values: True: Response includes detailed information of the process, such as configurations, parameters, and nested elements. False:Response includes only high-level or summary information. Type: The classification or category of the process. Version Properties Version : The version number of the process. Status : The current state or lifecycle stage of a specific process version. Possible values: Draft Finalized Name : The name assigned to the specific version of a process. Process id : The identification number of the process. The process id identifies the parent process to which the version belongs. Version id : The identification number of the version. This id distinguishes each version from others under the same process.