Endpoint /api/v1/rpa/jobs/{id}

The /api/v1/rpa/jobs/{id} endpoint retrieves detailed information of a specific RPA job based on the unique identifier (id).

Method: GET

This method retrieves detailed information about a specific RPA job using its unique job ID.

Query Parameters

Query parameters enable you to customize or control the job trigger during execution.

Property Data type Scope Description
id String Required The unique identifier of the RPA job you want to retrieve. The ID for this endpoint is received from:
  • endpoint:/api/v1/rpa/jobs
  • Method: Get

Response Body

The response body contains complete information of a specific RPA job, based on its unique identifier.

Property Description
Id Unique identifier of the job which is required for, api/v1/rpa/jobs/{id}/_execute Method POST and api/v1/rpa/jobs/{id} Method Get endpoint.
Job_name The name of the job
Process_name The name of the automation process that is executed by the RPA job.
Process_id Unique identification of the process.
Process_version Version of the process selected for the job
Environement_id Unique identifier of the environment.
Status The current status of the Job
Job_execution_strategy Specifies how and when the job must run.
Job_Instances A list or reference to the executions (runs) of the specified RPA job.
Scheduled The schedule according to which Jobs are created.
Priority The priority level of jobs in the execution queue.
active Indicates whether the job is currently active. Possible values:
  • True
  • False
Previous_trigger Indicates the timestamp of the most recent time the job was triggered automatically (by schedule or event) or manually.
Next_trigger Indicates the date and time when the job is scheduled to run next, based on its defined schedule.
Force_user_context Indicates whether the RPA job must run using a specific user context, regardless of how the job is triggered. Possible values:
  • True
  • False
Eo_flow_enabled Indicates whether the job is enabled for Event-Driven Orchestration (EO Flow). When enabled, the job can be automatically triggered as part of a broader event-based automation flow. Possible values
  • True
  • False
Job_context Includes additional metadata or configuration that defines the runtime environment, execution scope, or contextual settings in which the job runs.
  • Machine_id : Unique identifier of the machine or server on which the job is executed.
  • Device_name : Name of the device on which the job is executed.
  • User_identifier : Unique identifier of the user who executed the job.
  • Dynamic_robots : Number of robots dynamically allocated to run the jobs.
  • Robot_id : Unique identifier of the Robot tasked to execute a Job flow
  • Robot_name : Name of the Robot tasked to execute a Job
  • User_name : Name of the user
  • User_details :
    • Id: Unique identifier of the user
    • Display_name:Name of the user
    • Email: Email id of the user
    • Rpa_role: Role of the User in the RPA process.
Preferences Represents a set of configuration options or settings that define job-specific behavior or execution preferences.
  • Id : Unique identifier of the User preference
  • Key : User Preference Key
  • Value : The value assigned to a specific preference key.
  • description : The explanation of the preference.
description The description of the Job
type The type of Job
metadata Collection of supplementary information or custom properties associated with the job.
  • Created_by : Name of the user who created the job
  • Created_at : Time stamp at which the user created the job
  • Updated_by : Name of the user who updated the job
  • Updated_at : Time stamp at which the job is updated
  • Completed_at : Time stamp of the job completion
Start_date The date and time when the job was first executed.
End_date The date and time when the job was last executed.