CaseApp-Anforderungen

API-Endpunkte zum Auslösen von Ad-hoc-Fallaufgaben, zum Schließen von Fallinstanzen und zum Auflisten verfügbarer Ad-hoc-Aufgaben über die CaseApp v3-API.

Lösen Sie eine Ad-hoc-Fallaufgabe aus

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

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

Closes a running Case instance.

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.

Listen Sie die Ad-hoc-Aufgaben auf, die Sie für einen Fall ausführen können

Listet die Ad-hoc-Aufgaben auf, die ein Aufrufer für eine Fallinstanz auslösen darf, gruppiert nach der Phase, die die einzelnen Aufgaben besitzt.

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

Gibt die Ad-hoc-Aufgaben zurück, die der Aufrufer auslösen kann, gruppiert nach der Phase, die sie besitzt. Phasen ohne eine Aufgabe, die der Aufrufer auslösen kann, werden weggelassen, sodass eine leere stages -Liste bedeutet, dass der Aufrufer in diesem Fall keine Aufgabe auslösen kann.

Feld	Typ	Beschreibung
Phasen	Array	Die Phasen, die mindestens eine Aufgabe enthalten, die der Aufrufer auslösen kann.
Phasen[].stageId	string	Die Knoten-ID des Fallplans der Phase. Kann null sein.
assets[stage].Label	string	Die Beschriftung der Phase im Fallplan.
Phasen[].Aufgaben	Array	Die Ad-hoc-Aufgaben der Phase, falls geplant.
Phasen[].tasks[].taskName	string	Der Name der Aufgabe, der beim Aufrufen einer Ad-hoc-Fallaufgabe auslösen als taskName übergeben werden soll. Beim Abgleich wird die Groß-/Kleinschreibung beachtet.
Phasen[].tasks[].taskId	string	Die Knoten-ID des Fallplans der Aufgabe. Kann null sein. Der Trigger-Endpunkt akzeptiert dies nicht.

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

Eine aufgeführte Aufgabe ist eine, zu deren Auslösung der Aufrufer berechtigt ist, der Trigger kann aber trotzdem fehlschlagen. Zum Beispiel wird beim Auslösen einer Aufgabe bei einem abgeschlossenen Fall 404 zurückgegeben.

Antwortcodes

Code	Bedeutung
200	Die Liste wurde zurückgegeben. Kann leer sein.
400	Der X-UIPATH-FolderKey -Header fehlt oder ist ungültig.
401	Der Aufrufer ist nicht authentifiziert.
403	Der Aufrufer hat keine Cases.RunAdhocTasks -Gewährung im Zusammenhang mit diesem Fall.
404	Die Instanz ist in dem in X-UIPATH-FolderKey angegebenen Ordner nicht vorhanden, oder es ist keine Fallinstanz.
500	Der Fallplan konnte nicht gelesen werden, oder es ist ein unerwarteter Serverfehler aufgetreten.

Berechtigungen

Erfordert die Berechtigung Cases.RunAdhocTasks , die im Scope der Phase autorisiert wurde, die jede aufgeführte Aufgabe besitzt.