Anwendungen

Dokument aktualisieren

Teilaktualisierung eines Dokuments. `url` ist unveränderlich — löschen Sie das Dokument und legen Sie es neu an, um auf ein anderes Ziel zu verweisen.

Erforderlicher Scope applications:edit

patch/applications/{id}/documents/{documentId}

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 Anwendung. Sie muss zu dem Workspace gehören, an den der Schlüssel gebunden ist.

documentIdstring<uuid>erforderlich

Kennung des Dokuments.

Anfragekörperapplication/json

documentTypeenum<string>

Art des Dokuments.

Mögliche Werte: data_policy, security_policy, technical_documents

titlestring

Titel.

descriptionstring

Kurze freie Beschreibung.

publishedboolean

Macht das Dokument für Endbenutzer sichtbar oder nicht.

Antwort200 · application/json

Das aktualisierte Dokument.

idstring<uuid>erforderlich

Kennung des Dokuments.

documentTypeenum<string>erforderlich

Art des Dokuments.

Mögliche Werte: data_policy, security_policy, technical_documents

titlestringerforderlich

Titel des Dokuments.

descriptionstring | null

Kurze Beschreibung des Dokuments.

publishedboolean

Gibt an, ob das Dokument für Endbenutzer sichtbar ist.

urlstring<uri>erforderlich

URL, unter der das Dokument hinterlegt ist. Nach der Erstellung unveränderlich.

createdAtstring<date-time>

Zeitstempel der Hinterlegung des Dokuments.