Workflow
Der Workflow ist ein XML-Dokument, das den Ereignisabrufprozess beschreibt. Der Workflow definiert einen oder mehrere Parameter, denen explizit Werte in der Workflow-XML zugewiesen werden können oder die Werte aus dem XML-Dokument mit den Workflowparameterwerten ableiten können. Der Workflow besteht aus mehreren Aktionen, die nacheinander ausgeführt werden. Wenn Sie den Workflow ausführen, werden die Parameterwerte zum Statushinzugefügt und der Status kann während der Ausführung des Workflows von Aktionen aufgerufen und geändert werden.
In der folgenden Tabelle sind die Workflowattribute aufgeführt.
| Ihren Namen | Beschreibung | Erforderlich |
|---|---|---|
| Name | Der Name des Workflows. | Ja |
| Beschreibung | Die Beschreibung des Workflows. | Nein |
| -Version | Die Version des Workflows. | Ja |
| minimumRecurrence | Die zulässige Mindestwiederholung für einen Workflow in Sekunden. Sie können dieses Attribut für APIs festlegen, die eine Mindestzeit zwischen Anforderungen haben. | Nein |
Parameter
Verwenden Sie die Workflow- Aktionen , um auf die Parameterwerte zuzugreifen. Parameter bestehen hauptsächlich aus Authentifizierungsnachweisen, können aber für alles verwendet werden, was der Benutzer konfigurieren soll. Die folgende Tabelle enthält die Workflowparameter.
| Ihren Namen | Datentyp | Beschreibung |
|---|---|---|
| Name | Zeichenfolge | Der Name des Parameters. Der Name muss mit dem entsprechenden Namenswert in der XML-Datei mit den Parameterwerten übereinstimmen. |
| Bezeichnung (Label) | Zeichenfolge | Der Anzeigename des Parameters. |
| Beschreibung | Zeichenfolge | Die Beschreibung des Parameters. |
| erforderlich | boolesch | Gibt an, dass der Parameter erforderlich ist. |
| Geheimnis | boolesch | Gibt an, ob der Parameter vertraulich ist, beispielsweise ein Kennwort. |
| Standard | Zeichenfolge | Der Standardwert des Parameters. Wenn Sie keinen Wert für diesen Parameter in der XML mit den Parameterwerten eingeben, wird der Standardwert verwendet. |
XML-Beispiel
Dieses Beispiel zeigt ein Workflowbeispiel, für das ein Host mit einem Benutzernamen und einem Kennwort erforderlich ist, wobei <x> die Version des verwendeten Workflowschemas ist.
<Workflow name="Test" version="1.0" xmlns="http://qradar.ibm.com/UniversalCloudRESTAPI/Workflow/V<x>">
<Parameters>
<Parameter name="host" label="Host" required="true" />
<Parameter name="username" label="Username" required="true" />
<Parameter name="password" label="Password" required="true" />
</Parameters>
<Actions>
...
</Actions>
</Workflow>