GH-Elements

API Element

API Element is a gh-element that allows to create requests and send them to the GudHub server. Its work is based on the automation. Therefore, it has a separate automation settings window that opens when you click on the pencil button near the switch. API has unique set of nodes. Also, there are two unique default nodes called API and Response.

Each API field contains the credentials of the created response. Those data can be used to create a link by which you can see the response. You can see after clicking on the button Credentials. But one parameter is missing. You need to enter it yourself in the field beside the Credentials button.

Functional Characteristic

This element is used to generate requests based on data taken from applications. You also can create objects. So, the API element is suitable for all tasks that require sending any requests.

Value Format

The current element does not contain any value.

Element Options

This element can only be configured using the standard field settings.

Settings of API element field

Element Style

The api element has a fairly simple appearance that can be customized with a set of standard options. Its interpretation types are described below.

Style of API element

Data Model

The current element has quite small data model:

{
    "data_model": {
        "automation": {},
        "interpretation": []
    }
}
Name Type Description
automation object contains all configured automation settings
interpretation array contains all interpretation types

Filtration

This filter cannot be filtered out.

Interpretation

The current element has only two interpretation types.

Types of API interpretation

Default

The default interpretation type displays element as an icon.

Switch

Another type allows you to display the element as a radio button with a pencil button next to it.