within

The within Instruction executes a list of Instructions for a single nested record within the input Record. This is used to move into nested data structures in JSON input data.

action "within"
source The property in the input Record containing the nested data structure.
instructions An array of Instructions to be executed.

Example

With an input record structured like:

?
1
2
3
4
5
6
{
    "username": "jbloggs",
    "dates": {
        "start": "2017-09-23"
    }
}

the start date needs to be referred to inside a within Instruction:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
{
    "action": "within",
    "source": "dates",
    "instructions": [
        {
            "source": "start",
            "destination": "project-dates",
            "name": "start",
            "dateFormat": "yyyy-MM-dd"
        },
        // ...
    ]
}