Superalgos - API Query Response

API Query Response

This node enables the definition of a particular response from the API call.

API Query Response Configuration

Properties

codeName: At the codeName property, the API Fetcher Bot will expect to find the http response code from the API call handled by this node. You will need to have at least one of these nodes with a codeName = "200" (that is the standard code for success).

isError: Define if the status code should be considered an error or not.

Tip: If you wish to be able to react to other error codes, you should also have more of these nodes with the codeName of each status you want to cover. If the receives a response code that has not been defined, it will stop processing and error out.

Here is an example API Query Response config:

 {
    "codeName": "200",
    "isError": false
}

Initial Values

These are the Initial Values for API Query Response configuration:

 {
    "codeName": "",
    "isError": false
}

Examples

This is a list of properties featured by the API Query Response configuration. Expanding a property shows sample values for the property extracted from the current .

API Query Response Menu

The API Query Response node has the following 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 Schema menu item has the following properties:

action: Add UI Object

disableIfPropertyIsDefined: true

propertyToCheckFor: apiResponseSchema

label: Add API Response Schema

relatedUiObject: API Response Schema

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 Query Response already has the required child type that the menu item may add, and only that child is allowed for that case.

API Query Response Children

The API Query Response node has the following childrenNodesProperties:

The Api Response Schema node property features the following properties:

name: apiResponseSchema

type: node

childType: API Response Schema

autoAdd: true

API Query Response Attaching Rules

The following are the that govern the attachment of API Query Response with other nodes:

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.