Zum Hauptinhalt springen

JSONPath

Category: Transform
Node id: jsonpath

Extracts values from JSON data using dot-notation path expressions with array index support

What it does​

  • Dot-notation path expressions for nested JSON access
  • Array index support (e.g., items[0].name)
  • Input-driven path override from upstream nodes
  • Found/not-found detection for optional fields

Use cases​

  • Extract patient name from a nested FHIR Patient resource
  • Access specific array elements in FHIR Bundle entries
  • Pull deeply nested values from complex API responses

Runtime​

  • Performance tier: fast

Input ports​

NameTypeRequiredDescription
datajsonYesJSON data to extract from
pathtextNoOptional path override from input (takes precedence over config)

Output ports​

NameTypeRequiredDescription
valueanyNoExtracted value
pathtextNoPath that was used for extraction
foundbooleanNoWhether the path resolved to a value

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
PathpathstringYesDot-notation path to extract (e.g. user.profile.name, items[0].id)

Errors​

CodeDescription
MISSING_PATHPath configuration is required but not provided
PATH_NOT_FOUNDThe specified path does not exist in the input data

Runtime notes​

  • value is nil and found=false when the path does not exist — the node does NOT error on missing paths
  • Use dot notation for objects and [N] for arrays: e.g., entry[0].resource.id
  • Path from input port overrides the config path — useful for dynamic extraction in loops
  • Path '.' returns the entire input data object unchanged

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..