CaseApp requests

API endpoints for triggering ad-hoc case tasks through the CaseApp v3 API.

Trigger an ad-hoc case task

Triggers one manually-triggered (ad-hoc) task, identified by its case plan name, on a running Maestro Case instance.

发布

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/trigger

请求标头

密钥	值
授权	承载
X-UIPATH-FolderKey	The folder key of the case instance

请求正文

字段	类型	必填	描述
taskName	字符串	是	The name of the ad-hoc task to trigger, exactly as it resolves in the case plan. Matching is case-sensitive.
taskInput	object	否	A free-form JSON object forwarded verbatim to the triggered task as a nested payload, for example approval references or decision data. The platform doesn't interpret or schema-validate this payload, and it isn't bound to the task's declared inputs.

{
  "taskName": "string",
  "taskInput": {}
}

响应代码

200 Success (empty body)

错误响应

代码	意义
400	The request body is missing or invalid.
401	The caller is not authenticated.
403	The caller lacks the required permission for this task.
404	The case instance doesn't exist, or no ad-hoc task with that name exists on the case plan. Only tasks with an "adhoc" entry condition are eligible — other names return 404.
500	An unexpected server error occurred.

权限

Requires the Cases.RunAdhocTasks permission, authorized at the scope of the stage that owns the requested task.

Close a case instance

Closes a running Maestro Case instance.

发布

{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close

请求标头

密钥	值
授权	承载
X-UIPATH-FolderKey	The folder key of the case instance

响应代码

代码	意义
200	The instance transitioned to Canceling. The worker completes the shift to Cancelled asynchronously. An already-terminal instance returns its current status unchanged.
400	The instance has already reached Completed and can't be cancelled.
401	The caller is not authenticated.
403	The caller lacks the required permission for this instance.
404	The instance ID doesn't resolve to a case instance.

权限

Requires the Cases.Close persona grant.