Aufträge
Jedes Tool rufst du mit POST /api/app-tools und dem Tool-Namen auf. Klapp ein Tool auf, um Eingabefelder, nötige Rechte und eine Beispiel-Anfrage zu sehen. Ob dein API-Key ein Tool nutzen darf, zeigt der Katalog deiner Instanz (App-Tools-API).
Wie die App in der Oberfläche funktioniert, steht in der Hilfe unter Aufträge.
Kein Tool passt zu deiner Eingabe.
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.
Aufträge auftraege.auftrag.*
auftraege.auftrag.list Lesen Liste/Suche: Aufträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "auftraege.auftrag.list",
"input": {}
} auftraege.auftrag.get Lesen Detail: Aufträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.auftrag.get",
"input": {
"id": "<id>"
}
} auftraege.auftrag.create Anlegen Bestätigung Anlegen: Aufträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
nummer | string | nein | |
bezeichnung | string | ja | |
externeNummer | string | nein | |
auftragsartCode | string | ja | |
gewerkCode | string | nein | |
statusCode | string | nein | |
prioritaet | string | nein | |
parentId | string | nein | |
kontoId | string | ja | |
kontaktId | string | nein | |
objektId | string | nein | |
vertragId | string | nein | |
verantwortlichPersonId | string | nein | |
vorOrtPersonId | string | nein | |
kolonneKstId | string | nein | |
kostenstelleId | string | nein | |
eingangAm | string | nein | |
beginnGeplant | string | nein | |
endeGeplant | string | nein | |
fristBis | string | nein | |
abgeschlossenAm | string | nein | |
beschreibung | string | nein | |
bemerkung | string | nein | |
wert | number | nein | |
waehrung | string | nein |
{
"name": "auftraege.auftrag.create",
"input": {
"bezeichnung": "<bezeichnung>",
"auftragsartCode": "<auftragsartCode>",
"kontoId": "<kontoId>"
}
} auftraege.auftrag.update Ändern Bestätigung Ändern: Aufträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
nummer | string | nein | |
bezeichnung | string | nein | |
externeNummer | string | nein | |
auftragsartCode | string | nein | |
gewerkCode | string | nein | |
statusCode | string | nein | |
prioritaet | string | nein | |
parentId | string | nein | |
kontoId | string | nein | |
kontaktId | string | nein | |
objektId | string | nein | |
vertragId | string | nein | |
verantwortlichPersonId | string | nein | |
vorOrtPersonId | string | nein | |
kolonneKstId | string | nein | |
kostenstelleId | string | nein | |
eingangAm | string | nein | |
beginnGeplant | string | nein | |
endeGeplant | string | nein | |
fristBis | string | nein | |
abgeschlossenAm | string | nein | |
beschreibung | string | nein | |
bemerkung | string | nein | |
wert | number | nein | |
waehrung | string | nein |
{
"name": "auftraege.auftrag.update",
"input": {
"id": "<id>"
}
} auftraege.auftrag.delete Löschen Bestätigung Löschen: Aufträge
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.auftrag.delete",
"input": {
"id": "<id>"
}
} Beteiligte am Auftrag auftraege.beteiligter.*
auftraege.beteiligter.list Lesen Liste/Suche: Beteiligte am Auftrag
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
search | string | nein | Freitextsuche |
filters | object | nein | Feld=Wert-Filter |
limit | integer | nein | |
offset | integer | nein | |
orderBy | string | nein |
{
"name": "auftraege.beteiligter.list",
"input": {}
} auftraege.beteiligter.get Lesen Detail: Beteiligte am Auftrag
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.beteiligter.get",
"input": {
"id": "<id>"
}
} auftraege.beteiligter.create Anlegen Bestätigung Anlegen: Beteiligte am Auftrag
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
auftragId | string | ja | |
rolleCode | string | ja | |
kontoId | string | nein | |
kontaktId | string | nein | |
bezeichnung | string | nein | |
bemerkung | string | nein | |
position | number | nein |
{
"name": "auftraege.beteiligter.create",
"input": {
"auftragId": "<auftragId>",
"rolleCode": "<rolleCode>"
}
} auftraege.beteiligter.update Ändern Bestätigung Ändern: Beteiligte am Auftrag
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | ID des Datensatzes |
auftragId | string | nein | |
rolleCode | string | nein | |
kontoId | string | nein | |
kontaktId | string | nein | |
bezeichnung | string | nein | |
bemerkung | string | nein | |
position | number | nein |
{
"name": "auftraege.beteiligter.update",
"input": {
"id": "<id>"
}
} auftraege.beteiligter.delete Löschen Bestätigung Löschen: Beteiligte am Auftrag
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.beteiligter.delete",
"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.
Auftragsarten auftraege.auftragsart.* list · get · create · update · delete
auftraege.auftragsart.list Lesen Liste/Suche: Katalog „Auftragsarten" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "auftraege.auftragsart.list",
"input": {}
} auftraege.auftragsart.get Lesen Detail: Katalog „Auftragsarten" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.auftragsart.get",
"input": {
"id": "<id>"
}
} auftraege.auftragsart.create Anlegen Bestätigung Anlegen: Katalog „Auftragsarten" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "auftraege.auftragsart.create",
"input": {
"label": "<label>"
}
} auftraege.auftragsart.update Ändern Bestätigung Ändern: Katalog „Auftragsarten" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "auftraege.auftragsart.update",
"input": {
"id": "<id>"
}
} auftraege.auftragsart.delete Löschen Bestätigung Löschen: Katalog „Auftragsarten" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.auftragsart.delete",
"input": {
"id": "<id>"
}
} Auftragsstatus auftraege.status.* list · get · create · update · delete
auftraege.status.list Lesen Liste/Suche: Katalog „Auftragsstatus" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "auftraege.status.list",
"input": {}
} auftraege.status.get Lesen Detail: Katalog „Auftragsstatus" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.status.get",
"input": {
"id": "<id>"
}
} auftraege.status.create Anlegen Bestätigung Anlegen: Katalog „Auftragsstatus" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "auftraege.status.create",
"input": {
"label": "<label>"
}
} auftraege.status.update Ändern Bestätigung Ändern: Katalog „Auftragsstatus" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "auftraege.status.update",
"input": {
"id": "<id>"
}
} auftraege.status.delete Löschen Bestätigung Löschen: Katalog „Auftragsstatus" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.status.delete",
"input": {
"id": "<id>"
}
} Beteiligtenrollen auftraege.beteiligtenrolle.* list · get · create · update · delete
auftraege.beteiligtenrolle.list Lesen Liste/Suche: Katalog „Beteiligtenrollen" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "auftraege.beteiligtenrolle.list",
"input": {}
} auftraege.beteiligtenrolle.get Lesen Detail: Katalog „Beteiligtenrollen" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.beteiligtenrolle.get",
"input": {
"id": "<id>"
}
} auftraege.beteiligtenrolle.create Anlegen Bestätigung Anlegen: Katalog „Beteiligtenrollen" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "auftraege.beteiligtenrolle.create",
"input": {
"label": "<label>"
}
} auftraege.beteiligtenrolle.update Ändern Bestätigung Ändern: Katalog „Beteiligtenrollen" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "auftraege.beteiligtenrolle.update",
"input": {
"id": "<id>"
}
} auftraege.beteiligtenrolle.delete Löschen Bestätigung Löschen: Katalog „Beteiligtenrollen" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.beteiligtenrolle.delete",
"input": {
"id": "<id>"
}
} Gewerke auftraege.gewerk.* list · get · create · update · delete
auftraege.gewerk.list Lesen Liste/Suche: Katalog „Gewerke" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
onlyAktiv | boolean | nein | Nur aktive Einträge |
{
"name": "auftraege.gewerk.list",
"input": {}
} auftraege.gewerk.get Lesen Detail: Katalog „Gewerke" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.gewerk.get",
"input": {
"id": "<id>"
}
} auftraege.gewerk.create Anlegen Bestätigung Anlegen: Katalog „Gewerke" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
label | string | ja | Anzeige-Text |
code | string | nein | Optional, sonst aus label abgeleitet. Immutable. |
color | string | nein | Tailwind-Paar, z.B. "bg-blue-100 text-blue-700" |
icon | string | nein | Lucide-Icon-Name |
beschreibung | string | nein |
{
"name": "auftraege.gewerk.create",
"input": {
"label": "<label>"
}
} auftraege.gewerk.update Ändern Bestätigung Ändern: Katalog „Gewerke" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja | |
label | string | nein | |
color | string | nein | |
icon | string | nein | |
beschreibung | string | nein | |
aktiv | boolean | nein |
{
"name": "auftraege.gewerk.update",
"input": {
"id": "<id>"
}
} auftraege.gewerk.delete Löschen Bestätigung Löschen: Katalog „Gewerke" (auftraege)
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string | ja |
{
"name": "auftraege.gewerk.delete",
"input": {
"id": "<id>"
}
} Weitere Aktionen
Eigene Aktionen der App, zum Beispiel Auswertungen, Versand, Zuordnungen oder Abläufe über mehrere Datensätze.
auftraege.wartung_erzeugen Anlegen Bestätigung Wartungsaufträge aus Verträgen: zeigt je Wartungsvertrag (Merkmal intervall_monate) letzte und nächste …
Wartungsaufträge aus Verträgen: zeigt je Wartungsvertrag (Merkmal intervall_monate) letzte und nächste Wartung (letzte + Intervall, Felder letzte_wartung/naechste_wartung am Vertrag) und legt fällige Wartungsaufträge an (30 Tage Vorlauf, je Vertrag höchstens ein offener). Standard ist dryRun=true (nur Vorschau); mit dryRun=false wird angelegt.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
dryRun | boolean | nein | true (Standard) = nur Vorschau, false = anlegen |
vorlaufTage | number | nein | Tage vor Fälligkeit, ab denen angelegt wird (Standard 30) |
{
"name": "auftraege.wartung_erzeugen",
"input": {}
} Als Klartext für KI-Assistenten: diese App, alle Apps und Artikel zur API in einer Datei: /api/llms.txt