Batch Group Execution API

Use the Execution API to trigger a batch group.

• Attributes
  • batchName - The unique batch code.
  • batchType - The object type. For Batchgroup, the batch type should be set to group.
  • dynamicParamList - List of run time parameters which should be overridden over actual values for this trigger. This is an optional parameter.
  • Exclude and held tasks should be comma separated values of batch code.

Request Body

{
    "batchName": "<BATCHGROUP CODE>",
	"batchType": "group",
	"excludedTasks": "",
    "heldTasks": "",
    "dynamicParamList":"[{\"batchName\":\"<BATCH_CODE1>\",\"batchParams\":{\"$FICMISDATE$\":\"<MISDate(yyyy-mm-dd)>\"},\"taskRuntimeParams\":{\"<TASK CODE1>\":{},\"<TASK CODE2>\":{}}},{\"batchName\":\"<BATCH_CODE2>\",\"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: batchGroup1_demo_ext_api_2023-12-06_1701840572429_1",
    "batchRunId": "batchGroup1_demo_ext_api_2023-12-06_1701840572429_1",
    "details": "Object triggered successfully.",
    "status": "success",
    "statusCode": "0"
}