Input Path enables you to filter and control the actual input passed to the state. By defining an Input Path (either in Builder View or Code View), using JSONPath notation, you can select a portion of the JSON input and use it for processing within the state.
Consider the following JSON, received as an output from the state's execution, which represents the state input:
{
"employee1": {
"name": "Angelina",
"emp_id": "357",
"location": "CA"
},
"employee2": {
"name": "Martin",
"emp_id": "543",
"location": "New York"
}
}
Let's apply the Input Path (in Code view) within the state definition:
{
"get_employee_details": {
"type": "pass",
"next": "End",
"start": true,
"input_path": "$.employee2"
}
}
As a result, the JSON input passed to the state will be:
{
"name": "Martin",
"emp_id": "543",
"location": "New York"
}
The state will now process the filtered JSON only containing the details of 'User2', as specified by the applied Input Path. This allows you to work with a specific subset of the original JSON input within the state's processing logic.
Related Articles
JSON Path
Path serves to locate specific parts or components within a JSON object. These paths start with the '$' symbol and follow JSONPath syntax. It is used to access particular elements or values within JSON objects passed in the Input Path, Output Path, ...
Sample Use Case - Configuring Input and Output Processing in Circuit console
Let's explore Input/Output Processing further by building a Circuit using the example of an Employee Onboarding Process. We initiate the process with the following state Input which contains information about the employee details for employee ...
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 ...
Result Selector and Result Path
Result Path and Result Selector are employed to extract dynamic data from the state's result when the execution is successful. Result Selector Result Selector lets you retrieve and process the runtime data, enabling flexible and dynamic data ...
Error Selector and Error Path
Error Selector and Error Path are used to manage errors in a system. While Result Selector and Result Path control the output of a state upon successful execution, Error Selector and Error Path come into play when the are exceptional circumstances, ...