Wie lege ich einen eigenen Objekttyp an?

Ab Tarif Pro

Kurzantwort

Öffne das Modul Daten, klicke auf „Neuer Typ”, vergib einen Schlüssel (Maschinenname, z. B. vehicle) und eine Bezeichnung (z. B. „Fahrzeug”) und bestätige mit „Erstellen”. Danach definierst du die Freifelder des Typs. Erst dann lassen sich Datensätze erfassen.

Voraussetzungen

Die Flex-Plattform erfordert Pro oder höher (Feature custom_fields). In niedrigeren Tarifen antwortet die API mit 403 und einem Upgrade-Hinweis.

Modul „Daten” öffnen. Wähle in der linken Navigation Daten. Oben rechts liegt die Schaltfläche „Neuer Typ”. Gibt es noch keine Typen, zeigt die Seite den Hinweis „Noch keine Objekttypen. Legen Sie einen an, um zu starten.”
Typ definieren. Im Dialog „Neuer Typ” füllst du zwei Felder aus:
- Schlüssel (Maschinenname): nur Kleinbuchstaben, Ziffern und Unterstriche (z. B. vehicle). Der Schlüssel ist die technische Kennung und lässt sich später nicht ändern.
- Bezeichnung: der Anzeigename (z. B. „Fahrzeug”).
Klicke auf „Erstellen”.

Screenshot ausstehend katalog-objekttyp-01 Dialog 'Neuer Typ' mit den Feldern Schlüssel (Maschinenname) und Bezeichnung

Der Dialog 'Neuer Typ': Schlüssel und Bezeichnung genügen.
Felder ergänzen. Der neue Typ erscheint als Auswahl-Chip. Die Tabelle ist noch leer und fordert dich auf: „Fügen Sie diesem Typ zuerst mindestens ein Feld hinzu.” Weiter geht es mit Freifelder definieren.

Screenshot ausstehend katalog-objekttyp-02 Daten-Seite mit dem neu angelegten Objekttyp als Chip und leerer Tabelle mit Hinweis auf fehlende Felder

Nach dem Anlegen: der Typ existiert, braucht aber noch Felder.

Ein POST auf /api/v1/object-types (Rolle Administrator, Scope write). Pflicht sind key (Muster ^[a-z0-9_]+$, max. 64 Zeichen) und label; optional sind label_plural, description, icon und color:

curl -X POST https://demo.notory.io/api/v1/object-types \
  -H "Authorization: Bearer inv_dein_token" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "vehicle",
    "label": "Fahrzeug",
    "label_plural": "Fahrzeuge",
    "description": "Firmenfahrzeuge und Poolwagen",
    "color": "#c6703d"
  }'

{
  "id": "0c9e2b74-5a1f-4d3e-8b6c-7f2a9d4e1c00",
  "key": "vehicle",
  "label": "Fahrzeug",
  "label_plural": "Fahrzeuge",
  "description": "Firmenfahrzeuge und Poolwagen",
  "icon": null,
  "color": "#c6703d"
}

Alle Typen auflisten, einen Typ umbenennen oder löschen:

curl -H "Authorization: Bearer inv_dein_token" \
  https://demo.notory.io/api/v1/object-types

curl -X PUT https://demo.notory.io/api/v1/object-types/0c9e2b74-5a1f-4d3e-8b6c-7f2a9d4e1c00 \
  -H "Authorization: Bearer inv_dein_token" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Dienstfahrzeug" }'

curl -X DELETE -H "Authorization: Bearer inv_dein_token" \
  https://demo.notory.io/api/v1/object-types/0c9e2b74-5a1f-4d3e-8b6c-7f2a9d4e1c00

Mögliche Fehler: 403 (keine Administrator-Rolle oder Tarif unter Pro, Meldung: „The Custom fields module is not included in the ’…’ plan”), 422 (ungültiger key, z. B. Großbuchstaben oder Leerzeichen).

Was passiert dabei?

Mandanten-Zuordnung: Der Objekttyp gehört zu deinem Mandanten; andere Mandanten sehen ihn nicht und können eigene Typen mit demselben Schlüssel führen.
Lizenz-Gating: Sämtliche Objekttyp- und Datensatz-Routen sind hinter dem Feature custom_fields (Pro+) geschaltet. Darunter liefert die API 403 mit Upgrade-Hinweis.
Schlüssel ist stabil: Der key ist die Referenz für Datensätze, Freifelder (entity_type), Lookups und den Scanner. Änderbar sind nur Bezeichnung, Beschreibung, Icon und Farbe (PUT).
Noch keine Felder = keine Datensätze: Die Schaltflächen „Datensatz hinzufügen” und „Importieren” bleiben deaktiviert, bis der Typ mindestens ein Freifeld hat.
Löschen mit Bedacht: Beim Löschen fragt die Oberfläche nach („Diesen Objekttyp löschen?”). Lösche einen Typ nur, wenn seine Datensätze nicht mehr gebraucht werden.