3.2.1 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.

Request Body

{
    "batchName": "<Batch_code>",
    "batchType": "rest",
    "dynamicParamList": {
        "batchParams": {
            "$FICMISDATE$": "<MISDate(yyyy-mm-dd)>"
    }
     }
}

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: B2001_2022-05-20_1653041947296_1",
    "batchRunId": "B2001_2022-05-20_1653041947296_1",
    "details": "Object triggered successfully.",
    "statusCode": "0",
    "status": "success"
}