Applications

Mettre à jour un document

Mise à jour partielle d'un document. `url` est immuable — supprimez puis recréez le document pour le faire pointer ailleurs.

Scope requis applications:edit

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

Authentification

Authorizationstringobligatoire

En-tête Authorization portant une clé d'API de l'espace de travail, sous la forme « Bearer kbn_live_… ». L'en-tête X-Api-Key est accepté de façon équivalente.

Paramètres de chemin

idstring<uuid>obligatoire

Identifiant de l'application. Elle doit appartenir à l'espace de travail auquel la clé est liée.

documentIdstring<uuid>obligatoire

Identifiant du document.

Corps de la requêteapplication/json

documentTypeenum<string>

Type de document.

Valeurs possibles : data_policy, security_policy, technical_documents

titlestring

Titre.

descriptionstring

Courte description libre.

publishedboolean

Rend le document visible ou non par les utilisateurs finaux.

Réponse200 · application/json

Le document mis à jour.

idstring<uuid>obligatoire

Identifiant du document.

documentTypeenum<string>obligatoire

Type de document.

Valeurs possibles : data_policy, security_policy, technical_documents

titlestringobligatoire

Titre du document.

descriptionstring | null

Courte description du document.

publishedboolean

Indique si le document est visible par les utilisateurs finaux.

urlstring<uri>obligatoire

URL à laquelle le document est référencé. Immuable après création.

createdAtstring<date-time>

Horodatage du référencement du document.