maestro
latest
false
Maestro API 指南
- 案例应用程序 API
- 案例应用程序请求
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
用于通过 CaseApp v3 API 触发临时案例任务的 API 端点。
触发临时案例任务
在正在运行的 Maestro Case 实例上触发一个手动触发（临时）任务，由其案例计划名称标识。
发布
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/trigger
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
| X-UIPATH-文件夹密钥 | 案例实例的文件夹键 |
请求正文
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 任务名称 | 字符串 | 是 | 要触发的临时任务的名称，与其在案例计划中解析的完全相同。匹配区分大小写。 |
| 任务输入 | object | 否 | 自由格式 JSON 对象，作为嵌套有效负载按原义转发到已触发的任务，例如审批引用或决策数据。平台不会解释此有效负载，也不会对其进行架构验证，也不会绑定到任务已声明的输入。 |
{
"taskName": "string",
"taskInput": {}
}
{
"taskName": "string",
"taskInput": {}
}
响应代码
200 成功（正文为空）
错误响应
| 代码 | 意义 |
|---|---|
| 400 | 请求正文缺失或无效。 |
| 401 | 调用者未通过身份验证。 |
| 403 | 调用者缺少此任务所需的权限。 |
| 404 | 案例实例不存在，或者案例计划中不存在同名临时任务。仅适用于带有“临时”标记的任务进入条件符合条件 — 其他名称返回 404。 |
| 500 | 服务器发生意外错误。 |
权限
需要 Cases.RunAdhocTasks 权限，该权限在拥有请求的任务的阶段范围内获得授权。
关闭案例实例
关闭正在运行的 Maestro Case 实例。
发布
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
| X-UIPATH-文件夹密钥 | 案例实例的文件夹键 |
响应代码
| 代码 | 意义 |
|---|---|
| 200 | 实例已转换为 Canceling。工作器异步完成向 Cancelled 的转移。已经终端的实例按原样返回其当前状态。 |
| 400 | 实例已达到 Completed 上限，无法取消。 |
| 401 | 调用者未通过身份验证。 |
| 403 | 调用者缺少此实例所需的权限。 |
| 404 | 实例 ID 无法解析为案例实例。 |
权限
需要 Cases.Close 角色授权。