5.4.1. Overview of the API GBOX interface
Displaying a list of existing endpoints by theme
Filtering of this list
Finding out all the information about each endpoint
running the endpoint
Finding out its curl command
Finding out its URL request
Note
The GBox API graphical interface is called swagger.
`API`
button on the title bar, the following screen is displayed.Item |
Description |
---|---|
1 |
|
2 |
Current account name: here administrator account |
3 |
|
4 |
|
5 |
Endpoints are sorted by theme (tag) |
6 |
Filter field: enables the filtering of themes |
5.4.1.1. Detail for an endpoint
The information displayed for an endpoint is as follows:
Item |
Description |
---|---|
1 |
Title line. It includes the action (here GET), the name of the endpoint (here /template), the accesses (here Administrators and Operators), the description of the endpoint |
2 |
|
10 |
`Parameters` field: displays the optional or mandatory settings for executing the query. To find out which parameters are mandatory, refer to zone (6).This zone includes:
|
9 |
|
8 |
|
7 |
|
6 |
|
Note
If a parameter is mandatory, an asterisk with `required`
is displayed.
Note
Parameters cannot be entered on this screen. To do this, the query must be executed.
5.4.1.1.2. Example with default values
In this example, the information is displayed with the following default values:
integer parameters are displayed with the number
`0`
.string parameters are displayed with the text
`string`
.boolean parameters are displayed with the text
`true`
.
The marking is the same as in the output template.