Available translations

API Response Field

foundations.png
api-response-field.png
The API responds with a JSON object. Each property of the object is mapped as a node of this type. This node can have children of the same type allowing users to map a complex data structure.
API Response Field Configuration
Properties
  • codeName: The codeName needs to be the exact name of the property held in the response JSON object.
  • fieldType: This property declares if the data is a number, string, object, or array.
  • description: The API Map is expected to be used not only by the user who created, but once contributed as a Plugin, by all other users. This property is useful to store the description of this field as it was written at the API Server documentation, to avoid other users to go and look for it.
Possible Values for Field Type Property
This property is very important and needs to be defined very well. This property defines the structure of the response data structure and needs to be very precise. It's possible values are:
  • number: Any type of numbers fall into this category, including dates timestamps in numbers.
  • string: Any strings falls into this category, including dates in string format.
  • object: Use this value when you find that the field holds a JSON object enclosed in { and }
  • array: Use this type when the value of the field is a JSON array enclosed in [ and ]
Initial Values
These are the Initial Values for API Response Field configuration: 
 {
    "codeName": "",
    "fieldType": "",
    "description": ""
}
Examples
This is a list of properties featured by the API Response Field configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
API Response Field Menu
The API Response Field 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 Add API Response Field menu item has the following properties:
  • action: Add UI Object
  • label: Add API Response Field
  • relatedUiObject: API Response Field
  • actionFunction: payload.executeAction
  • actionProject: Visual-Scripting
  • relatedUiObjectProject: Foundations
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
API Response Field Children
The API Response Field node has the following childrenNodesProperties:
The Api Response Fields node property features the following properties:
  • name: apiResponseFields
  • type: array
  • childType: API Response Field
  • autoAdd: false
API Response Field Attaching Rules
The following are the Node Attaching Rules that govern the attachment of API Response Field with other nodes:
Compatible Types: