Datenobjekte

Datenobjekt aktualisieren

Anders als die übrigen Teilaktualisierungen dieser API ersetzt diese den gesamten Upsert-Body: In der Anfrage fehlende Felder werden geleert statt unverändert gelassen.

Erforderlicher Scope data:edit

patch/data/{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

namestringerforderlich

Name des Datenobjekts.

typesstring[]

Vom Objekt getragene Datentypen.

privacystring

Vertraulichkeitsklassifikation der Daten.

criticalitystring

Zugewiesene geschäftliche Kritikalität.

descriptionstring

Kurze freie Beschreibung.

categoryIdstring<uuid>

Kategorie, unter der die Ressource eingeordnet wird. `null` löst sie.

categoryNamestring

Name der Kategorie, gemeinsam mit `categoryId` gesendet.

Antwort200 · application/json

Das aktualisierte Datenobjekt.

idstring<uuid>erforderlich

Eindeutige Kennung.

namestringerforderlich

Name des Datenobjekts.

typesstring[]

Vom Objekt getragene Datentypen.

privacystring | null

Vertraulichkeitsklassifikation der Daten.

criticalitystring | null

Zugewiesene geschäftliche Kritikalität.

descriptionstring | null

Kurze freie Beschreibung.

updatedAtstring<date-time>

Zeitstempel der letzten Änderung, nutzbar zur Änderungserkennung.

categoryobject | null

Kategorie, zu der die Ressource gehört.

customFieldsany[]

Benutzerdefinierte Workspace-Felder und ihre Werte.