Operational Insights Request REST API (3.0)

Specifies at least one valid SQL++ for Operational Insights statement to run.

An identifier passed by the client that is returned verbatim in the query response. Useful for matching a particular query to a specific caller.

Desired format for the query results.

Note that the only possible format is JSON.

If true, the result is indented.

A scope for the statement. The value of this parameter must start with default:, followed by a scope name. The default: prefix is a dummy and is ignored when resolving a collection name or synonym name.

If true, then DDL statements are not allowed.

The consistency guarantee constraint for index scanning. If not_bounded, the query is executed immediately. If request_plus, the required collections are updated with data available from the Data service at the time of the request before the query is executed.

The maximum time to wait for collections to be updated before the query is executed. The format includes an amount and a unit: ns, us, ms, s, m, or h. The default is "" (no timeout).

Maximum time to spend on the request before timing out. The format includes an amount and a unit: ns, us, ms, s, m, or h. The default is "" (no timeout).

The execution mode of the request. If immediate, the request is executed and the result is returned immediately. If async, the request is executed asynchronously and the client can retrieve the result later. All async requests can be viewed using the Open Requests endpoint, or going to the Open requests under the monitor page in UI workbench. The status and result of an async request can be retrieved using the endpoints described in Request Status and Retrieve Request Result.

Maximum time to retain the result of an async request. The format includes an amount and a unit: ns, us, ms, s, m, or h. The default is "" (use system default).

An array of positional parameter values.

The plan format.

If true, the logical plan is included in the query response.

If true, the optimized logical plan is included in the query response.

If true, the expression tree is included in the query response.

If true, the rewritten expression tree is included in the query response.

If true, the job details are included in the query response.

An integer specifying the maximum number of warning messages to be included in the query response.

If true, the request may contain more than 1 statement, separated by semicolons. If false, a request that contains more than 1 statement fails with error 21003.

The statements run in order. If a statement fails, the statements before it keep their responses and the statements after it are not executed.

A request with more than 1 statement returns a separate response for each statement in the statements array — refer to Query Responses. A request with only 1 statement returns the usual response, even when this parameter is true. USE, SET, and DECLARE FUNCTION statements do not count towards the number of statements, but they do get an entry of their own in the statements array.

A request with more than 1 statement cannot run in async mode, and fails with error 24320. The max-warnings limit applies to each statement separately.