# API-Referenz Gebäudemanagement (App-Kennung ressource)

> 18 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/ressource/

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

### Prüfregeln (Gebäudemanagement): `ressource.pruefregel.*`

#### ressource.pruefregel.list

Liste/Suche: Prüfregeln (Gebäudemanagement)

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

#### ressource.pruefregel.get

Detail: Prüfregeln (Gebäudemanagement)

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

#### ressource.pruefregel.create

Anlegen: Prüfregeln (Gebäudemanagement)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `ausstattungCode` (string, Pflicht)
  - `pruefartCode` (string, Pflicht)
  - `intervallMonate` (number)
  - `rechtsgrundlage` (string)
  - `hinweis` (string)
- Beispiel: `{"name":"ressource.pruefregel.create","input":{"ausstattungCode":"<ausstattungCode>","pruefartCode":"<pruefartCode>"}}`

#### ressource.pruefregel.update

Ändern: Prüfregeln (Gebäudemanagement)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `ausstattungCode` (string)
  - `pruefartCode` (string)
  - `intervallMonate` (number)
  - `rechtsgrundlage` (string)
  - `hinweis` (string)
- Beispiel: `{"name":"ressource.pruefregel.update","input":{"id":"<id>"}}`

#### ressource.pruefregel.delete

Löschen: Prüfregeln (Gebäudemanagement)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum löschen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"ressource.pruefregel.delete","input":{"id":"<id>"}}`

### Raum-Belegungen (Gebäudemanagement): `ressource.belegung.*`

#### ressource.belegung.list

Liste/Suche: Raum-Belegungen (Gebäudemanagement)

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

#### ressource.belegung.get

Detail: Raum-Belegungen (Gebäudemanagement)

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

#### ressource.belegung.create

Anlegen: Raum-Belegungen (Gebäudemanagement)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `raumId` (string, Pflicht)
  - `von` (string, Pflicht)
  - `bis` (string, Pflicht)
  - `titel` (string)
  - `bemerkung` (string)
  - `anzahl` (number)
- Beispiel: `{"name":"ressource.belegung.create","input":{"raumId":"<raumId>","von":"<von>","bis":"<bis>"}}`

#### ressource.belegung.update

Ändern: Raum-Belegungen (Gebäudemanagement)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `raumId` (string)
  - `von` (string)
  - `bis` (string)
  - `titel` (string)
  - `bemerkung` (string)
  - `anzahl` (number)
- Beispiel: `{"name":"ressource.belegung.update","input":{"id":"<id>"}}`

#### ressource.belegung.delete

Löschen: Raum-Belegungen (Gebäudemanagement)

- Art: Löschen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum löschen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht)
- Beispiel: `{"name":"ressource.belegung.delete","input":{"id":"<id>"}}`

### Räume (Gebäudemanagement): `ressource.raum.*`

#### ressource.raum.list

Liste/Suche: Räume (Gebäudemanagement)

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

#### ressource.raum.get

Detail: Räume (Gebäudemanagement)

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

#### ressource.raum.create

Anlegen: Räume (Gebäudemanagement)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `titel` (string, Pflicht)
  - `nummer` (string)
  - `standortId` (string)
  - `kapazitaet` (number)
  - `groesseQm` (number)
  - `bestuhlung` (string)
  - `bemerkung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"ressource.raum.create","input":{"titel":"<titel>"}}`

#### ressource.raum.update

Ändern: Räume (Gebäudemanagement)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `titel` (string)
  - `nummer` (string)
  - `standortId` (string)
  - `kapazitaet` (number)
  - `groesseQm` (number)
  - `bestuhlung` (string)
  - `bemerkung` (string)
  - `aktiv` (boolean)
- Beispiel: `{"name":"ressource.raum.update","input":{"id":"<id>"}}`

### Standorte (Gebäudemanagement): `ressource.standort.*`

#### ressource.standort.list

Liste/Suche: Standorte (Gebäudemanagement)

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

#### ressource.standort.get

Detail: Standorte (Gebäudemanagement)

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

#### ressource.standort.create

Anlegen: Standorte (Gebäudemanagement)

- Art: Anlegen, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum anlegen
- Datenklassen: C (vertraulich)
- Eingabe:
  - `name` (string, Pflicht)
  - `kuerzel` (string)
  - `organisationId` (string)
  - `bemerkung` (string)
  - `aktiv` (boolean)
  - `strasse` (string)
  - `hausnummer` (string)
  - `plz` (string)
  - `ort` (string)
  - `land` (string)
- Beispiel: `{"name":"ressource.standort.create","input":{"name":"<name>"}}`

#### ressource.standort.update

Ändern: Standorte (Gebäudemanagement)

- Art: Ändern, vor dem Ausführen ausdrücklich bestätigen lassen
- Rechte: Raum ändern
- Datenklassen: C (vertraulich)
- Eingabe:
  - `id` (string, Pflicht): ID des Datensatzes
  - `name` (string)
  - `kuerzel` (string)
  - `organisationId` (string)
  - `bemerkung` (string)
  - `aktiv` (boolean)
  - `strasse` (string)
  - `hausnummer` (string)
  - `plz` (string)
  - `ort` (string)
  - `land` (string)
- Beispiel: `{"name":"ressource.standort.update","input":{"id":"<id>"}}`