Execute a Task

Use this API to execute a specified workflow task.

Request URL: /openapi/v1/workflow/execute

HTTP method: POST

Parameter	Type	Required	Description	Example
workflowId	String	Yes	Task ID.	`ex-dd47653n757w`
bizData	Object	Yes	Task execution parameters. The required fields depend on the workflow type. For details, see bizData parameters (SQL task) or bizData parameters (data export).	N/A
reason	String	No	Reason for executing the task.	`release`
source	String	No	Call source.	`api`
toolId	String	No	Tool identifier.	`tool-1`
sourceClient	String	No	Calling client.	`client-1`
sourceSessionId	String	No	External session ID.	`session-1`
skillVersion	String	No	Tool version.	`1.0.0`
language	String	No	Language for response messages.	`enus`

Parameter	Type	Required	Description	Example
executeType	String	Yes	Execution type: immediately: Execute immediately. schedule: Execute on a schedule.	`immediately`
execFailedAction	String	Yes	Action when SQL execution fails: stop: Stop the task after an execution error. ignore: Ignore the execution error and continue the task. rollback: Roll back the task after an execution error.	`stop`
backupFailedAction	String	Yes	Action when the backup fails: stop: Stop the task after a backup failure. ignore: Ignore the backup failure and continue the task.	`stop`
executeTime	String	No	Execution time. Required when executeType is schedule. Format: `yyyy-MM-dd'T'HH:mm:ssZ`.	`2025-09-11T12:34:56Z`

Parameter	Type	Required	Description	Example
executeType	String	Yes	Execution type: immediately: Execute immediately. schedule: Execute on a schedule.	`immediately`
executeTime	String	No	Execution time. Required when executeType is schedule. Format: `yyyy-MM-dd'T'HH:mm:ssZ`.	`2025-09-11T12:34:56Z`

Parameter	Type	Description	Example
success	Boolean	Whether the request was successful.	`true`
requestId	String	OpenAPI request ID.	`"<requestId>"`
data	Object	Empty on success.	`{}`
message	String	Error message.	N/A

{
  "success": true,
  "requestId": "<requestId>",
  "data": {}
}