Superalgos - API Query Parameters

API Query Parameters

A query string is part of a uniform resource locator (URL). The query parameter is added to the base URL and assigns values to specified parameters in order to specify the request for data to the API.

In other words, an API Query is part of the URL used to request information from an API. These values are held after the? in the request URL. Queries are generally used to make adjustments to the type of data the api will return. For example, if an api endpoint accepts a time query, you will be able to request data from a specific time period.

Note: Query Parameters in general do not need to be defined in any specific order, so feel free to add children for this node in whatever order you like.

Tip: When a is found at the , it will define the default values based on the value property of each node. However, if the replaceBy property is used the system will pull the value from the user's system. Examples of this are the current time, current exchange being used, etc.

API Query Parameters Menu

The API Query Parameters node has the following items:

The Add API Query Parameter menu item has the following properties:

action: Add UI Object

label: Add API Query Parameter

relatedUiObject: API Query Parameter

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

API Query Parameters Children

The API Query Parameters node has the following childrenNodesProperties:

The Api Query Parameters node property features the following properties:

name: apiQueryParameters

type: array

childType: API Query Parameter

autoAdd: true

API Query Parameters Attaching Rules

The following are the that govern the attachment of API Query Parameters 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.