JSON関数 ​

JSON関数は、JSONテキストとWEL値の間で変換し、パスで構造をクエリします。

通常のレシピデータでJSON関数が必要になることはほとんどありません。入力フィールドはすでにWEL値として到着し、データを変換アクションが結果をシリアライズします。フィールド内にJSONが存在する場合、たとえば本文を文字列として配信するウェブフック、JSONドキュメントを保持するデータベース列、または送信先にテキストとして渡す必要があるペイロードなどで使用します。

変換 ​

次の関数は、JSONテキストとWEL値の間で変換します:

parse_json ​

JSON文字列をWEL値に解析します。

parse_json(text, options)

認識されないオプションキーは無視されず、E222を発生させます。

parse_json('{"sku": "WID-1", "qty": 3}')

{sku: "WID-1", qty: 3}

to_json ​

WEL値をJSON文字列にシリアライズします。

WELはListまたはMapを文字列に暗黙的に変換することはありません。誤って文字列化されたコレクションは、下流で最も見つけにくい変換バグの1つだからです。代わりに、これをテキストにするには、この関数または別の明示的なシリアライザーを呼び出します。

to_json(value, options)

to_json({sku: 'WID-1', qty: 3})

{"sku":"WID-1","qty":3}

ユースケース: JSON文字列フィールドを展開する ​

ウェブフックは本文を単一の文字列フィールドとして配信します。 JSON関数を使用して解析し、送信先が受け入れるフィールドのみを保持します:

入力

{
  "payload": "{\"order_id\":\"SO-1001\",\"total\":149.5,\"internal\":true}"
}

Formula

parse_json(_.payload) >> pluck(['order_id', 'total'])

出力

{"order_id": "SO-1001", "total": 149.5}

pluckは許可リストであるため、internalは削除され、ソースが後で追加するフィールドも削除されます。

パスでクエリ ​

次の関数は、先にWEL値に解析することなく、JSONPath式を使用して構造をクエリします:

json_path ​

WELがサポートするRFC 9535 JSONPathのサブセットを使用して値をクエリします。一致するノードのListを常に返します。一致するものがない場合は空のリストであり、nullになることはありません。

サポートされているセレクター:

フィルター、和集合、および関数拡張は実際のRFC 9535機能ですが、WELでは現在サポートされていません。これらはE224を発生させます。代わりにdeep_collect_byまたはfilter_byを使用します。無効なセレクターはE223を発生させます。

json_path(value, path)

json_path({store: {book: [{price: 10}, {price: 20}]}}, '$.store.book[*].price')

[10, 20]

json_path({a: {b: {c: 'x'}}}, '$..c')

["x"]

json_path({a: 1}, '$.missing')

[]

ユースケース: ネストされたレスポンスからすべてのSKUを取り出す ​

APIは注文を返し、それぞれに独自の明細項目があります。各レベルを個別にたどるのではなく、1つの再帰パスでJSONPath式を使用してすべてのSKUを収集します:

入力

{
  "orders": [
    {"line_items": [{"sku": "WID-1"}, {"sku": "GAD-7"}]},
    {"line_items": [{"sku": "BOX-2"}]}
  ]
}

Formula

json_path(_, '$..line_items[*].sku')

出力

["WID-1", "GAD-7", "BOX-2"]

結果は常にリストであるため、注文のないペイロードでは[]になります。以降のステップは、nullで失敗するのではなく動作し続けます。

関連情報 ​

• ディープマップ関数: json_pathがサポートしないフィルターを含め、述語で値を収集します。
• マップ関数: pluck、except、およびflatten_mapに関する情報。
• データ型: 金額の解析時にDecimalが重要な理由。
• エラーコード: E222、E223、E224などのジョブ失敗をトラブルシューティングします。