1. User Guide
  2. Operations
  3. Scheduler Services
  4. External Scheduler Interface
  5. Execution API
  6. Batch Execution API

Batch Execution API

Use the Execution API to trigger a batch.

Attributes
  • batchName - The unique batch code
  • batchType - The object type. For Batch, the batch type should be set to rest.
  • dynamicParamList - List of run time parameters which should be overridden over actual values for this trigger. This is an optional parameter.
  • excludedTasks and held task should be comma separated values
Request Body 
{
    "batchName": "<BATCH_CODE>",
    "batchType": "rest",
    "excludedTasks": "",
    "heldTasks": "", 
	"dynamicParamList":"{\"batchParams\":{\"$FICMISDATE$\":\"<MISDate(yyyy-mm-dd)>\"},\"taskRuntimeParams\":{\"<TASK CODE1>\":{},\"<TASK CODE2>\":{}}}"
}

Sample Response Body

The following Response body is a sample for Success : 200 OK. For more information about status code in the response body, refer to Rest API Status Codes. 


{
    "severity": "info",
    "summary": "Object triggered successfully with Run Id: batch1_demo_ext_api_2023-12-06_1701839464230_1",
    "batchRunId": "batch1_demo_ext_api_2023-12-06_1701839464230_1",
    "details": "Object triggered successfully.",
    "status": "success",
    "statusCode": "0"
}