功能介绍
以同步执行方式启动工作流(仅快速模式工作流支持),暂不支持国际站局点调用
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/fgs/workflows/{workflow_id}/sync-executions
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见获取项目ID。 最小长度:1 最大长度:64 |
workflow_id |
是 |
String |
工作流定义ID 最小长度:1 最大长度:512 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
headers |
否 |
Object |
执行时需要的Header |
input |
是 |
Object |
定义执行时的入参,支持使用JSONPATH进行映射,以及指定默认值 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
execution_id |
String |
流程实例ID 最小长度:1 最大长度:64 |
status |
String |
流程执行最终状态 最小长度:1 最大长度:64 枚举值:
|
output |
Object |
工作流的执行结果,JSON格式,仅在status为success时有值 |
errors |
流程执行错误信息,仅在status为fail时有值 |
|
begin_time |
String |
流程实例创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
end_time |
String |
流程实例结束时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
node_id |
String |
流程节点ID 最小长度:1 最大长度:64 |
error_message |
String |
错误详细信息 最小长度:1 最大长度:2048 |
begin_time |
String |
流程实例创建时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
end_time |
String |
流程实例结束时间,格式:yyyy-MM-ddTHH:mm:ssZ,UTC时间 最小长度:0 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
同步执行工作流。
POST /{project_id}/fgs/workflows/{workflow_id}/sync-executions { "headers" : { "tenantId" : "user1" }, "input" : { "arg1" : "argument_1", "arg2" : "argument_2" } }
响应示例
状态码: 200
Success
{ "execution_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "status" : "success", "output" : { "result" : 200, "message" : "success" }, "errors" : [ { "node_id" : "48aff955-ea10-4ffd-b426-190bc192dc14", "error_message" : "Exception happened", "begin_time" : "2021-01-01T00:00:00Z", "end_time" : "2021-01-01T00:00:00Z" } ], "begin_time" : "2021-01-01T00:00:00Z", "end_time" : "2021-01-01T00:00:00Z" }
状态码
状态码 |
描述 |
---|---|
200 |
Success |
400 |
Bad Request |
404 |
Bad Request |
500 |
Internal Server Error |
错误码
请参见错误码。