Batch Tasks Management

Overview

The Batch Tasks Management module in WEDA allows users to create, manage, and execute batch tasks for automating repetitive operations and processing large volumes of data efficiently. This module provides a structured way to define tasks, schedule their execution, and monitor their performance through the WEDA Core API.

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Create Task	POST {Basic API URL}/api/v1/orgs/{orgId}/tasks	Create a new task under an organization
List Tasks	GET {Basic API URL}/api/v1/orgs/{orgId}/tasks	Get list of tasks in a specific organization
Update Task	PUT {Basic API URL}/api/v1/orgs/{orgId}/tasks/{taskId}	Update task's details in an organization
Remove Task	DELETE {Basic API URL}/api/v1/orgs/{orgId}/tasks/{taskId}	Remove task from an organization
Create Batch	POST {Basic API URL}/api/v1/orgs/{orgId}/batches	Create a new batch under an organization
List Batches	GET {Basic API URL}/api/v1/orgs/{orgId}/batches	Get list of batches in an organization
Update Batch	PUT {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}	Update batch's details in an organization
Remove Batch	DELETE {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}	Remove batch from an organization

Constraints & Limitations

General

• API access requires authentication with a valid token
• Organization must exist

Task: Update

• cmd is the command that will be executed.
• payload is the variables in the payload.

Task: Delete

• The task can only be deleted if it is not linked to any batch.

Batch: Create

• cronExpression is required and must be a valid cron expression.
• isEnabled is required, whether the batch is enabled.
• runOnStartup is required, whether the batch should run on startup.
• actions is required, which defines the tasks to be executed in the batch.

Batch: Delete

• Only batches with isEnabled set to false can be deleted.

Advanced Features

Task

Operation	API	Description
Get Task Details	GET {Basic API URL}/api/v1/orgs/{orgId}/tasks/{taskId}	Get details of a specific task in an organization

Batch

Operation	API	Description
Get Batch Details	GET {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}	Get details of a specific batch in an organization
Get Task Results	GET {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}/results	Get execution history of a specific task in an organization
Update Batch Actions	PUT {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}	Update the actions of a specific batch in an organization
Trigger Batch Execution	POST {Basic API URL}api/v1/orgs/{orgId}/batches/{batchId}:start	Trigger the execution of a specific batch in an organization
Get Triggered Batches	GET {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}/triggers	Retrieve the list of batch trigger IDs for a specific batch
Enable/Disable Batch	PUT {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}/status	Enable or disable a specific batch in an organization
Get Device Batch	GET {Basic API URL}/api/v1/orgs/{orgId}/batches/{batchId}/devices	Retrieve the list of device IDs associated with a specific batch

---

Last updated on Apr-8, 2026 | Version 1.0.0