Prozess durch Aufrufen einer Business Automation Workflow -REST-API starten

Sie können durch das Aufrufen einer REST-API einen Prozess starten und eine neue Prozessinstanz erstellen.

Vorbereitende Schritte

Sie kennen den Modellnamen und das Containerakronym des Prozesses, den Sie starten möchten.
Die Benutzer der Anwendung müssen authentifizierte Benutzer und zum Starten einer Instanz des Prozesses berechtigt sein.

Achtung: -REST-API-Aufrufe, die eine Liste von Objekten zurückgeben, z. B. GET /processes oder GET /user-tasks , können Abfrageparameter wie den Modellnamen, den Containernamen oder die Prozess-ID enthalten. Wenn vom Parameterwert auf ein Objekt verwiesen wird, das nicht vorhanden ist (weil die Prozess-ID zum Beispiel einen Schreibfehler aufweist), wird ein Fehler ausgelöst. Stattdessen enthält das auf den Aufruf zurückgegebene JSON-Objekt eine Liste ohne Inhalt. Informationen zu den API-Aufrufen finden Sie unter Workflow-REST-APIs.

Vorgehensweise

Rufen Sie die REST-API processes auf und geben Sie den Modellnamen und das Containerakronym im Aufruf an.
Beispiel: Wenn Sie eine Instanz des Prozesses für die Auftragsbearbeitung starten möchten, das zur Prozessapp mit dem Akronym ORDMAN1 gehört, können Sie den folgenden REST-API-Aufruf verwenden:
```
POST /bpm/processes?model=OrderManagement&container=ORDMAN1 
```
Optional: Übergeben Sie die Geschäftsdaten, die der Prozess starten muss, als Eingabeparameter in einem JSON-Objekt im Anforderungshauptteil des Aufrufs.
Beispiel: Wenn zum Starten des Prozesses für die Auftragsbearbeitung eine Auftragsnummer und eine Kundenname erforderlich sind, können Sie das folgende JSON-Objekt übergeben:
```
...
{
   "input":[
      {
         "name":"orderNumber",
         "data":"5"
       },
       {
          "name":"customerName",
          "data":{
             "firstName":"John",
             "lastName":"Doe"
          }
       }
   ]
}
```
Wenn zusätzliche Informationen zur neuen Prozessinstanz vom Aufruf zurückgegeben werden sollen, schließen Sie den Parameter optional_parts in die Abfrage ein.
Sie können Daten, die gültigen Aktionen für die neue Instanz oder beides zurückgeben lassen.
Beispiel: Wenn sowohl die Daten als auch die gültigen Aktionen für die neue Instanz des Prozesses für die Auftragsbearbeitung zurückgegeben werden sollen, können Sie den folgenden Aufruf verwenden:
```
POST /bpm/processes?model=OrderManagement&container=ORDMAN1&optional_parts=data,actions
```

Ergebnisse

Eine neue Instanz des Prozesses wird gestartet. Abhängig von den im REST-Aufruf enthaltenen Parametern wird die entsprechende Version der Instanz gestartet:
- Wenn Sie die Versions- und Verzweigungsnamenparameter oder nur die Versionsparameter einschließen, wird eine Instanz der angegebenen Version gestartet.
- Wenn Sie weder die Parameter 'version' noch 'branch_name' oder nur einen Parameter 'branch_name' angeben, wird eine Instanz des TIP-Snapshots der angegebenen oder Standardverzweigung auf dem Wiedergabeserver oder eine Instanz des Standardsnapshots auf einem Workflow-Server gestartet.
Ein neues Prozessinstanzobjekt wird zurückgegeben. Wenn Sie den Parameter optional_parts in die Abfrage einschließen, sind diese Informationen auch im zurückgegebenen Prozessinstanzobjekt enthalten.