Skip to main content

ConnectorQueryRequest

Ad-hoc request through an existing connector. rest connectors only for now: the request is handed to the connector's verb functions — the connector script owns auth/transport specifics (e.g. the SAP BW $batch read tunnel). GET is always available; write verbs additionally require the connector to opt in via options.allow_console_writes.

methodMethod (string)

HTTP verb to exercise. Non-GET verbs can mutate the target system and require options.allow_console_writes=true on the connector.

Possible values: [GET, POST, PUT, PATCH, DELETE]

Default value: GET
pathPath (string)required

Request path relative to the connector's base_url (absolute URLs are rejected).

Possible values: non-empty and <= 8192 characters

params object

Query parameters (e.g. $select / $filter / $format). For non-GET verbs they are folded into the path's query string.

property name* object
anyOf
string
body object

JSON request body — POST/PUT/PATCH only.

anyOf
limitLimit (integer)

Maximum number of normalized rows returned (excess is truncated).

Possible values: >= 1 and <= 10000

Default value: 100
ConnectorQueryRequest
{
"method": "GET",
"path": "string",
"params": {},
"limit": 100
}