CaseApp-Anforderungen

API endpoints for triggering ad-hoc case tasks, closing case instances, and listing available ad-hoc tasks through the CaseApp v3 API.

Lösen Sie eine Ad-hoc-Fallaufgabe aus

Löst eine manuell ausgelöste (Ad-hoc)-Aufgabe, die durch den Namen des Fallplans identifiziert wird, für eine laufende Maestro Case Instanz aus.

Posten

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber
X-UIPATH-Ordnerschlüssel	Der Ordnerschlüssel der Fallinstanz

Anforderungstext

Feld	Typ	Erforderlich	Beschreibung
taskName	string	Ja	Der Name der auszulösenden Ad-hoc-Aufgabe, genau wie er im Fallplan aufgelöst wird. Beim Abgleich wird die Groß-/Kleinschreibung beachtet.
taskInput	object	Nein	Ein Freiform-JSON-Objekt, das als verschachtelte Nutzlast an die ausgelöste Aufgabe weitergeleitet wird, z. B. Genehmigungsreferenzen oder Entscheidungsdaten. Die Plattform interpretiert oder schemavalidiert diese Nutzlast nicht und sie ist nicht an die deklarierten Eingaben der Aufgabe gebunden.

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

Antwortcode

200 Erfolg (leerer Textkörper)

Fehlerantworten

Code	Bedeutung
400	Der Anforderungstext fehlt oder ist ungültig.
401	Der Aufrufer ist nicht authentifiziert.
403	Dem Aufrufer fehlt die erforderliche Berechtigung für diese Aufgabe.
404	Die Fallinstanz ist nicht vorhanden, oder im Fallplan ist keine Ad-hoc-Aufgabe mit diesem Namen vorhanden. Nur Aufgaben mit einem „adhoc“- Eintrittsbedingung sind berechtigt – andere Namen geben 404 zurück.
500	Ein unerwarteter Serverfehler ist aufgetreten.

Berechtigungen

Erfordert die Berechtigung Cases.RunAdhocTasks, die im Scope der Phase autorisiert wurde, die die angeforderte Aufgabe besitzt.

Schließen Sie eine Fallinstanz

Schließt eine laufende Maestro Case-Instanz.

Posten

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber
X-UIPATH-Ordnerschlüssel	Der Ordnerschlüssel der Fallinstanz

Antwortcodes

Code	Bedeutung
200	Die Instanz wurde an Canceling übergeben. Der Worker schließt den Wechsel zu Cancelled asynchron ab. Eine bereits beendete Instanz gibt ihren aktuellen Status unverändert zurück.
400	Die Instanz hat bereits Completed erreicht und kann nicht abgebrochen werden.
401	Der Aufrufer ist nicht authentifiziert.
403	Dem Aufrufer fehlt die erforderliche Berechtigung für diese Instanz.
404	Die Instanz-ID wird nicht in eine Fallinstanz aufgelöst.

Berechtigungen

Erfordert die Persona-Gewährung Cases.Close.

List the ad-hoc tasks you can run on a case

Lists the ad-hoc tasks a caller is permitted to trigger on a case instance, grouped by the stage that owns each task.

Abrufen

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

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber
X-UIPATH-Ordnerschlüssel	Der Ordnerschlüssel der Fallinstanz

Antworttext

Returns the ad-hoc tasks the caller can trigger, grouped by the stage that owns them. Stages without a task the caller can trigger are omitted, so an empty stages list means the caller can't trigger any task on this case.

Feld	Typ	Beschreibung
stages	Array	The stages that contain at least one task the caller can trigger.
stages[].stageId	string	The stage's case plan node ID. Can be null.
stages[].stageLabel	string	The stage's label in the case plan.
stages[].tasks	Array	The stage's ad-hoc tasks, in case plan order.
stages[].tasks[].taskName	string	The task's name, to pass as taskName when calling Trigger an ad-hoc case task. Matching is case-sensitive.
stages[].tasks[].taskId	string	The task's case plan node ID. Can be null. The trigger endpoint doesn't accept it.

{
  "stages": [
    {
      "stageId": "string",
      "stageLabel": "string",
      "tasks": [
        {
          "taskName": "string",
          "taskId": "string"
        }
      ]
    }
  ]
}

A listed task is one the caller is authorized to trigger, but the trigger can still fail. For example, triggering a task on a completed case returns 404.

Antwortcodes

Code	Bedeutung
200	The list was returned. It can be empty.
400	The X-UIPATH-FolderKey header is missing or invalid.
401	Der Aufrufer ist nicht authentifiziert.
403	The caller has no Cases.RunAdhocTasks grant related to this case.
404	The instance doesn't exist in the folder specified in X-UIPATH-FolderKey, or it isn't a case instance.
500	The case plan couldn't be read, or an unexpected server error occurred.

Berechtigungen

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