- 简介
- 入门指南
- 可在任何画布上构建
- 使用案例构建
- 使用流构建
- Build with BPMN
- 运营
- 监控
- 正在优化
- 参考信息
案例应用程序请求
用于触发临时案例任务、关闭案例实例以及通过 CaseApp v3 API 列出可用的临时任务的 API 端点。
触发临时案例任务
Triggers one manually-triggered (ad-hoc) task, identified by its case plan name, on a running Case instance.
发布
{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 权限，该权限在拥有请求的任务的阶段范围内获得授权。
关闭案例实例
Closes a running Case instance.
发布
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
| X-UIPATH-文件夹密钥 | 案例实例的文件夹键 |
响应代码
| 代码 | 意义 |
|---|---|
| 200 | 实例已转换为 Canceling。工作器异步完成向 Cancelled 的转移。已经终端的实例按原样返回其当前状态。 |
| 400 | 实例已达到 Completed 上限，无法取消。 |
| 401 | 调用者未通过身份验证。 |
| 403 | 调用者缺少此实例所需的权限。 |
| 404 | 实例 ID 无法解析为案例实例。 |
权限
需要 Cases.Close 角色授权。
列出您可以对案例运行的临时任务
列出允许调用者在案例实例上触发的临时任务，并按拥有每个任务的阶段分组。
获取
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/adhoc
请求标头
| 密钥 | 值 |
|---|---|
| 授权 | 承载 |
| X-UIPATH-文件夹密钥 | 案例实例的文件夹键 |
响应正文
返回调用者可以触发的临时任务，并按拥有这些任务的阶段分组。没有调用者可以触发的任务的阶段将被省略，因此空的stages列表意味着调用者无法触发此案例中的任何任务。
| 字段 | 类型 | 描述 |
|---|---|---|
| 阶段 | 数组 | 至少包含调用者可以触发的一个任务的阶段。 |
| stage[].stageId | 字符串 | 该阶段的案例计划节点 ID。可以是null 。 |
| stage[].stageLabel | 字符串 | 案例计划中的阶段标签。 |
| stage[].tasks | 数组 | 按案例计划顺序排列的阶段临时任务。 |
| stages[].tasks[].taskName | 字符串 | 任务名称，在调用触发临时案例任务时作为taskName传递。匹配区分大小写。 |
| stages[].tasks[].taskId | 字符串 | 任务的案例计划节点 ID。可以是null 。触发器端点不接受它。 |
{
"stages": [
{
"stageId": "string",
"stageLabel": "string",
"tasks": [
{
"taskName": "string",
"taskId": "string"
}
]
}
]
}
{
"stages": [
{
"stageId": "string",
"stageLabel": "string",
"tasks": [
{
"taskName": "string",
"taskId": "string"
}
]
}
]
}
列出的任务是调用者有权触发的任务，但触发器仍可能失败。例如，在已完成的案例上触发任务会返回 404。
响应代码
| 代码 | 意义 |
|---|---|
| 200 | 列表已返回。可以为空。 |
| 400 | X-UIPATH-FolderKey标头缺失或无效。 |
| 401 | 调用者未通过身份验证。 |
| 403 | 调用者没有与此案例相关的Cases.RunAdhocTasks授权。 |
| 404 | 该实例不存在于X-UIPATH-FolderKey中指定的文件夹中，或者它不是案例实例。 |
| 500 | 无法读取案例计划，或发生意外服务器错误。 |
权限
需要Cases.RunAdhocTasks权限，该权限在拥有每个列出的任务的阶段范围内获得授权。