Endpoint: /api/v1/rpa/process/{id}

The /api/v1/rpa/process/{id} endpoint retrieves detailed information about a specific RPA process identified by the unique id. This endpoint returns metadata, configuration, version history, and optionally expanded data based on the query parameters.

Method: GET

This method retrieves detailed information about a specific RPA process identified by the unique ID.

Query Parameters

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

Property Data type Scope Description
Id String Required A unique identifier of the RPA process to be retrieved. This value must match the exact ID of a process stored in the system. The ID for this endpoint is received from:
  • endpoint:/api/v1/rpa/process
  • Method: Get

Response Body

The response body returns detailed information about a specific RPA process identified by the id provided in the path.

Property Description
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.
Type The category or the nature of the RPA process.
Versions Information related to the version. These properties are related to the version:
  • Id : Unique identifier for the version.
  • Version : The deployed version number of the process.
  • Location : The URL or direct link to access the full details of that specific process version.
  • Status : The current lifecycle state of the process version. Possible values:
    • Draft
    • Finalized
  • ipRegistered : Indicates whether the process version is registered for intellectual property (IP) protection. Possible values:
    • True: Version includes proprietary logic, components, or configurations that are legally recognized or internally tracked as IP.
    • False: Version is not registered as intellectual property (IP) and does not contain any elements that are marked as proprietary or legally protected.
  • Permissions : Specifies the actions the current user is authorized to perform on that specific process version. Possible values:
    • Identifier: A unique identifier for the entity (user or group) to which the permission applies. Identifiers can be a user ID, group ID, or service account name.
    • Type: The type of entity to which the permission is assigned such as a single user, a group of users, or a role-based access level.
    • Role:The level of access or action rights granted to the entity
Variable The list of variables defined in the process. The variables are used to pass data in and out of the process during execution. These properties are related to the variable.
  • Id : Unique identifier for the variable.
  • Name : The name of the variable as defined in the RPA workflow.
  • Type : The data type of the variable.
  • Secure : Indicates whether the variable contains sensitive data. Possible values:
    • True: Variable is secure.
    • False: Variable is not secure.
  • Scope : The scope of the variable. Possible values:
    • User
    • Process
  • Locked : Indicates whether the variable is locked in a specific process. Possible values:
    • True: Variable is locked and cannot be modified.
    • False: Variable can be modified.
  • Attributes : The list of attributes used in the variable.
  • Default Value : None