Smart Structure Énuméré

Valeurs possibles des Smart Fields énumérés

URL

GET /api/v2/smart-structures/<family}/enumerates/{enum>

Récupération des valeurs de l'énuméré du smart field enum de la Smart Structure family.

GET api/v2/enumerates/<enum>/

Récupération des valeurs de l'énuméré enum identifié par sa référence.

INFO

Ces deux URL retournent la même donnée JSON.
Seule la manière de récupérer les valeurs de l'énuméré diffère.

Contenu

Le contenu de la requête est vide.

Structure de retour

Le retour de la requête est une donnée JSON.

En cas de réussite

La partie data contient les champs suivants:

• data.key: valeur du Smart Field énuméré,
• data.label: label du Smart Field traduit dans la langue de l'utilisateur,
• data.originalLabel: label du Smart Field non traduit,
• data.parentKey: valeur du Smart Field parent,
• data.path:
• data.requestParameter: filtre appliqué à la recherche,
• data.enumItems: tableau d'objets:
  • key: valeur de l'élément,
  • label: label traduit dans la langue de l'utilisateur,
  • originalLabel: label non traduit de l'élément,
  • parentKey: valeur de l'élément parent,
  • path:

Exemple:

{
  "success": true,
  "data": {
    "key": "bcc",
    "label": "Bcc",
    "originalLabel": "Bcc",
    "parentkey": null,
    "path": "bcc",
    "requestParameters": {
      "operator": "contains",
      "keyword": "",
      "orderBy": "none"
    },
    "enumItems": [
      {
        "key": "to",
        "label": "À",
        "originalLabel": "À",
        "parentkey": null,
        "path": "to"
      },
      {
        "key": "cc",
        "label": "Cc",
        "originalLabel": "Cc",
        "parentkey": null,
        "path": "cc"
      },
      {
        "key": "bcc",
        "label": "Bcc",
        "originalLabel": "Bcc",
        "parentkey": null,
        "path": "bcc"
      }
    ]
  },
  "messages": []
}

En cas d'échec

Les raisons d'échecs spécifiques à cette requête sont:

Raison	Status HTTP	Code d'erreur
Smart Structure non trouvée	404	CRUD0200
Smart Field non trouvé	404	CRUD0400
Smart Field de type non énuméré	403	CRUD0401

Résultat partiel (?keyword et ?operator)

Il est possible de filtrer les résultats pour n'en retourner qu'un sous ensemble.

• GET /api/v2/smart-structures/MAIL/enumerates/mail_copymode?keyword=bcc,
• GET /api/v2/smart-structures/MAIL/enumerates/mail_copymode?operator=startswith&keyword=b.
  Les paramètres sont:
• keyword: le terme recherché,
• operator: l'opérateur appliqué à la recherche, deux choix sont possibles:
  • startswith: le label commence par le label keyword,
  • contains: le label contient keyword.

Ordre des résultats (?orderBy)

Il est possible de spécifier l'ordre dans lequel les résultats doivent être retournés.

• GET /api/v2/smart-structures/MAIL/enumerates/mail_copymode?orderBy=none.
  Les valeurs possibles pour orderBy sont:
• none (tri par défaut): trie les énumérés par l'ordre indiqué dans la définition de l'énuméré,
• key : trie les énumérés par ordre alphabétique de leur clé; ce tri ne tient pas compte de la locale de l'utilisateur. C'est un tri alphabétique non naturel.
• label: trie les énumérés par ordre alphabétique de leur label; ce tri ne tient pas compte de la locale de l'utilisateur.