Create a batch

In order for a dataset to ingest data, it must have a batch associated with it. Using the id value of an existing dataset, you can create a batch by making a POST request to the /batches endpoint in the Catalog API.

API format

POST /batches


curl -X POST '' \
  -H 'accept: application/json' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key : {API_KEY}' \
  -H 'content-type: application/json' \
  -d '{
Property Description
datasetId The id of the dataset the batch will be associated with.


A successful response returns HTTP Status 201 (Created) and a response object containing details of the newly created batch, including its id, a read-only, system generated string.

    "id": "5d01230fc78a4e4f8c0c6b387b4b8d1c",
    "imsOrg": "{IMS_ORG}",
    "updated": 1552694873602,
    "status": "loading",
    "created": 1552694873602,
    "relatedObjects": [
            "type": "dataSet",
            "id": "5c8c3c555033b814b69f947f"
    "version": "1.0.0",
    "tags": {
        "acp_producer": [
        "acp_stagePath": [
        "use_plan_b_batch_status": [
    "createdUser": "{CREATED_BY}",
    "updatedUser": "{CREATED_BY}",
    "externalId": "5d01230fc78a4e4f8c0c6b387b4b8d1c",
    "createdClient": "{CREATED_CLIENT}",
    "inputFormat": {
        "format": "parquet"

On this page