更新工作流模板¶

替换一个工作流模板的内容。该接口按完整定义更新；要保留的字段也应在请求中提供。

PUT https://api.moi.matrixorigin.cn/v5/workflow-templates/{id}

调用前准备¶

先查看工作流模板详情，确认要保留和修改的内容。准备具有目标工作区访问权限的个人访问令牌和目标工作区 ID。更新内置模板需要管理员权限。

路径参数¶

参数	类型	是否必填	说明
`id`	integer	是	模板 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID、$TEMPLATE_ID 和示例中的模板内容替换为实际值。

输入示例

curl -X PUT "https://api.moi.matrixorigin.cn/v5/workflow-templates/$TEMPLATE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "daily-import-template",
    "description": "更新后的每日导入工作流模板",
    "dsl_yaml": "workflow:\\n  name: daily-import\\n  root: main\\nroot:\\n  chain: []\\n",
    "runtime_fields": "{\"fields\":[]}",
    "is_builtin": false
  }'

参数说明

参数	类型	是否必填	说明
`name`	string	是	更新后的模板名称。自定义模板在当前工作区、当前语言下不能重名。
`description`	string	否	更新后的模板说明；省略时清空。
`dsl_yaml`	string	是	更新后的工作流 DSL YAML。
`runtime_fields`	string	否	更新后的运行时字段 JSON 文本；省略时清空。提供时必须是合法 JSON。
`is_builtin`	boolean	否	不能变更模板类型。更新自定义模板时传 `true` 会被拒绝。
`template_key`	string	否	更新内置模板时可省略以保留原值；自定义模板中忽略。

成功响应¶

成功时返回 200 和更新后的完整模板。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 12,
    "name": "daily-import-template",
    "description": "更新后的每日导入工作流模板",
    "dsl_yaml": "workflow: {}",
    "is_builtin": false,
    "updated_at": "2026-08-18T11:00:00Z"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

模板信息

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	integer	模板 ID。
`workspace_id`	string	所属工作区 ID；内置模板为空字符串。
`created_by`	string	创建者标识。
`updated_by`	string	最后更新者标识。
`template_key`	string	内置模板标识；自定义模板为空字符串。
`name`	string	更新后的模板名称。
`description`	string	更新后的模板说明。
`language`	string	模板语言。
`dsl_yaml`	string	更新后的工作流 DSL YAML。
`runtime_fields`	string	更新后的运行时字段 JSON 文本。
`is_builtin`	boolean	是否为内置模板。
`created_at`	string	创建时间；服务端未提供时省略。
`updated_at`	string	最后更新时间；服务端未提供时省略。

错误响应¶

响应示例

{
  "code": "ErrTemplateTypeImmutable",
  "msg": "工作流模板类型不能修改",
  "data": null
}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	可读错误信息。
`data`	null	错误响应中为 `null`。

最后更新于 2026 年 9 月 28 日