6.1.9. Champs des bogues¶
L'API Bugzilla pour obtenir des informations sur les champs de bogues.
6.1.9.1. Champs¶
Obtient des informations sur les champs de bogues, y compris la liste des valeurs autorisées pour chaque champ.
Requête
Pour obtenir des informations sur tous les champs :
GET /rest/field/bug
Pour obtenir des informations relatives à un seul champ :
GET /rest/field/bug/(id_or_name)
| nom | type | description |
|---|---|---|
| id_or_name | mixed | Un numéro de champ (entier) ou une chaîne représentant le nom du champ. |
Réponse
{
"fields": [
{
"display_name": "Priorité",
"name": "priority",
"type": 2,
"is_mandatory": false,
"value_field": null,
"values": [
{
"sortkey": 100,
"sort_key": 100,
"visibility_values": [],
"name": "P1"
},
{
"sort_key": 200,
"name": "P2",
"visibility_values": [],
"sortkey": 200
},
{
"sort_key": 300,
"visibility_values": [],
"name": "P3",
"sortkey": 300
},
{
"sort_key": 400,
"name": "P4",
"visibility_values": [],
"sortkey": 400
},
{
"name": "P5",
"visibility_values": [],
"sort_key": 500,
"sortkey": 500
}
],
"visibility_values": [],
"visibility_field": null,
"is_on_bug_entry": false,
"is_custom": false,
"id": 13
}
]
}
field (tableau) Objets champ chacun contenant les éléments suivants :
| nom | type | description |
|---|---|---|
| id | int | Un entier identifiant de façon unique ce champ et seulement dans cette installation. |
| type | int | Le numéro du type de champ. Les valeurs suivantes sont définies :
|
| is_custom | boolean | true quand il s'agit d'un champ personnalisé,
false dans le cas contraire. |
| name | string | Le nom interne pour ce champ. Ceci est un identifiant unique pour ce champ. S'il ne s'agit pas d'un champ personnalisé, alors ce nom sera le même dans toutes installations Bugzilla. |
| display_name | string | Le nom du champ, tel qu'il est affiché dans l'interface utilisateur. |
| is_mandatory | boolean | true si le champ doit avoir une valeur lors de la
création de nouveaux bogues. La valeur des champs
obligatoires ne peut être effacée lors de la mise à
jour de bogues. |
| is_on_bug_entry | boolean | Pour les champs personnalisés, ceci est true si
le champ est affiché lors de la saisie d'un nouveau
bogue. Pour les champs standards, ceci est toujours
false, Même si le champ est affiché lors de la
saisie d'un bogue. (Pour savoir si un champ standard
est valide lors de la saisie d'un bogue, consulter
Création de bogue. |
| visibility_field | string | Le nom d'un champ qui contrôle la visibilité de ce
champ dans l'interface utilisateur. Ce champ apparaît
dans l'interface utilisateur quand le champ nommé
est égal à une des valeurs de visibility_values.
Peut être nul. |
| visibility_values | array | Ce champ n'est affiché que si visibility_field
correspond à l'une des valeurs de ces chaînes. Quand
visibility_field est nul, cezci est un tableau
vide. |
| value_field | string | Le nom du champ qui contrôle si une des valeurs de ce champ est affichée dans l'interface utilisateur. Peut être nul. |
| values | array | Objets représentant les valeurs autorisées pour les
champs de sélection (liste déroulante et sélections
multiples). Ceci est aussi rensigné pour les champs
component, version, target_milestone
et keywords, mais pas pour le champ product
(vous devez utiliser get_accessible_products pour
cela). Pour les champs qui ne sont pas de type
sélection, ceci sera un tableau vide. Chaque objet
contient les éléments décrits dans l'objet Valeur
ci-dessous. |
Objet Valeur :
| nom | type | description |
|---|---|---|
| name | string | La valeur effective--c'est celle que vous spécifiez
pour ce champ dans create, etc. |
| sort_key | int | Les valeurs, quand elles sont affichées dans une liste, sont classées d'abord par cet entier puis par leur nom. |
| visibility_values | array | Si value_field est défini pour ce champ, alors
cette valeur n'est affichée que si value_field
a l'une des valeurs présentes dans ce tableau. Dans
les champs par produit, value_field est défini à
product et visibility_values reflètera dans
quel(s) produit(s) cette valeur apparaîtra. |
| is_active | boolean | Cette valeur est définie seulement pour certains champs spécifiques à des produits tels que la version, le jalon cible ou le composant. Pour true, la valeur est active ; sinon, la valeur n'est pas active. |
| description | string | La description de la valeur. Cet élément est seulement
inclus pour le champ keywords. |
| is_open | boolean | Pour les valeurs bug_status, détermine si cet état
indique que le bogue est "open" (true)
ou "closed" (false). Cet élément est seulement
inclus pour le champ bug_status. |
| can_change_to | array | Pour les valeurs Chaque objet contient les éléments suivants :
|
6.1.9.2. Valeurs autorisées¶
OBSOLÈTE Utilisez ''Fields'' à la place.
Indique quelles valeurs sont autorisées pour un champ particulier.
Requête
Pour obtenir des informations sur les valeurs pour un champ basées sur le nom du champ :
GET /rest/field/bug/(field)/values
Pour obtenir des informations basées sur le nom du champ et un produit spécifique :
GET /rest/field/bug/(field)/(product_id)/values
| nom | type | description |
|---|---|---|
| field | string | Le nom du champ pour lequel vous voulez obtenir des informations. Ce devrait être le même nom que vous utilisez dans Création de bogue, ci-dessous. |
| product_id | int | Si vous choisissez un champ spécifique à un produit, vous devez indiquer l'identifiant du produit pour lequel vous voulez obtenir les valeurs. |
Réponse
{
"values": [
"P1",
"P2",
"P3",
"P4",
"P5"
]
}
| nom | type | description |
|---|---|---|
| values | array | Les valeurs autorisées pour ce champ. Les valeurs seront classées telles qu'elles le seraient dans Bugzilla. |
Cette documentation contient très probablement des bogues ; si vous en découvrez, veuillez les signaler ici.
