Output Path | Streamlining State Output for Efficient Processing | Circuit | Online Help

Output Path

Output Path enables you to select a portion of the state's output and transfer it to the next state for processing, eliminating any unecessary objects from the JSON output. If the Output Path isn't specified, the entire JSON node (determined by the state input, state result, and Result Path) will be sent as the state output to the next state.

 

For example, suppose you receive the following JSON as the state's output from the Result Path:

{
"employee_info": {
"name": "Martin",
"emp_id": "543",
"date of birth": "12Nov1990"
},
"added_info": {
"role": "PM Associate",
"location": "New York"
}
}

You can choose only the values of employee_info from the output to pass to the next state by defining the output_path as shown below:

{
  "get_employee_details": {
"type": "pass",
"next": "End",
"start": true,
"output_path": "$.employee_info"
}
}


The output JSON of the state will then be:
{
"name": "Martin",
"date of birth": "12Nov1990",
"emp_id": "543"
}
   



Next: Context Object