Available translations
loading results
API Response Field Reference
This node allow users to reference an API Data Field from a Record Property. In other words it allows to link each piece of data the user wants to be saved locally to the field at the API Map that will hold the data at runtime.
Once created, you need to reference an API Data Field.
Important: All references originating at the same Record Definition must be to API Data Fields living at the same API Endpoint.
Record Property Configuration
Properties
Tip: nodePath is a property that is required when the API Response Field referenced is not under the Data Root object within the response structure.
The response from the API Server might include some header type of data and the actual data requested. Since the response is a JSON object, then the actual data might be located somewhere within the structure of that object. The API Response Schema node has a property
nodePath that allows users to declare the path to the actual data requested, so as to jump the header-like information. We call the API Response Field where the data is held, the Data Root. In order to extract individual values for each Record Property, the API Data Fetcher Bot needs to dynamically discover the
nodePath for each Record Property at the response data structure and can do it as long as the API Response Field referenced is under the Data Root. To auto discover the nodePath it uses the API Response Schema nodePath to locate the Data Root, and then it follows the reference from the API Response Field Reference node to the API Response Field and climbs upwards until it reach the API Response Schema. While climbing upwards it discovers the nodePath that it needs to grab the value from the response data structure. That is how it works. When the referenced API Response Field is outside the scope of the Data Root, the process is not able to auto discover this path and need users to manually define the
nodePath (from the API Response Schema to the API Response Field that holds the value) and set it in this property. That happens for instance when the API Response Field is part of the header of the API Server response. Initial Values
These are the Initial Values for API Response Field Reference configuration:
{
"nodePath": ""
} Examples
This is a list of properties featured by the API Response Field Reference configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
API Response Field Reference Menu
The API Response Field Reference node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- actionFunction:
uiObject.configEditor.activate
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that API Response Field Reference already has the required child type that the menu item may add, and only that child is allowed for that case.
API Response Field Reference Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Response Field Reference with other nodes:
Compatible Types:
API Response Field Reference Referencing Rules
The following are the Node Referencing Rules that determine which nodes API Response Field Reference may establish a reference to:
Compatible Types: