| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Overview
Use a
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Basic Settings
Expect literal values or expressions encapsulated within ${} syntax, for example ${in.MyValue}. A worked example of the JSON Action is provided at the end of this page.
| Field | Description | Example Value |
|---|---|---|
| Name | Name given to the action node. This will be displayed on the actionflow canvas. | MyJSONReader |
| Input Expression | The input expression provides the JSON data to be operated upon. Typically this will be a simple expression pointing at an incoming attribute such as the body from a an HTTP Action or the body from an API request. | // consist of the name of the pipe and the name of a // mapped attribute.
|
| Use Strict JSON parsing | Defines the parsing of the JSON, disabled will be loose and enabled will be strict. | Disabled. |
| Path | The JSON Path expression is evaluated against the data provided by the Input Expression and returns a list of JSON node items. It can be used to specify which nodes are extracted from the JSON. | // JSON Path $.main_page.title |
Input Connection Points
Can Accept a single
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
The grid contains a list of all input connection points and their type.
- To add a new input connection point, in the section toolbar click
to open a new input connection point and set its properties; see Input Connection Points.Insert excerpt _add _add nopanel true - To edit an existing input connection point, double-click it in the list to open its properties.
- To remove an input connection point, select one and in the section toolbar click
.Insert excerpt _delete _delete nopanel true
Output Connection Points
This section has a toolbar with standard buttons. The grid contains a list of all output connection points.
- To add a new output path, in the section toolbar click
to open a new output path and set the expression; see Output Connection Points.Insert excerpt _add _add nopanel true - To edit an existing output path, double-click it in the list to open its properties.
- To remove an output path, select one and in the section toolbar click
.Insert excerpt _delete _delete nopanel true
Output Attributes
JSON is converted into data objects that can be used by PhixFlow, this information is accessed using the syntax, _result.AttributeName.
Worked Example
Below is an example JSON object passed to the JSON Action Node:
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
// Example JSON string.
{
"main_page": {
"page": "PF Main Page",
"title": {
"name": "PF Title Text",
"data": [
{"initials": "AA", "value" : "Alistair Andrews"},
{"initials": "BB", "value" : "Bert Brown"}
]
}
}
} |
JSON Path: $.main_page.title
This path will bring back all elements matching the JSON path including the parent/grandparents and all child elements. The path defines the starting point from which we reference the JSON nodes.
The following examples show how to reference the returned JSON data:
_result.name, returns PF Title Text_result.^.page, returns PF Main Page- The ^ traverses up the JSON hierarchy.
listToString(_result.data.initials), returns "AA, BB"- Because there are multiple JSON nodes under
_result.data.initials, an array of data is returned. See Array Handling Functions.
- Because there are multiple JSON nodes under
| Info | ||
|---|---|---|
| ||
|
Learn More
For links to all pages in this topic, see Understanding Actionflows.