Query

From API Documentation

Jump to: navigation, search

Use query to request information from an object.

Contents

Limitations

Please be aware of the following limitations:

  • All keywords need to be lower case.
  • The number of records returned is limited:
    • 100 records for WSDL v5 and earlier.
    • 2000 records for WSDL v6 and later.

Syntax and Argument

QueryResult=query(queryString)

The argument is as shown in the following table. For information on the field types, see Field Types.

Argument Description
queryString A string specifying the object to query, the fields to return from that object, and any conditions (filters) for including or excluding a specific object in the query.

Using This Call

This call sends a query expression specifying the object to query, the fields to retrieve from that object, and any filters for determining whether a given object should be queried. Zuora has a SQL-like query language you can use to construct those queries, passing them through the queryString.

Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information.

Response

QueryResult

Faults

InvalidQueryLocatorFault

MalformedQueryFault

UnexpectedErrorFault

Sample Code

For information about constructing queries, see Zuora Object Query Language.

See Also