BroadSQLOn this page
SYNTAX
Core command
Shows how to call an endpoint of the connected API: its URL, its parameters and RUN examples.
Syntax
SYNTAX <endpoint>Arguments
| Argument | Required | Values | Default |
|---|---|---|---|
<endpoint> | Yes | The numeric id, alias or name of an endpoint of the connected API | None |
Examples
SYNTAX CUST;
SYNTAX 84;
SYNTAX findAll;Details
The help is built from the endpoint's own definition (CONFIG API), so it always matches what RUN accepts. It shows:
- the URL, with
:nameplaceholders; - every required path and query parameter, and the optional query parameters with their allowed values;
- a
RUNexample with literal values, and one withVARvariables.
It needs a CONNECT API session: the endpoint is looked up in that API only, even by its numeric id, unlike SHOW ENDPOINT. The endpoint is named by its id, alias or name; a name that matches several endpoints shows the candidates in a table instead of choosing one.
Related
- RUN
- SHOW ENDPOINT, the full definition
- VAR
- Running API requests
Last modified in release 5.5.0.
Found something wrong or unclear on this page? Tell us, with the page address.