Skip to main content

Update an existing batch

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

Update an existing batch by ID.

Usage
PUT orgs/{orgId}/batches/{batchId}

Parameters

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

Request body

  • input (CreateUpdateBatchDto, required): the batch definition, including name, organization, schedule, and actions.
    • Name (string, required): the name of the batch, maximum 100 characters.
    • OrgId (string, required): the ID of the organization the batch belongs to.
    • CronExpression (string, required): Quartz cron expression (e.g. '0/15 * * * * ?').
    • IsEnabled (bool, required): whether the batch is enabled, default is true.
    • RunOnStartup (bool, optional): whether to run the batch on application startup, default is false.
    • Actions (List<CreateBatchActionDto>, optional): the list of actions within the batch.
      • DeviceId (string, required): the ID of the device.
      • TaskId (Guid, required): the ID of the task.
      • Parameters (string, optional): the parameters for the task, default is an empty string.

Responses

  • 200 OK: returns the updated BatchDto.
  • 400 Bad Request: validation error.
  • 404 Not Found: batch not found.
  • 409 Conflict: batch name already exists.

Security
This API requires authentication.

Request​

Responses​

OK