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

The /api/v1/rpa/jobs/{id}/_execute endpoint manually triggers the execution of a specific RPA job by using the unique job ID.

Method: POST

This method initiates execution of a specific RPA job manually by sending a request to the server.

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 execute. The ID for this endpoint is received from:
  • endpoint:/api/v1/rpa/jobs
  • Method: Get

Request Body

The request body includes input parameters or execution-specific configurations that the job requires at runtime.

Property Description
Variable Array of the arguments, provided for the process. The values provided in the API call override those defined in the finalized process specification.
  • Value : The actual data assigned to an argument. The value is of String type.
  • Name : Name of the argument.
  • Credentials : The user name and password for the argument.
    Note: Credentials are provided only for secured variables.
  • User_indentifier : The unique identifier of the user.