# API-Referenz Charts (App-Kennung reporting)

> 7 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/reporting/

## 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.

### Reports: `reporting.report.*`

#### reporting.report.list

Liste/Suche: Reports

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

#### reporting.report.get

Detail: Reports

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

#### reporting.report.create

Anlegen: Reports

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Report anlegen
- Datenklassen: B (intern)
- Eingabe:
  - `titel` (string, Pflicht)
  - `beschreibung` (string)
  - `kategorie` (string)
  - `icon` (string)
  - `entitaetId` (string, Pflicht)
  - `chartType` (string): Werte: `bar`, `line`, `area`, `pie`, `donut`, `stacked_bar`, `kpi`, `gauge`, `funnel`, `radar`, `scatter`, `heatmap`, `pivot_table`
  - `sort` (number)
  - `aktiv` (boolean)
- Beispiel: `{"name":"reporting.report.create","input":{"titel":"<titel>","entitaetId":"<entitaetId>"}}`

#### reporting.report.update

Ändern: Reports

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Report ändern
- Datenklassen: B (intern)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `titel` (string)
  - `beschreibung` (string)
  - `kategorie` (string)
  - `icon` (string)
  - `entitaetId` (string)
  - `chartType` (string): Werte: `bar`, `line`, `area`, `pie`, `donut`, `stacked_bar`, `kpi`, `gauge`, `funnel`, `radar`, `scatter`, `heatmap`, `pivot_table`
  - `sort` (number)
  - `aktiv` (boolean)
- Beispiel: `{"name":"reporting.report.update","input":{"id":"<id>"}}`

#### reporting.report.delete

Löschen: Reports

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

## Weitere Aktionen

Eigene Aktionen der App, zum Beispiel Auswertungen, Versand, Zuordnungen oder Abläufe über mehrere Datensätze.

#### reporting.list_reports

Listet alle aktiven Reports der Tenant

- Art: Lesen
- Rechte: Report lesen
- Datenklassen: B (intern), C (vertraulich)
- Datenschutz: Liefert Report-Metadaten, keine Rohdaten.
- Eingabe:
  - `kategorie` (string)
- Beispiel: `{"name":"reporting.list_reports","input":{}}`

#### reporting.run_report

Fuehrt einen Report aus und gibt die aggregierten Daten zurueck

- Art: Lesen
- Rechte: Report lesen, Query anlegen
- Datenklassen: B (intern), C (vertraulich)
- Datenschutz: Fuehrt nur registrierte Reports aus. Datenklasse haengt vom angebundenen Datenobjekt ab.
- Eingabe:
  - `reportId` (string, Pflicht)
- Beispiel: `{"name":"reporting.run_report","input":{"reportId":"<reportId>"}}`