Champs personnalisés

Créer et gérer des champs personnalisés sur les objets Neil.

Neil la chouette

Comment faire dans Neil

Créer un champ personnalisé sur un objet

Configuration›Personnalisation›[Objet]›Ajouter une section personnalisée›Ajouter un champ personnalisé
  1. 1
    Ouvrez Configuration › Personnalisation, puis la sous-page de l’objet cible (étudiant, formation, utilisateur…).23 objets supportent les champs personnalisés.
  2. 2
    Cliquez sur Ajouter une section personnalisée, ou ouvrez une section existante.
  3. 3
    Dans cette section, cliquez sur Ajouter un champ personnalisé.
  4. 4
    Renseignez le nom du champ. Un slug est généré automatiquement.Le slug est l’identifiant technique utilisé dans l’API. Il peut être modifié à cette étape uniquement.
  5. 5
    Choisissez le format : texte, date (ISO), liste déroulante, nombre entier ou nombre décimal.Le format est définitif après création.
  6. 6
    Si le format est liste déroulante, ajoutez les options disponibles.
  7. 7
    Validez. La définition du champ est créée.⚠ Attention — Le slug et le format sont définitifs après création. Vérifiez-les avant de valider.

Lire un champ personnalisé via l’API

API›GET /api/[objet]/[id]
  1. 1
    Effectuez un GET sur l’objet concerné avec la clé API du compte de service.
  2. 2
    Les champs personnalisés sont retournés dans l’objet custom_fields, identifiés par leur slug.
  3. 3
    Les champs non renseignés sont retournés avec la valeur null.

Écrire un champ personnalisé via l’API

API›PATCH /api/[objet]/[id]
  1. 1
    Effectuez un PATCH sur l’objet concerné avec le body contenant l’objet custom_fields.
  2. 2
    Renseignez uniquement les slugs à mettre à jour. Les autres champs ne sont pas affectés.Seuls les champs envoyés dans le body sont modifiés. C’est un patch partiel.
  3. 3
    Respectez le format du champ : texte pour un champ texte, date ISO pour une date, nombre pour un nombre entier/décimal, valeur parmi les options pour une liste déroulante.
  4. 4
    La mise à jour est effective immédiatement. Le prochain GET retournera la nouvelle valeur.
Neil

Logiciel de pilotage intelligent dédié à l'enseignement supérieur.