Skip to main content

创建工作流任务

创建一个新的工作流任务。

请求地址:/openapi/v1/workflow/create

请求方法:POST

请求参数

参数类型是否必选说明示例
moduleString任务类型:
  • sqlTask:SQL 任务
  • dataExport:数据导出
sqlTask
bizDataObject任务详情。根据 module 参数的不同,需要传入不同的参数。具体请参见本文的 bizData 参数(SQL 任务)bizData 参数(数据导出)

bizData 参数(SQL 任务)

参数类型是否必选说明示例
nameString任务名称。"test"
datasourceIdString任务关联的数据源 ID。"ds-dbiddumxp4h"
dbNameString任务关联的数据库名称。"ght"
schemaNameString任务关联的 Schema 名称。"public"
dbGroupIdString任务关联的数据库分组 ID(与 datasourceId 互斥,至少填充一个)。"group1"
estimatedAffectedRowsInteger预估影响行数。12
executorTypeString执行人类型:
  • creator:提交人执行。
  • approver:审批人执行。
  • auto:自动执行。
  • <执行人名称>:直接显示具体执行人的名称。
默认:creator
"creator"
sqlInputTypeStringSQL 文本类型:
  • text:SQL 文本。
  • file:SQL 文件。
默认值:text
"text"
sqlTextStringSQL 文本内容。"select version();"
rollbackTextTypeString回滚文本类型:
  • text:SQL 文本。
  • file:SQL 文件。
默认值:text
"text"
rollbackTextString回滚文本内容。"drop table if exists t1;"

bizData 参数(数据导出)

参数类型是否必选说明示例
nameString任务名称。"test"
datasourceIdString任务关联的数据源 ID。"ds-dbiddumxp4h"
dbNameString任务关联的数据库名称。"ght"
typeString导出类型:
  • sql:导出为 SQL 语句。
  • database:导出库。
  • table:导出表。
"sql"
sqlTextStringSQL 文本。typesql 时必传。"select version();"
contentString导出内容类型:
  • data:仅数据。
  • structure:仅结构。
  • dataAndStructure:数据和结构。
"data"
fileTypeString导出文件类型:
  • sql:导出为 SQL 文件。
  • excel:导出为 Excel 文件。
  • csv:导出为 CSV 文件。
"excel"
reasonString导出原因。"test"
executorTypeString任务执行人:
  • creator:提交人执行。
  • approver:审批人执行。
  • auto:自动执行。
"creator"

返回参数

参数类型说明示例
successBoolean请求是否成功。true
dataString任务 ID。"st-dd46vm7divwx"
errorCodeString错误码。
messageString异常信息。

调用成功示例

{
"success": true,
"data": "st-dd46vm7divwx"
}