Objets de données

Définir un champ personnalisé

Définit la valeur d'un champ personnalisé de l'espace de travail sur l'objet de données. La valeur est vérifiée contre le type de la définition.

Scope requis data:edit

put/data/{id}/custom-fields/{fieldId}

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 la ressource visée.

fieldIdstring<uuid>obligatoire

Identifiant de la définition du champ personnalisé.

Corps de la requêteapplication/json

valueany

Valeur mesurée.

Réponse200 · application/json

La valeur mise à jour du champ personnalisé.

idstring<uuid>obligatoire

Identifiant de la définition du champ personnalisé.

namestringobligatoire

Libellé du champ personnalisé.

typeenum<string>obligatoire

Type du champ personnalisé, qui détermine la forme de `value`.

Valeurs possibles : text, select, multi_select, date

descriptionstring | null

Texte d'aide attaché à la définition du champ.

valueany

Valeur portée par cette application. Une chaîne pour `text`, une date-heure ISO-8601 pour `date`, une option `{id, value}` pour `select`, un tableau d'options pour `multi_select`, ou `null` si non renseigné.