Skip to main content

Create a new batch under org

POST 

/platform/solutions/api/v1/orgs/{orgId}/batches

Create a new batch for a specific organization.

Usage
POST /orgs/{orgId}/batches

Parameters

  • orgId (string, required): the ID of the organization.

Request body

  • input (CreateUpdateBatchByOrgIdDto, required): the batch definition, including name, schedule, and actions.
    • orgId (string, required): Organization ID.
    • Name (string, required): Batch name (max 100 characters).
    • CronExpression (string, required): Quartz cron expression (e.g. '0/15 * * * * ?').
    • IsEnabled (bool, required): Whether the batch is enabled.
    • RunOnStartup (bool, required): Whether to run batch on startup.
    • Actions (list, optional): Batch actions.

Responses

  • 201 Created: returns the created BatchDto.
  • 400 Bad Request: invalid request (missing or invalid fields).
  • 404 Not Found: org not found.
  • 409 Conflict: batch name already exists.

Security
This API requires authentication.

Request

Responses

Returns the created BatchDto