Guides (SDK /API)Technical ReferenceBBDNHow-to Documentation

You are here: REST API for the Advanced Donation Form > Query API

Query API

Endpoints:

Query API - Endpoints

Query/{Id}?Column1Name={ColumnFilter}&Column2Name={ColumnFilter} - GET

Summary: Returns the results for the specified query.

Behavior: 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.

Parameters
Name Type Required Description
Id GUID true Id of a query that has been published.
ColumnFilter String false Filters 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.
Possible Responses
Status Body Description
404 Not Found No published query was found by the specified Id.
200 OK QueryResults Returns a Query object containing results of executing the specified query.

Example Responses:

Name: Success

Status: 200 OK

Body:

                        
	{"Fields":[{"Caption":"ID","Name":"System record ID"},
              {"Caption":"Fund","Name":"Purpose\Public Name"}],
	"Rows":[{Values:["1BB27696-3045-405E-BD74-DC8853506977", "Sample Designation 1"]},
            {Values:["2AE550FB-B3FC-43CE-A07A-B23C45BF1A2E", "Sample Designation 2"]},
            {Values:["2AE550FB-B3FC-43CE-A07A-B23C45BF1A2E", "Sample Designation 3"]}]}