Customizing JSON Input with Parameters | Online Help | Circuit | Input and Output Processing

Parameters

Parameters provide the ability to customize JSON input passed into a state by adding key–value pairs. These values can be static or dynamically derived from multiple sources such as Circuit Input, Config Store variables, the Context Object, or even generated dynamically using Faker.
Context Object is a unique JSON entity containing details about the state's execution. For further insights, refer to the Context Object section.

 

Parameters are available for the following states:

  • Function

  • Webhook

  • Task Engine

For better understanding, let's consider the following standard JSON input as an example:
{
	"employee_details": {
		"emp_name": "John Doe",
		"emp_id": "357AEZ",
		"email": "john.doe@example.com",
	},
	"department": "Engineering",
	"start_date": "2024-04-01",
}

To extract specific information, you can define these parameters as given below in the code view:
{
	"get_employee_details": {
		"type": "function",
		"next": "End",
		"start": true,
		"function_id": "<function_name>",
		"parameters": {
			"name": "$.employee_details.emp_name",
			"ID": "357AEZ"
			"execution_id": "$$.execution.id",
			"auth_key": "${config_linkname}",
			"dummy_city":  "${#random.address.city}"
		}
	}
}
With the given parameter configuration, the following JSON will be passed:
{
      "name": "John Doe",
      "ID": "357AEZ",
      "execution_id": "<runtime execution_id>",
      "auth_key": "<config_linkname>",
      "dummy_city": "North Carolina"
}

 




    • Related Articles

    • Context Object

      Context Object is used to access runtime information during the Circuit execution. It contains data related to the circuit, state, execution, task, and more. By understanding its structure and how to access it, you can dynamically utilize runtime ...

    • 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, ...

    • Task Engine

      In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in Bridge ...

    • Task Engine

      Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...

    • 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 ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.