Child pages
  • Admin API Method doQuery

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function will query the database, aggregating and grouping results if relevant.
Style
Document
Input (Literal)
The input of this method is the argument doQuery of type doQuery having the structure defined by the following table.

Element

Type

Occurs

Description

query

query

0..1

The parameters of the query

Output (Literal)
The output of this method is the argument doQueryResponse of type doQueryResponse having the structure defined by the following table.

Element

Type

Occurs

Description

queryResult

queryResult

0..1

The result of the query

Remarks
Queries may only be made on a particular resource type; resource type for this purposes includes pseudo-resources such as unit transactions, unit transaction summaries, products, and product purchases. The call takes a Query object which specifies the query to be made, and returns a QueryResult object. See the documentation for the Query and QueryResult objects for more details.
On successful execution, a QueryResult will be returned. On an exception, no QueryResult is returned.

  • No labels