创建工作流任务

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

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

请求方法：POST

请求参数

参数	类型	是否必选	说明	示例
module	String	是	任务类型： sqlTask：SQL 任务 dataExport：数据导出	sqlTask
bizData	Object	是	任务详情。根据 module 参数的不同，需要传入不同的参数。具体请参见本文的 bizData 参数（SQL 任务）或 bizData 参数（数据导出）。	无
source	String	否	调用来源。	api
toolId	String	否	工具标识。	tool-1
sourceClient	String	否	调用客户端。	client-1
sourceSessionId	String	否	外部会话 ID。	session-1
skillVersion	String	否	工具版本。	1.0.0
language	String	否	返回信息语言。	zh_cn
reason	String	否	创建原因。	release

bizData 参数（SQL 任务）

参数	类型	是否必选	说明	示例
name	String	是	任务名称。	"test"
datasourceId	String	是	任务关联的数据源 ID。	"ds-dbiddumxp4h"
dbName	String	是	任务关联的数据库名称。	"ght"
schemaName	String	否	任务关联的 Schema 名称。	"public"
dbGroupId	String	否	任务关联的数据库分组 ID，分组任务场景使用。	"group1"
estimatedAffectedRows	Long	是	预估影响行数。	12
executorType	String	否	执行人类型： creator：提交人执行。 approver：审批人执行。 auto：自动执行。 默认：creator。	"creator"
sqlInputType	String	否	SQL 文本类型： text：SQL 文本。 file：SQL 文件。 默认值：text。	"text"
sqlText	String	是	SQL 文本内容。	"select version();"
rollbackTextType	String	否	回滚文本类型： text：SQL 文本。 file：SQL 文件。 默认值：text。	"text"
rollbackText	String	否	回滚文本内容。	"drop table if exists t1;"
comment	String	否	备注。	"release change"

bizData 参数（数据导出）

参数	类型	是否必选	说明	示例
name	String	是	任务名称。	"test"
datasourceId	String	是	任务关联的数据源 ID，必须以 ds- 开头。	"ds-dbiddumxp4h"
databaseName	String	是	任务关联的数据库名称，兼容 dbName。	"ght"
dbName	String	否	数据库名称。传入后会同步到 databaseName。	"ght"
schemaName	String	否	任务关联的 Schema 名称。	"public"
type	String	是	导出类型。当前 OpenAPI 创建任务仅支持 sql。	"sql"
sqlStatement	String	是	导出 SQL，兼容 sqlText。	"select version();"
sqlText	String	否	导出 SQL。传入后会转换为 sqlStatement。	"select version();"
content	String	是	导出内容，兼容 contentType：data、structure 或 dataAndStructure。	"data"
contentType	String	否	导出内容：data、structure 或 dataAndStructure。	"data"
fileType	String	是	文件类型：sql、csv、excel、json、xml 或 txt。	"excel"
charset	String	是	字符集：utf8、UTF-8 或 gbk。	"utf8"
executorType	String	是	任务执行人：creator、approver 或 auto。	"creator"

返回参数

参数	类型	说明	示例
success	Boolean	请求是否成功。	true
requestId	String	OpenAPI 请求 ID。	"<requestId>"
data	String	任务 ID。	"st-dd46vm7divwx"
message	String	异常信息。	无

调用成功示例

{
  "success": true,
  "requestId": "<requestId>",
  "data": "st-dd46vm7divwx"
}