Endpoint: /api/v1/rpa/jobs

The /api/v1/rpa/jobs endpoint retrieves a list of all RPA job instances in a system. This endpoint provides access to metadata and status information for each job that has been executed, is running, or has been scheduled.

Method: GET

This method retrieves a list of RPA job executions that include scheduled, running, completed, failed, or cancelled jobs based on applied filters.

Query Parameters

Query parameters filter and search the list of job executions based on environment and type.

Property Data type Scope Description
Environment String Required This parameter filters job by the environment in which the jobs were executed. For this endpoint, the default value is considered.
Type String Optional This parameter filters job by the execution mode. For this endpoint, Unattended mode of execution is considered, by default.

Response Body

The response body provides a structured list of job executions with all metadata details.

Property Description
Id Unique identifier of an individual RPA job instance.
Status Indicates the current status of the job.
Type The type of process execution for the job. Unattended mode of execution is considered, by default
Description The description of the job.
Active Indicates whether the job is currently active. Possible values:
  • True
  • False
eoEnabled Indicates whether Exception Orchestration (EO) is enabled for the job. Possible values:
  • True: The job is set up to integrate with exception handling logic and errors during execution are managed through custom workflows.
  • False: No special EO handling is configured; errors are managed as default failures.
Job Name The name specified for the job.
Process Name The name of the RPA process or workflow for the selected job.
Process id The unique identifier of the process.
Process version The version of the process for the selected job.
Environment id The unique identifier of the environment.
Start date The date and time when the job was first executed.
End date The date and time when the job was last executed.
Created by Name of the user who created the job.
Next execution The date and time for the next job execution.