发布工作流版本¶
将指定工作流中处于 draft(草稿)状态的版本发布为 published(已发布)状态,记录发布时间,并在同一事务中将该工作流定义下其余已发布版本置为 deprecated(已废弃)。该操作不会自动启动一次工作流运行。
POST https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/{workflow_id}/versions/{version_id}/publish
调用前准备¶
请求参数¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$WORKFLOW_ID 和 $VERSION_ID 替换为实际值。
curl -X POST "https://api.moi.matrixorigin.cn/v5/workflow/v2/workflow-apps/$WORKFLOW_ID/versions/$VERSION_ID/publish" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
返回 HTTP 200 及发布后的工作流版本对象,其中 Status 更新为 published、PublishedAt 更新为当前发布时间。版本对象的字段名保持 PascalCase 大小写。
{
"code": "OK",
"msg": "OK",
"data": {
"ID": "ver-002",
"WorkspaceID": "ws-001",
"UserID": "user-001",
"WorkflowDefinitionID": "def-001",
"Version": 2,
"WorkflowJSON": "{\"name\":\"daily-import\",\"nodes\":[]}",
"Status": "published",
"CreatedBy": "user-001",
"CreatedAt": "2026-10-14T09:00:00Z",
"PublishedAt": "2026-10-14T09:15:00Z",
"Type": 1,
"InputSchema": "",
"OutputSchema": "",
"ResultMode": 0,
"Description": "新增输入字段校验",
"RuntimeSpecJSON": ""
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
请求处理成功时为 |
|
string |
请求处理结果说明,成功时为 |
|
object |
发布后的工作流版本对象。 |
|
string |
工作流版本 ID。 |
|
string |
版本所属工作区 ID。 |
|
string |
工作流所有者用户 ID。 |
|
string |
版本所属的工作流定义 ID。 |
|
integer |
正整数版本号,从 |
|
string |
保存的工作流定义 JSON 字符串。 |
|
string |
发布后的版本状态,成功时为 |
|
string |
创建该版本的用户 ID。 |
|
string |
版本创建时间,采用 RFC 3339 格式。 |
|
string |
本次发布时间,采用 RFC 3339 格式。 |
|
integer |
版本类型编码: |
|
string |
保存的输入 Schema JSON 字符串;未设置时为空字符串 |
|
string |
保存的输出 Schema JSON 字符串;未设置时为空字符串 |
|
integer |
结果模式编码: |
|
string |
版本说明;未设置时为空字符串 |
|
string |
保存的运行规范 JSON 字符串;未设置时为空字符串 |
错误响应¶
工作流或版本不存在时返回 404(ErrNotFound);工作流由智能体自动化任务托管时返回 409(ErrWorkflowUpdateManagedByAutomation);目标版本当前不处于 draft 状态(已为 published 或 deprecated)时会因状态前置条件不满足而失败。
{
"code": "ErrWorkflowUpdateManagedByAutomation",
"msg": "工作流由自动化任务托管,请编辑对应的自动化任务"
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码,例如 |
|
string |
可读错误信息。 |