Superalgos - API Map Reference

API Map Reference

This node allows users to define a reference to an API Map. When the bot is run, it will use the referenced API Map to extract data from the API.

Important: For this node to be correctly installed and a reference established to the API using the Install New procedure, both the and the API Data Map needs to have exactly the same config property codeName, otherwise, this node will be created but you will have to establish the reference manually.

For a more indepth description of what an is please see the page.

API Map Reference Menu

The API Map Reference node has the following items:

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

Tip: When a menu item is grayed out, it means that API Map Reference already has the required child type that the menu item may add, and only that child is allowed for that case.

API Map Reference Attaching Rules

The following are the that govern the attachment of API Map Reference with other nodes:

Compatible Types:

API Map Reference Referencing Rules

The following are the that determine which nodes API Map Reference may establish a reference to:

Compatible Types:

Superalgos is an open-source project run and governed by a decentralized community of contributors. There is no legal entity behind the project. Our body of work lives on the Internet.