删除工作流模板¶
删除一个工作流模板。删除自定义模板仅影响当前工作区;删除内置模板需要管理员权限。此操作不可逆。
DELETE https://moi.matrixorigin.cn/newmoi/workflow-templates/{id}
调用前准备¶
先查询工作流模板详情,确认要删除的模板。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。删除内置模板还需要管理员权限。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$TEMPLATE_ID:要删除的模板 ID。
路径参数¶
参数 |
类型 |
说明 |
|---|---|---|
|
integer |
大于 |
请求示例¶
curl -X DELETE "https://moi.matrixorigin.cn/newmoi/workflow-templates/$TEMPLATE_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
成功响应¶
当响应中的 code 为 OK 且 data.message 为 deleted 时,模板已删除。删除不可逆。
{
"code": "OK",
"msg": "OK",
"data": {
"message": "deleted"
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
string |
固定为 |
错误响应¶
失败响应的 data 为 null。
{
"code": "ErrSeedTemplateManaged",
"msg": "系统管理的模板不允许修改",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
|
使用列表响应中的 |
|
|
请求上下文中缺少工作区。 |
传入有效的 |
|
|
尝试删除由系统管理的内置模板。 |
不要删除该模板。 |
|
|
删除内置模板时当前身份不是管理员。 |
使用有管理员权限的身份。 |
|
|
模板不存在,或自定义模板不属于当前工作区。 |
核对模板 ID 和工作区。 |
|
|
服务端未能删除模板。 |
稍后重试。 |
后续操作¶
查询工作流模板列表确认模板已移除。
最后更新于