Mapper la description d’un champ de type enum dans les API

Request description

Bonjour, il y a t’il une solution pour récupérer la description dans les API pour un champ de type enum ? Je sais qu’il y a déjà eu des questions sur ce sujets mais il y a t’il eu des nouveautés ?

Cordialement

Technical information

Status=OK
Version=5.3.12
BuiltOn=2023-08-25 09:44
Git=5.3/e2cd9f0ea850e3845169840790a1a6ef043fed16
Encoding=UTF-8
EndpointIP=172.17.0.8
EndpointURL=http://706ae0910e83:8080
TimeZone=Europe/Paris
SystemDate=2023-09-05 16:27:56

[/details]

Bonjour

Je ne suis pas sûr de bien comprendre de quoi on parle exactement…

De quels type d’API parlez vous ? APIs REST standard ? API REST mappées ? API custom annontées ? autre ?

Qu’entendez vous par “description dans les API” ? Qu’est ce qui vous manque exactement ?

Dans une api rest lors d’un appel get on voudrait récupérer le nom de l’activité et le code mais actuellement comme le nom est dans un champ enum j’arrive juste à renvoyé le code

Le code de l’api:

Le résulta dans postman :
Capture_5

Vous confondez la “Description” qui est un libéllé purement documentaire et la valeur traduite d’un code de la liste de valeur, ex:

La “Description” n’a donc pas vocation à être échangée lors des appels d’API.

A nouveau, j’ai besoin de savoir de quelles APIs on parle pour vous indiquer la manière d’obtenir la valeur traduite à la place ou à partir du code

Oui pardon on est dans une api RESTMappedObjectsExternalObject

OK donc je reformule votre question: “Comment faire en sorte qu’un appel GET (= liste de résultat de recherche ou record unitaire) à une API REST mappée renvoie la valeur traduite dans la langue du user appelant au lieu de la valeur du code pour un attribut énuméré ?”

Pour généraliser cette demande, il faudrait aussi envisager les autres type d’attributs qui, dans la UI standard, s’affichent aussi d’une manière qui dépend de la langue et/ou de la config du user appelant (ex: booléens 1/0 => Yes/No ou Oui/Non et dates datetime au format local du user).

Autrement dit le besoin généralisé serait de pouvoir demander les valeurs “humainement lisibles” et/ou les valeurs “techniques” lors des appels GET aux APIs mappées

Si ça correspond à votre besoin je propose de gérer ça comme une feature request d’évolution des APIs mappées.

NB: dans le cas d’un appel en création (POST) ou en mise à jour (PUT) c’est par contre uniquement les valeurs “techniques” qu’il faut passer (= code des listes de valeur, 1/0 pour les booléens, dates/datetimes au format technqiue (YYYY-MM-DD[ HH:mm:ss])

PS: merci d’indiquer la version Simplicité que vous utilisez

Oui c’est exactement ma demande, je suis en 5.3.12

OK je passe le post en feature request

Bonjour

L’évolution suivante a été faite sur les APIs mappées pour les appels GET (search & select):

  • un paramètre d’URL optionnel _display=true/false (false par défaut) permet d’obtenir les valeurs affichables au lieu des valeurs techniques.
  • ces valeurs affichables dépendent de la configuration du user appelant (ex: langue pour les libellé des listes de valeur et des booléens, formats de date/time, …)

Ex:

Sans le paramètre _display:

Avec le paramètre _display à true (le user appelant étant ici configuré en Français):

Cette évolution sera disponible dans le cadre de la révision 5.3.14 prévue cette semaine.

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.