json.path.read: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 13: | Line 13: | ||
'''Parameters''' | '''Parameters''' | ||
{{param|json|The json | {{param|json|The json data to get the values from.}} | ||
{{param|path|The path of the | {{param|path|The path of the value(s) to retrieve.}} | ||
|examples= | |examples= | ||
| Line 30: | Line 30: | ||
</source> | </source> | ||
which returns {{code| | which returns {{code|Sword}} as a string. | ||
If we instead wanted to return an array with the attacks of every monster, we could type | If we instead wanted to return an array with the attacks of every monster, we could type | ||
| Line 38: | Line 38: | ||
</source> | </source> | ||
which would return {{code|[["Claw","Bite"],["Sword","Punch"]]}}. | which would return {{code|[["Claw","Bite"],["Sword","Punch"]]}}. Starting a path with {{code|.}} will return an array containing the values requested. | ||
Inline filters are also supported, so that if we want the name of the monsters with > 30 HPs, we can type | Inline filters are also supported, so that if we want the name of the monsters with > 30 HPs, we can type | ||
Revision as of 15:17, 28 September 2019
json.path.read() Function
• Introduced in version 1.5.5
Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator
$ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation.
For detailed information on how to specify the path, please read the JsonPath ReadMe.Usage
json.path.read(json, path)Parameters
json- The json data to get the values from.path- The path of the value(s) to retrieve.
Examples
Suppose we have the following nested json:
which returns
[h:troll = json.set("{}", "name", "Troll", "HP", 75, "Attacks", json.append("Claw", "Bite"))]
[h:orc = json.set("{}", "name", "Orc", "HP", 13, "Attacks", json.append("Sword", "Punch"))]
[h:monsters = json.set("{}", "Troll", troll, "Orc", orc)]To access the value of the first weapon of the Orc, we can type
[json.path.read(monsters, "Orc.Attacks.[0]")]which returns Sword as a string.
If we instead wanted to return an array with the attacks of every monster, we could type
[r: json.path.read(monsters, ".Attacks")]which would return [["Claw","Bite"],["Sword","Punch"]]. Starting a path with . will return an array containing the values requested.
Inline filters are also supported, so that if we want the name of the monsters with > 30 HPs, we can type
[r: json.path.read(monsters, ".[?(@.HP > 30)].name")]["Troll"].