BLACKBAUD.api.QueryService Provides methods for retrieving query execution results from the CRM using calls to the BBIS REST services.
new QueryService(options)
| Name | Type | Description |
|---|---|---|
options
|
Object | An object literal containing one or more of the following optional properties:
|
Methods
getResults(queryId, successCallback, failureCallback, filters)
Returns the result of executing the specified, published query. The query is executed as the last user to save the query. The results are cached and may be up to 10 minutes old. The results are limited to 5000 rows.
| Name | Type | Description |
|---|---|---|
queryId
|
String | The Id of a query whose results should be returned. |
successCallback
|
function | The function to call if the request succeeds. The function
will be passed an object with the following properties:
|
failureCallback
|
function | The function to call if the request fails. |
filters
|
Array | An array of the filters to filter the results to rows that contain the
specified value in the specified column. When specifying a column, use the name that is found
in the query response. Depending on the type of column being filtered, the results may filter to rows
that exactly match the specified value instead of those that contain the specified value. Summary
columns such as MAX, MIN, and COUNT cannot be used as filters and will be ignored. The array should
contain objects with the following properties:
|