Champs personnalisés

Champs personnalisés dans Requirements & Systems Portal - Documentation de l’API

Introduction

Dans Requirements & Systems Portal, les champs personnalisés offrent un moyen puissant d’étendre les fonctionnalités de la plateforme en permettant aux utilisateurs de créer des champs supplémentaires associés aux exigences et aux exécutions de test. Ces champs peuvent stocker différents types de données, tels que des dates, du texte et des sélections. Cette documentation de l’API décrit le processus de création, de mise à jour et de gestion programmatique des champs personnalisés et de leurs options.

Définition des champs personnalisés

Les champs personnalisés dans Requirements & Systems Portal peuvent être créés à l’aide du point de terminaison /data/custom-field/ avec la syntaxe suivante :

CustomField{
  "projects": [uniqueItems: true integer],
  "target_content_type": integer,
  "name": string,
  "type": integer,
  "multi": boolean
}

• projects: Liste des identifiants uniques de projet dans lesquels le champ personnalisé doit être disponible.

• target_content_type: Le type de contenu cible pour le champ personnalisé. Utilisez 120 pour les exigences et 291 pour les exécutions de test.

• name: Le nom du champ personnalisé.

• type: Utilisez 0 pour Texte, 1 pour Sélection et 2 pour Date.

• multi: Définissez cette valeur sur true pour une sélection multiple lors de la définition d’un type Sélection.

Création de champs personnalisés

Pour créer un champ personnalisé, utilisez la méthode PUT pour le point de terminaison /data/custom-field/. Par exemple :

{
  "projects": [136],
  "target_content_type": 120,
  "name": "New Selection Column",
  "type": 1
}

Définition des options de champ personnalisé

Lors de la création de champs personnalisés de type Sélection, vous devez également définir les options disponibles à l’aide du point de terminaison /data/custom-field-options/ avec le modèle suivant :

CustomFieldOption{
  "custom_field": integer,
  "titlename": string,
  "position": number
}

• custom_field: L’identifiant unique du champ personnalisé pour lequel l’option est créée.

• titlename: Le nom de l’option.

• position: Champ facultatif permettant de définir la position de l’option dans la liste des options.

Création d’options de champ personnalisé

Pour créer une option de champ personnalisé, utilisez la méthode PUT pour le point de terminaison /data/custom-field-options/. Par exemple :

{
  "custom_field": 58,
  "name": "New Option"
}

Ajout de données aux champs personnalisés

Pour ajouter des données à un champ personnalisé, utilisez le point de terminaison /data/custom-field-row/ avec le modèle suivant :

CustomFieldRow{
  "referenced_object_id": integer,
  "custom_field": integer,
  "value": string
}

• referenced_object_id: L’identifiant unique de l’objet (exigence ou exécution de test) auquel appartiennent les données.

• custom_field: L’identifiant unique du champ personnalisé auquel les données sont ajoutées.

• value: Les données à ajouter. Pour Texte, utilisez une chaîne de texte libre ; pour Sélection unique, utilisez un identifiant d’option ; pour Sélection multiple, utilisez une liste d’identifiants d’option ; pour Date, utilisez une date au format chaîne.

Ajout de données aux champs personnalisés - Première saisie

Pour la première saisie de données dans un champ personnalisé d’un objet donné, utilisez la méthode POST pour le point de terminaison /data/custom-field-row/bulk-create/. Par exemple :

{
  "referenced_object_id": 33803,
  "custom_field": 58,
  "value": 29
}

Mise à jour des données dans les champs personnalisés

Pour mettre à jour des données existantes pour un champ personnalisé d’un objet donné, utilisez la méthode POST pour le point de terminaison /data/custom-field-row/bulk-update/. Par exemple :

{
  "614": {
    "value": 30
  }
}

Suppression de données des champs personnalisés

Pour supprimer les données associées à un champ personnalisé et à un objet donnés, utilisez la même méthode de mise à jour en masse avec "value": null. Par exemple :

{
  "614": {
    "value": null
  }
}

Conclusion

Les champs personnalisés dans Requirements & Systems Portal vous permettent d’améliorer les capacités de la plateforme et de l’adapter aux besoins spécifiques de votre projet. En utilisant les points de terminaison de l’API fournis, vous pouvez créer des champs personnalisés, définir des options et ajouter des données par programmation, faisant de Requirements & Systems Portal un outil polyvalent pour vos besoins en gestion et en analyse de projet.