Benutzerdefinierte Felder

Benutzerdefiniertes Feld für Datenobjekte aktualisieren

Teilaktualisierung einer Definition. Hier sind nur Definitionen erreichbar, die für Datenobjekte gelten; jede andere Kennung liefert einen 404.

Erforderlicher Scope tenant:edit

patch/data/custom-fields/{id}

Authentifizierung

Authorizationstringerforderlich

Authorization-Header mit einem API-Schlüssel des Workspace, in der Form „Bearer kbn_live_…“. Der Header X-Api-Key wird gleichwertig akzeptiert.

Pfadparameter

idstring<uuid>erforderlich

Kennung der Zielressource.

Anfragekörperapplication/json

namestring

Bezeichnung des Feldes.

descriptionstring

Kurze freie Beschreibung.

iconstring

Symbol.

optionsobject[]

Angebotene Optionen für Auswahlfelder.

Antwort200 · application/json

Die aktualisierte Definition.

idstring<uuid>erforderlich

Eindeutige Kennung.

namestringerforderlich

Bezeichnung des Feldes.

typeenum<string>erforderlich

Typ des Feldes, der die Form seiner Werte bestimmt.

Mögliche Werte: text, select, multi_select, date

descriptionstring | null

Hilfetext, der neben dem Feld angezeigt wird.

optionsobject[]

Verfügbare Optionen für `select`- und `multi_select`-Felder.