# API-Referenz Workflows (App-Kennung workflows)

> 9 App-Tools. Aufruf immer mit `POST /api/app-tools`, Header `X-API-KEY`, Body `{"name": "<tool>", "input": {…}}`. Welche Tools ein Schlüssel nutzen darf, zeigt `GET /api/app-tools` der Instanz.

Quelle: https://support.unitedsynergy.com/api/referenz/workflows/

## Datenobjekte

Die Standard-Aktionen je Datenobjekt: list (suchen und blättern), get (einen Datensatz lesen), create, update und delete. Nicht jedes Objekt bietet alle fünf an.

### Workflow-Vorlagen: `workflows.template.*`

#### workflows.template.list

Liste/Suche: Workflow-Vorlagen

- Art: Lesen
- Rechte: WorkflowVorlage lesen
- Datenklassen: B (intern)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"workflows.template.list","input":{}}`

#### workflows.template.get

Detail: Workflow-Vorlagen

- Art: Lesen
- Rechte: WorkflowVorlage lesen
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"workflows.template.get","input":{"id":"<id>"}}`

### Workflows (Flows): `workflows.flow.*`

#### workflows.flow.list

Liste/Suche: Workflows (Flows)

- Art: Lesen
- Rechte: Flow lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `search` (string): Freitextsuche
  - `filters` (object): Feld=Wert-Filter
  - `limit` (integer)
  - `offset` (integer)
  - `orderBy` (string)
- Beispiel: `{"name":"workflows.flow.list","input":{}}`

#### workflows.flow.get

Detail: Workflows (Flows)

- Art: Lesen
- Rechte: Flow lesen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"workflows.flow.get","input":{"id":"<id>"}}`

## Wertelisten

Auswahllisten der App wie Status, Arten oder Kategorien. Du pflegst sie mit denselben fünf Aktionen. Die Werte (code) nutzt du in den Feldern der Datenobjekte.

### Flow-Kategorien: `workflows.kategorie.*`

#### workflows.kategorie.list

Liste/Suche: Katalog „Flow-Kategorien" (workflows)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `onlyAktiv` (boolean): Nur aktive Einträge
- Beispiel: `{"name":"workflows.kategorie.list","input":{}}`

#### workflows.kategorie.get

Detail: Katalog „Flow-Kategorien" (workflows)

- Art: Lesen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"workflows.kategorie.get","input":{"id":"<id>"}}`

#### workflows.kategorie.create

Anlegen: Katalog „Flow-Kategorien" (workflows)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `label` (string, Pflicht): Anzeige-Text
  - `code` (string): Optional, sonst aus label abgeleitet. Immutable
  - `color` (string): Tailwind-Paar, z.B. "bg-blue-100 text-blue-700"
  - `icon` (string): Lucide-Icon-Name
  - `beschreibung` (string)
- Beispiel: `{"name":"workflows.kategorie.create","input":{"label":"<label>"}}`

#### workflows.kategorie.update

Ändern: Katalog „Flow-Kategorien" (workflows)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
  - `label` (string)
  - `color` (string)
  - `icon` (string)
  - `beschreibung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"workflows.kategorie.update","input":{"id":"<id>"}}`

#### workflows.kategorie.delete

Löschen: Katalog „Flow-Kategorien" (workflows)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Einstellungen verwalten
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"workflows.kategorie.delete","input":{"id":"<id>"}}`