maestro
latest
false
Maestro API guide
- CaseApp API
- 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.
POST
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/tasks/trigger
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
| X-UIPATH-FolderKey | The folder key of the case instance |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| taskName | string | Yes | The name of the ad-hoc task to trigger, exactly as it resolves in the case plan. Matching is case-sensitive. |
| taskInput | object | No | 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": {}
}
{
"taskName": "string",
"taskInput": {}
}
Response code
200 Success (empty body)
Error responses
| Code | Meaning |
|---|---|
| 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. |
Permissions
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.
POST
{AutomationCloudURL}/{organizationName}/{tenantName}/pims_/api/v3/caseapp/instances/{instanceId}/close
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
| X-UIPATH-FolderKey | The folder key of the case instance |
Response codes
| Code | Meaning |
|---|---|
| 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. |
Permissions
Requires the Cases.Close persona grant.