4 Fonctionnalité JSONPath

Vue d'ensemble

Cette section présente les fonctionnalités JSONPath prises en charge dans les étapes de prétraitement des valeurs d'élément.

JSONPath est composé de segments séparés par des points. Un segment peut prendre la forme d'un mot simple, représentant un nom de valeur JSON, du caractère générique (*) ou d'une construction plus complexe placée entre crochets. Le point précédant un segment entre crochets est facultatif et peut être omis.

Voir aussi : Échappement des caractères spéciaux des valeurs de macro LLD dans JSONPath.

Segments pris en charge

Pour trouver un segment correspondant sans tenir compte de son ascendance (segment détaché), il doit être préfixé par deux points (..). Par exemple, $..name ou $..['name'] renvoient les valeurs de toutes les propriétés name.

Les noms des éléments correspondants peuvent être extraits en ajoutant un suffixe tilde (~) au JSONPath. Cela renvoie le nom de l’objet correspondant ou un index au format chaîne de l’élément de tableau correspondant. Le format de sortie suit les mêmes règles que les autres requêtes JSONPath : les résultats d’un chemin défini sont renvoyés « tels quels », et les résultats d’un chemin indéfini sont renvoyés dans un tableau. Cependant, il y a peu d’intérêt à extraire le nom d’un élément correspondant à un chemin défini, car il est déjà connu.

Expression de filtre

L'expression de filtre est une expression arithmétique en notation infixée.

Opérandes pris en charge :

Opérateurs pris en charge :

Fonctions

Les fonctions peuvent être utilisées à la fin d’un JSONPath. Plusieurs fonctions peuvent être chaînées si la fonction précédente renvoie une valeur acceptée par la fonction suivante.

Fonctions prises en charge :

Les fonctions d’agrégation JSONPath acceptent des valeurs numériques entre guillemets. Ces valeurs sont automatiquement converties de chaînes en types numériques lorsqu’une agrégation est nécessaire. Une entrée incompatible entraînera la génération d’une erreur par la fonction.

Valeur de sortie

Les JSONPath peuvent être divisés en chemins définis et indéfinis. Un chemin défini ne peut renvoyer que null ou une seule correspondance. Un chemin indéfini peut renvoyer plusieurs correspondances : JSONPath avec des listes de noms/index détachées ou multiples, des tranches de tableau ou des segments d’expression. Cependant, lorsqu’une fonction est utilisée, le JSONPath devient défini, car les fonctions produisent toujours une seule valeur.

Un chemin défini renvoie l’objet/le tableau/la valeur auquel il fait référence. En revanche, un chemin indéfini renvoie un tableau des objets/tableaux/valeurs correspondants.

Règles de formatage des chemins

Les espaces (espace, caractère de tabulation) peuvent être utilisés dans les segments et expressions en notation entre crochets, par exemple : $[ 'a' ][ 0 ][ ?( $.b == 'c' ) ][ : -1 ].first( ).

Les chaînes doivent être entourées de guillemets simples (') ou doubles ("). À l’intérieur des chaînes, les guillemets simples ou doubles (selon ceux utilisés pour les entourer) ainsi que les barres obliques inverses (\) sont échappés avec le caractère barre oblique inverse (\).

Exemple

{
  "books": [
    {
      "category": "référence",
      "author": "Nigel Rees",
      "title": "Paroles du siècle",
      "price": 8.95,
      "id": 1
    },
    {
      "category": "fiction",
      "author": "Evelyn Waugh",
      "title": "Sword of Honour",
      "price": 12.99,
      "id": 2
    },
    {
      "category": "fiction",
      "author": "Herman Melville",
      "title": "Moby Dick",
      "isbn": "0-553-21311-3",
      "price": 8.99,
      "id": 3
    },
    {
      "category": "fiction",
      "author": "J. R. R. Tolkien",
      "title": "Le Seigneur des anneaux",
      "isbn": "0-395-19395-8",
      "price": 22.99,
      "id": 4
    }
  ],
  "services": {
    "delivery": {
      "servicegroup": 1000,
      "description": "Livraison le lendemain dans la ville locale",
      "active": true,
      "price": 5
    },
    "bookbinding": {
      "servicegroup": 1001,
      "description": "Impression et assemblage du livre au format A5",
      "active": true,
      "price": 154.99
    },
    "restoration": {
      "servicegroup": 1002,
      "description": "Diverses méthodes de restauration",
      "active": false,
      "methods": [
        {
          "description": "Nettoyage chimique",
          "price": 46
        },
        {
          "description": "Pressage des pages endommagées par l'humidité",
          "price": 24.5
        },
        {
          "description": "Réfection de la reliure d'un livre déchiré",
          "price": 99.49
        }
      ]
    }
  },
  "filters": {
    "price": 10,
    "category": "fiction",
    "no filters": "pas de \"filtres\""
  },
  "closed message": "Le magasin est fermé",
  "tags": [
    "a",
    "b",
    "c",
    "d",
    "e"
  ]
}