Blackbaud RENXT Query (Preview)
Blackbaud Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community. Use the Query connector to manage and execute queries.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Blackbaud Support |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Connector Metadata | |
|---|---|
| Publisher | Blackbaud. Inc |
| Website | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Privacy policy | https://www.blackbaud.com/privacy-shield |
| Categories | Sales and CRM;Productivity |
Raiser's Edge NXT is a comprehensive cloud-based fundraising and donor management software solution built specifically for nonprofits and the entire social good community.
This connector is built on top of Blackbaud's SKY API, and provides operations to help manage queries and related entities found within The Raiser's Edge NXT.
For more information, please view the documentation.
Prerequisites
To use this connector, you must have a Blackbaud ID account with access to one or more Blackbaud environments.
In addition, your organization's administrator must also perform an admin-level action within the system to enable this connector to access your Blackbaud environment. More information about these prerequisites can be found in the initial setup documentation.
How to get credentials?
Your organization's administrator will send you an invitation to the organization's Raiser's Edge NXT environment and configure your user account permissions within the environment. No additional credentials are required to use this connector.
Known issues and limitations
The connector will operate in the context of your user account, and will therefore be subject to your user permissions within the environment.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get query job status |
Returns information about a background query execution job. |
| List queries |
Returns a list of queries. |
| Start a query job |
Starts a background job to execute the specified query. |
| Start an ad hoc query job |
Starts a background job to execute the specified ad hoc query definition. |
Get query job status
Returns information about a background query execution job.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Job ID
|
job_id | True | string |
The system record ID of the query execution job. |
|
Include results URL?
|
include_read_url | string |
Include the URL to the query results file? |
|
|
Content disposition
|
content_disposition | string |
Indicates how the query results will be viewed. |
Returns
Query execution job
List queries
Returns a list of queries.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Type
|
query_type_id | integer |
Filter the set of queries to those with a specific query type. |
|
|
Category
|
category | integer |
Filter the set of queries to those with a specific category. |
|
|
Format
|
query_format | string |
Filter the set of queries to those with a specific format. |
|
|
Search text
|
search_text | string |
The name field search text to filter the results. |
|
|
My queries only?
|
my_queries_only | boolean |
Include only queries I created? |
|
|
Merged queries only?
|
merged_queries_only | boolean |
Include only merged queries? |
|
|
Exclude list queries?
|
list_queries | string |
Exclude Query List queries? |
|
|
Sort column
|
sort_column | string |
Sort the results by the specified column. |
|
|
Sort descending?
|
sort_descending | boolean |
Sort the results in descending order? |
|
|
Limit
|
limit | integer |
Represents the number of records to return. The default is 50. The maximum is 500. |
|
|
Offset
|
offset | integer |
Represents the number of records to skip. For use with pagination. |
Returns
Queries
Start a query job
Starts a background job to execute the specified query.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Type
|
v_query_type_id | True | integer |
Filter the set of queries to those with a specific query type. |
|
Query
|
id | True | integer |
The query to execute. |
|
Formatting mode
|
formatting_mode | string |
Indicates whether and how formatting should be applied to the query results. |
|
|
SQL generation mode
|
sql_generation_mode | string |
Indicates how query select fields should be handled. When 'Query' is selected, the output will include the select fields defined for the query plus QRECID. When 'Export' is selected, the output will include the select fields defined for the query ONLY. When 'Report' is selected, the output will ONLY include QRECID. |
|
|
Use static query?
|
use_static_query_id_set | boolean |
Use the static query as the source of records? |
Returns
Started query job
Start an ad hoc query job
Starts a background job to execute the specified ad hoc query definition.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Query definition
|
query | True | object |
The JSON representation of the query definition. |
|
Formatting mode
|
formatting_mode | string |
Indicates whether and how formatting should be applied to the query results. |
Returns
Started query job
Definitions
QueryApi.ExecuteQueryResponse
Started query job
| Name | Path | Type | Description |
|---|---|---|---|
|
Job ID
|
id | string |
The query job identifier. |
|
Status
|
status | string |
The resulting query job status. 'Pending' - the job has been queued but has not yet started running. 'Running' - the job is running. 'Completed' - the job completed successfully. 'Failed' - the job failed. 'Cancelling' - job cancellation has been requested (but may still complete successfully). 'Cancelled' - the job was canceled. 'Throttled' - the job has been throttled and will run when space is available. |
|
Message
|
message | string |
A message associated with the response. |
QueryApi.QueryExecutionJob
Query execution job
| Name | Path | Type | Description |
|---|---|---|---|
|
Job ID
|
id | string |
The query job identifier. |
|
Status
|
status | string |
The resulting query job status. 'Pending' - the job has been queued but has not yet started running. 'Running' - the job is running. 'Completed' - the job completed successfully. 'Failed' - the job failed. 'Cancelling' - job cancellation has been requested (but may still complete successfully). 'Cancelled' - the job was canceled. 'Throttled' - the job has been throttled and will run when space is available. |
|
Query results URI
|
sas_uri | string |
The URI for accessing the query results. This URI should be treated as a secure credential to access the query results - the value is considered sensitive, and the URI will expire after 15 minutes. |
QueryApi.QuerySummary
Query
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
The system record ID of the query. |
|
Name
|
name | string |
The unique name of the query. |
|
Description
|
description | string |
The description of the query. |
|
Type
|
type | string |
The type of the query. |
|
Type ID
|
type_id | integer |
The system record ID of the query type. |
|
Category
|
category | string |
The category of the query. |
|
Category ID
|
category_id | integer |
The system record ID of the query category. |
|
Format
|
format | string |
The query format. |
|
View supported?
|
view_supported | boolean |
Is the query viewable? |
|
Supported execution modes
|
supported_execution_modes | string |
The supported execution modes. |
|
Can modify?
|
can_modify | boolean |
Can the user modify the query? |
|
Can execute?
|
can_execute | boolean |
Can the user execute the query? |
|
Others can modify?
|
others_can_modify | boolean |
Can other users modify the query? |
|
Others can execute?
|
others_can_execute | boolean |
Can other users execute the query? |
|
Is a query list?
|
query_list | boolean |
Is the query a Query List query? |
|
Suppress duplicates?
|
suppress_duplicates | boolean |
Are duplicates suppressed in the query results? |
|
Select from query name
|
select_from_query_name | string |
The name of the query used as the base select for the query. |
|
Select from query ID
|
select_from_query_id | integer |
The system record ID of the query used as the base select for the query. |
|
Last run
|
date_last_run | date-time |
The date when the query was last run. |
|
Number of records
|
num_records | integer |
The number of records found the last time the query was run. |
|
Elapsed time
|
elapsed_ms | integer |
The elapsed time (in milliseconds) the last time the query was run. |
|
Date created
|
date_added | date-time |
The date when the query was created. |
|
Created by
|
added_by | string |
The name of the user that created the query. |
|
Date changed
|
date_changed | date-time |
The date when the query was last changed. |
|
Changed by
|
last_changed_by | string |
The name of the user that last changed the query. |
QueryApi.QuerySummaryCollection
Queries
| Name | Path | Type | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
The set of items included in the response. |