ExecuteCQL

You can execute CQL directly without creating a Saved Query using the following endpoint.

post
ExecuteCQL

https://<Cinchy Web URL>/API/ExecuteCQL
Request
Response
Request
Headers
Authorization
required
string
Bearer <access_token> See Authentication for details.
Query Parameters
ResultFormat
required
string
XML JSON CSV TSV PSV PROTOBUF
Type
required
string
QUERY - Query (Approved Data Only) DRAFT_QUERY - Query (Include Draft Changes) SCALAR - Scalar NONQUERY - Non Query, such as an insert or delete VERSION_HISTORY_QUERY - Query (Include Version History)
ConnectionId
optional
string
TransactionId
optional
string
When one or more requests share the same TransactionId, they are considered to be within the scope of a single transaction.
Query
required
string
The CQL query statement to execute
Parameters
optional
string
See below on format for the parameters.
SchemaOnly
optional
boolean
Defaults to false.
StartRow
optional
integer
When implementing pagination, specify a starting offset. Combine with RowCount to set the size of the data window.
RowCount
optional
integer
When implementing pagination, specify the number of rows to retrieve for the current page. Combine with StartRow to set the paging position.
CommandTimeout
optional
integer
Use this parameter to override the default timeout (30s) for long running queries. In seconds.
UserId
optional
string
Response
200: OK

Parameters

To pass in parameters in your executeCQL, you will need to pass in sets of parameters in the following format. So if you have one parameter then you would pass in 3 query parameters beginning with Parameters[0]. , and if you have a second parameter you would include an additional 3 query parameters beginning with Parameters[1]. .

Query String Parameter Name

Content

Parameters[n].ParameterName

Name of the parameter that is in your query, including the '@'.

Ex. @name

Parameters[n].XmlSerializedValue

XML Serialized version of the value of that parameter.

Ex. &quot;test&quot;

Parameters[n].ValueType

Datatype of the value.

Ex. System.String