SYNTAX

Core command

Generated entirely from the endpoint's own stored parameter metadata (CONFIG API), never a separately maintained syntax string, so it can never drift from what RUN actually accepts. Requires an active CONNECT API session (unlike SHOW ENDPOINT, even a numeric id is scoped to that session's API here). Shows the canonical colon-style URL, every required path/query parameter, optional query parameters with their allowed values, and both a literal and a parameterized (VAR-based) RUN example. The argument accepts a numeric id, an alias, or a name; a name matching more than one endpoint is reported as an ambiguous-candidates table instead of being guessed at, same as SHOW ENDPOINT.

Arguments

<id|alias|name> (mandatory, requires an active CONNECT API session): a numeric endpoint id, alias, or name, all scoped to that session's API

Examples

SYNTAX CUST;
SYNTAX 84;
SYNTAX findAll;

Notes

SYNTAX <endpoint-id|alias|name>; - SPRINT XT02A (URL-Native API Execution), section 3.4: the short, execution-oriented "how do I call it?" help, generated entirely from the endpoint's own stored metadata (ApiSyntaxFormatter) - never a separately hand-maintained syntax string. Scoped to the active CONNECT API session's API, exactly like RUN itself.

SPRINT XT02B, section 6: the token is resolved via the shared ApiEndpointReferenceResolver (id, alias, or unique name, not alias-only as before this sprint); a name matching more than one endpoint is reported as an ambiguous-candidates table rather than guessed at.

Last modified in release 5.2.6.