CaseApp-Anforderungen

API-Endpunkte zum Auslösen von Ad-hoc-Fallaufgaben über die 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.