Create batch configuration

Last update: March 23, 2025
  • Applies to:
  • Experience Manager as a Cloud Service

CREATED FOR:

  • Beginner
  • Intermediate
  • Developer

AEM Forms as a Cloud Service

To use a batch API, create a batch configuration and execute a run based on that configuration. The following video shows a demonstration of creating batch configuration using the API

NOTE
Please make sure the AEM user belongs to
forms-users

Create Batch Configuration

The following is the POST endpoint for creating Batch config

<baseURL>/config

The following is the minimum configuration that needs to be specified when creating batch configuration. This needs to be passed as JSON object in the body of the HTTP request

{
    "configName": "monthlystatements",
    "dataSourceConfigUri": "/conf/batchapi/settings/forms/usc/batch/batchapitutorial",
    "outputTypes": [
        "PDF"
    ],
    "template": "crx:///content/dam/formsanddocuments/formtemplates/custom_fonts.xdp"

}

Verify Batch configuration

To verify the successful creation of batch configuration, you can make a GET request call to the following endpoint

<baseURL>/config/monthlystatements

You only need to pass an empty JSON object in the body of the HTTP request

recommendation-more-help