doc: complete api-fill.page about item and items field (#32013)

This commit is contained in:
Benjamin Dauvergne 2019-04-05 11:08:18 +02:00
parent 617191674b
commit 04e06d4e02
1 changed files with 108 additions and 2 deletions

View File

@ -33,8 +33,9 @@ formulaire existant.
<p>
L'attribut <code>data</code> est obligatoire et contient un dictionnaire
dont les clés sont les identifiants des champs du formulaire (ou leur
nom de variable) et les valeurs le contenu de ces champs.
dont les clés sont les noms de variable (remplacé ici par
<var>varname</var>) des champs du formulaire et les valeurs le contenu de
ces champs.
</p>
<list>
@ -45,6 +46,111 @@ formulaire existant.
</p>
</item>
<item>
<p>
Les champs de type « Liste » acceptent différentes valeurs selon leur
configuration.
</p>
<terms>
<item>
<title>liste simple</title>
<p>La valeur doit être une chaîne tirée de la liste.</p>
<listing>
<code>
"data": {
"<var>varname</var>": "Libellé 1",
}
</code>
</listing>
</item>
<item>
<title>source de donnée</title>
<p>La valeur peut être l'identifiant d'une donnée structurée ou si la
donnée structurée complète est transmise, l'identifiant de la donnée dans
une clé suffixée de <code>_raw</code>, le libellé de la donnée dans la clé
normale et éventuellement la donnée structurée complète dans une clé
suffixée de <code>_structured</code></p>
<listing>
<code>
"data": {
"<var>varname</var>": "1"
}
</code>
</listing>
<listing>
<code>
"data": {
"<var>varname</var>": "Libellé 1",
"<var>varname</var>_raw": "1",
"<var>varname</var>_structured": {
"id": "1",
"text": "Libellé 1",
"foo": "bar"
}
}
</code>
</listing>
</item>
</terms>
</item>
<item>
<p>
Les champs de type « Liste à choix multiple » acceptent différentes valeurs
selon leur configuration.
</p>
<terms>
<item>
<title>liste simple</title>
<p>La valeur doit être une liste de chaînes tirée de la liste.</p>
<listing>
<code>
"data": {
"<var>varname</var>": ["Libellé 1", "Libellé 2"],
}
</code>
</listing>
</item>
<item>
<title>source de donnée</title>
<p>La valeur peut être une liste d'identifiants d'une donnée structurée ou
si la donnée structurée complète est transmise, la liste des identifiants
de la donnée dans une clé suffixée de <code>_raw</code>, la liste des
libellés de la donnée dans la clé normale et éventuellement la liste des
données structurées complètes dans une clé suffixée de
<code>_structured</code></p>
<listing>
<code>
"data": {
"<var>varname</var>": ["1", "2"]
}
</code>
</listing>
<listing>
<code>
"data": {
"<var>varname</var>": ["Libellé 1", "Libellé 2"],
"<var>varname</var>_raw": ["1", "2"],
"<var>varname</var>_structured": [
{
"id": "1",
"text": "Libellé 1",
"foo": "bar"
},
{
"id": "2",
"text": "Libellé 2",
"foo": "bar2"
}
]
}
</code>
</listing>
</item>
</terms>
</item>
<item>
<p>
Les champs de type « Date » sont des chaînes de caractères au format