Active Query Builder Web API

Specification

Open API (Swagger) Specification

Active Query Builder Web API is built with the Swagger framework (OpenAPI Specification), so you can instantly get a client for all supported platforms.

  1. Download Active Query Builder Web API specification.
  2. Open the Swagger framework editor.
  3. Load the specification into the editor.
  4. Click the "Generate Client" button and select your programming language. The requested client will be downloaded to your PC.

API specification

Active Query Builder Web API lets create, analyze and modify SQL queries for different database servers using RESTful HTTP requests to a cloud-based service. It requires an SQL execution context (information about database schema and database server used) to be stored in a registered account at https://webapi.activequerybuilder.com/.

TransformSQL: Transforms the given SQL query according to the instructions provided in this request. You can add conditions for data values, hide some of the result set columns, change sorting or limit rows of the result set. All transformations can only lead to the reorganization or limitation of the result set data. This means that it is impossible to get a query that reveals any other data rather than the data returned by original query.

GetQueryColumns: Returns a list of columns for a given SQL query.

Pagination: limits the number of rows in a transformed query result set while taking the limitations of original query into account (if any). In other words, if the original query contains a row limitation clause, it will be wrapped into a derived table and an additional row limitation clause will be added on top of the main query.

skip: Number of rows to skip from the top of original result set.

take: Number of rows to get from original to new result set.

Totals: If any aggregations are defined in this list, an additional query is returned via the totals result field. In this query, the SELECT list of the original query is replaced with the list of aggregations listed there. This is useful when you want to get totals for the original query’s result set. However, the row limitation instructions aren’t applied to the totals query in order to get totals for the whole dataset, not for the visible page only. This setting doesn’t affect the transformed query returned via the sql field.

field: Column name of the original query to which an aggregate function will be applied.

Sorting: Determines the row order in the transformed query. If there is no sorting, the original query sorting is kept.

field: Column name of the original query by which the transformed query will be sorted.

Condition: Defines a constraint for the original query’s result set values.

field: Column name of the original query to which a constraint will be applied.

values: List of values for a constraint. "IsNull", "IsNotNull" need no values; "Between", "NotBetween" require 2 values; "In" accepts one or more values; other conditions accept a single value only.

ConditionGroup: Group of conditions joined with the same Boolean operator.

conditions: List of conditions.

conditionGroups: List of nested condition groups.

HiddenColumn: Instructs to exclude some columns of the original query from the SELECT list of the transformed query.

field: Name of the column from the original query which will be removed from the transformed query.

SqlQuery: Information about the SQL query and its context.

guid: Unique identifier that defines SQL execution context for the given query.

TransformResult: Returns a transformed SQL text in case of successful transformation. Otherwise, returns an error message.

QueryColumn: Contains information about a particular SQL query column.