触发文件工作流¶
触发与指定文件关联的工作流,并返回实际触发的数量。
POST https://moi.matrixorigin.cn/newmoi/catalog/file/trigger_workflow
调用前准备¶
先查询文件列表取得目标文件和所属卷。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、卷 ID 和文件 ID 列表。
请求体¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/file/trigger_workflow" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"volume_id": '"$VOLUME_ID"',
"file_ids": ["'"$FILE_ID"'"]
}'
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
文件所属根卷 ID。 |
|
string(字符串数组) |
是 |
要触发的文件 ID 列表。 |
成功响应¶
成功时返回 200,triggered 表示本次实际触发的关联工作流数量。
{
"code": "OK",
"msg": "OK",
"data": {
"triggered": 1
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
本次实际触发的关联工作流数量。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。 |
|
string |
错误信息。 |
|
null |
错误响应中的附加数据;本示例为 |
最后更新于