Paramètres¶

Les paramètres sont des valeurs globales stockées dans la table parameters. Une valeur peut être une chaîne, un entier ou une date.

Structure d’un paramètre¶

Valeur	Type	Description
`id`	string	Identifiant du paramètre
`description`	string ou null	Description
`param_value_string`	string ou null	Valeur textuelle assainie côté serveur
`param_value_int`	integer ou null	Valeur entière
`param_value_date`	string ou null	Valeur de date telle que stockée en base
`value`	string ou integer	Valeur normalisée ajoutée aux réponses de liste lorsqu’elle est définie

Lister les paramètres¶

Route¶

GET /rest/parameters

Authentification, privilège et périmètre¶

La route est authentifiée. Avec admin_parameters, elle renvoie les paramètres globaux de l’instance. Sans ce privilège, l'api limite la lecture à traffic_record_summary_sheet, puis ajoute les entrées d’affichage loginpage_message et homepage_message si elles sont absentes.

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Liste des paramètres accessibles	`{"parameters":[{"id":"homepage_message","description":null,"param_value_string":"","param_value_int":null,"param_value_date":null,"value":""}]}`

Lire un paramètre¶

Route¶

GET /rest/parameters/{id}

Authentification, privilège et périmètre¶

Le privilège admin_parameters est requis, sauf pour minimumVisaRole, maximumSignRole, workflowSignatoryRole, suggest_links_n_days_ago, noteVisibilityOffAction, noteVisibilityOnAction et allowMultipleAvisAssignment. La valeur est globale à l’instance.

Paramètres d’URL¶

Valeur	Type	Obligatoire	Description
`id`	string	Oui	Identifiant du paramètre

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Paramètre trouvé	`{"parameter":{"id":"minimumVisaRole","description":"","param_value_int":2,"param_value_string":null,"param_value_date":null}}`
`400`	object	Paramètre absent	`{"errors":"Parameter not found","lang":"parameterNotFound"}`
`403`	object	Paramètre non autorisé sans le privilège	`{"errors":"Service forbidden"}`

Créer un paramètre¶

Route¶

POST /rest/parameters

Authentification, privilège et périmètre¶

Le privilège admin_parameters est requis. La création est globale à l’instance.

Body¶

Valeur	Type	Obligatoire	Description
`id`	string	Oui	Lettres, chiffres, `_` et `-` uniquement
`description`	string	Non	Description du paramètre
`param_value_string`	string	Non	Valeur textuelle, le HTML dangereux est supprimé
`param_value_int`	integer	Non	Valeur entière
`param_value_date`	string	Non	Valeur de date stockée en base

{
  "id": "delai_exemple",
  "description": "Délai technique d'exemple",
  "param_value_int": 5
}

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Paramètre créé	`{"success":"success"}`
`400`	object	Corps invalide	`{"errors":"Bad Request"}`
`400`	object	Identifiant déjà utilisé	Message traduit correspondant à « identifiant déjà existant »
`403`	object	Privilège absent	`{"errors":"Service forbidden"}`

Modifier un paramètre¶

Route¶

PUT /rest/parameters/{id}

Authentification, privilège et périmètre¶

Le privilège admin_parameters est requis. La modification est globale à l’instance.

Paramètres d’URL¶

Valeur	Type	Obligatoire	Description
`id`	string	Oui	Identifiant du paramètre

Body¶

Pour un paramètre stocké en base, le body reprend description, param_value_string, param_value_int et param_value_date. Les identifiants logo, bodyImage, applicationName, maarchUrl, bindingDocumentFinalAction et nonBindingDocumentFinalAction déclenchent des traitements particuliers d’administration de l’interface ou du cycle de vie.

{
  "description": "Délai technique d'exemple",
  "param_value_int": 10
}

Retour¶

Code HTTP	Type	Description	Exemple
`204`	vide	Paramètre modifié	Aucune réponse
`400`	object	Paramètre absent	`{"errors":"Parameter not found"}`
`400`	object	Valeur invalide	`{"errors":"Bad Request"}`
`403`	object	Privilège absent	`{"errors":"Service forbidden"}`

Supprimer un paramètre¶

Route¶

DELETE /rest/parameters/{id}

Authentification, privilège et périmètre¶

Le privilège admin_parameters est requis. La suppression est globale à l’instance. Un identifiant contenant chrono_ entraîne aussi la suppression de la séquence PostgreSQL associée.

Paramètres d’URL¶

Valeur	Type	Obligatoire	Description
`id`	string	Oui	Identifiant du paramètre

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Paramètre supprimé et liste restante renvoyée	`{"parameters":[]}`
`403`	object	Privilège absent	`{"errors":"Service forbidden"}`