Query Blackbaud RENXT (anteprima)

Blackbaud Raiser Edge NXT è una soluzione software completa di raccolta fondi e gestione dei donatori basata sul cloud creata appositamente per organizzazioni no profit e l'intera comunità sociale. Usare Il connettore query per gestire ed eseguire query.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti:      - Aree di Azure per enti pubblici      - Aree di Azure Cina      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree di Power Apps , ad eccezione dei seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti:      - Governo degli Stati Uniti (GCC)      - Us Government (GCC High)      - China Cloud gestito da 21Vianet      - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Supporto blackbaud
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Metadati del connettore
Editore	Blackbaud. Inc
Sito web	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Informativa sulla privacy	https://www.blackbaud.com/privacy-shield
Categorie	Vendite e CRM; Produttività

Edge NXT di Raiser è una soluzione software completa di raccolta fondi e gestione dei donatori basata sul cloud creata appositamente per organizzazioni no profit e l'intera comunità sociale.

Questo connettore si basa sull'API SKY di Blackbaud e fornisce operazioni per gestire le query e le entità correlate disponibili nell'NXT edge di The Raiser.

Per altre informazioni, vedere la documentazione.

Prerequisiti

Per usare questo connettore, è necessario disporre di un account Blackbaud ID con accesso a uno o più ambienti Blackbaud.

Inoltre, l'amministratore dell'organizzazione deve eseguire un'azione a livello di amministratore all'interno del sistema per consentire a questo connettore di accedere all'ambiente Blackbaud. Altre informazioni su questi prerequisiti sono disponibili nella documentazione di configurazione iniziale .

Come ottenere le credenziali?

L'amministratore dell'organizzazione invierà un invito all'ambiente NXT edge dell'organizzazione e configurerà le autorizzazioni dell'account utente all'interno dell'ambiente. Per usare questo connettore non sono necessarie credenziali aggiuntive.

Problemi noti e limitazioni

Il connettore funzionerà nel contesto dell'account utente e sarà quindi soggetto alle autorizzazioni utente all'interno dell'ambiente.

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Avviare un processo di query	Avvia un processo in background per eseguire la query specificata.
Avviare un processo di query ad hoc	Avvia un processo in background per eseguire la definizione di query ad hoc specificata.
Avviare un processo di query statica di aggiornamento	Avvia un processo in background per aggiornare le chiavi salvate per la query statica specificata.
Elencare le query	Restituisce un elenco di query.
Ottenere lo stato del processo di query	Restituisce informazioni su un processo di esecuzione di query in background.

Avviare un processo di query

ID operazione:

StartQueryExecutionJob

Avvia un processo in background per eseguire la query specificata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
TIPO	v_query_type_id	True	integer	Filtrare il set di query in base a quelli con un tipo di query specifico.
Query	id	True	integer	Query da eseguire.
Formato di output	output_format		string	Indica il formato di output per il file dei risultati della query.
Modalità di formattazione	formatting_mode		string	Indica se e come applicare la formattazione ai risultati della query.
Modalità di generazione SQL	sql_generation_mode		string	Indica la modalità di gestione dei campi di selezione delle query. Quando si seleziona 'Query', l'output includerà i campi di selezione definiti per la query più QRECID. Quando l'opzione 'Export' è selezionata, l'output includerà i campi di selezione definiti solo per la query. Quando l'opzione 'Report' è selezionata, l'output includerà SOLO QRECID.
Usare una query statica?	use_static_query_id_set		boolean	Usare la query statica come origine dei record (in caso contrario, la query verrà eseguita in modo dinamico)?
Filename	results_file_name		string	Nome del file da scaricare, senza l'estensione del file.

Restituisce

Processo di query avviato

Corpo

QueryApi.ExecuteQueryResponse

Avviare un processo di query ad hoc

ID operazione:

StartAdHocQueryExecutionJob

Avvia un processo in background per eseguire la definizione di query ad hoc specificata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Definizione di query	query	True	object	Rappresentazione JSON della definizione della query.
Formato di output	output_format		string	Indica il formato di output per il file dei risultati della query.
Modalità di formattazione	formatting_mode		string	Indica se e come applicare la formattazione ai risultati della query.
Filename	results_file_name		string	Nome del file da scaricare, senza l'estensione del file.

Restituisce

Processo di query avviato

Corpo

QueryApi.ExecuteQueryResponse

Avviare un processo di query statica di aggiornamento

ID operazione:

StartRefreshStaticQueryExecutionJob

Avvia un processo in background per aggiornare le chiavi salvate per la query statica specificata.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
TIPO	v_query_type_id	True	integer	Filtrare il set di query in base a quelli con un tipo di query specifico.
Query	id	True	integer	Query da eseguire.

Restituisce

Processo di query avviato

Corpo

QueryApi.ExecuteQueryResponse

Elencare le query

ID operazione:

ListQueries

Restituisce un elenco di query.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
TIPO	query_type_id		integer	Filtrare il set di query in base a quelli con un tipo di query specifico.
Categoria	category		integer	Filtrare il set di query in base a quelli con una categoria specifica.
Formato	query_format		string	Filtrare il set di query in base a quelli con un formato specifico.
Cerca testo	search_text		string	Testo di ricerca del campo del nome per filtrare i risultati.
Solo Preferiti?	my_fav_queries_only		boolean	Includere solo le query preferite?
Solo le mie query?	my_queries_only		boolean	Includere solo le query create?
Solo query unite?	merged_queries_only		boolean	Includere solo query unite?
Escludere le query di elenco?	list_queries		string	Escludere le query dell'elenco di query?
Ordina colonna	sort_column		string	Ordinare i risultati in base alla colonna specificata.
Ordinamento decrescente?	sort_descending		boolean	Ordinare i risultati in ordine decrescente?
Aggiunta in o dopo	date_added		date-time	Filtrare i risultati in modo che le query create alla data specificata (ad esempio: '2020-09-18T04:13:56Z').
Aggiunta in base all'ID	added_by		string	Filtrare i risultati per visualizzare le query aggiunte dall'ID utente specificato.
Limite	limit		integer	Rappresenta il numero di record da restituire. L'impostazione predefinita è 50. Il valore massimo è 200.
Offset	offset		integer	Rappresenta il numero di record da ignorare. Per l'uso con la paginazione.

Restituisce

Queries

Corpo

QueryApi.QuerySummaryCollection

Ottenere lo stato del processo di query

ID operazione:

GetQueryJobStatus

Restituisce informazioni su un processo di esecuzione di query in background.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID lavoro	job_id	True	string	ID del record di sistema del processo di esecuzione della query.
Includere l'URL dei risultati?	include_read_url		string	Includere l'URL nel file dei risultati della query?
Eliminazione del contenuto	content_disposition		string	Indica come verranno visualizzati i risultati della query.

Restituisce

Processo di esecuzione delle query

Corpo

QueryApi.QueryExecutionJob

Definizioni

QueryApi.ExecuteQueryResponse

Processo di query avviato

Nome	Percorso	Tipo	Descrizione
ID lavoro	id	string	Identificatore del processo di query.
stato	status	string	Stato del processo di query risultante. 'In sospeso': il processo è stato accodato ma non è ancora stato avviato. 'Running': il processo è in esecuzione. 'Completed': il processo è stato completato correttamente. 'Failed': il processo non è riuscito. 'Annullamento': l'annullamento del processo è stato richiesto (ma potrebbe comunque essere completato correttamente). 'Cancelled': il processo è stato annullato. 'Throttled': il processo è stato limitato e verrà eseguito quando lo spazio è disponibile.
Message	message	string	Messaggio associato alla risposta.

QueryApi.QueryExecutionJob

Processo di esecuzione delle query

Nome	Percorso	Tipo	Descrizione
ID lavoro	id	string	Identificatore del processo di query.
stato	status	string	Stato del processo di query risultante. 'In sospeso': il processo è stato accodato ma non è ancora stato avviato. 'Running': il processo è in esecuzione. 'Completed': il processo è stato completato correttamente. 'Failed': il processo non è riuscito. 'Annullamento': l'annullamento del processo è stato richiesto (ma potrebbe comunque essere completato correttamente). 'Cancelled': il processo è stato annullato. 'Throttled': il processo è stato limitato e verrà eseguito quando lo spazio è disponibile.
Numero di righe	row_count	integer	Numero di record nella query.
URI dei risultati della query	sas_uri	string	URI per l'accesso ai risultati della query. Questo URI deve essere considerato come una credenziale sicura per accedere ai risultati della query. Il valore viene considerato sensibile e l'URI scadrà dopo 15 minuti.

QueryApi.QuerySummary

Query

Nome	Percorso	Tipo	Descrizione
Documento d'identità	id	integer	ID del record di sistema della query.
Nome	name	string	Nome univoco della query.
Description	description	string	Descrizione della query.
TIPO	type	string	Tipo della query.
ID tipo	type_id	integer	ID del record di sistema del tipo di query.
Categoria	category	string	Categoria della query.
ID della categoria	category_id	integer	ID del record di sistema della categoria di query.
Formato	format	string	Formato della query.
Visualizza supportato?	view_supported	boolean	La query è visualizzabile?
Modifica supportata?	edit_supported	boolean	La query è modificabile?
È preferito?	favorite	boolean	La query è un preferito?
Ha chiesto campi?	has_ask_fields	boolean	La query include campi filtro con l'operatore ask?
Creato dalla query?	created_by_query	boolean	La query è stata creata all'interno del modulo di query?
Modalità di esecuzione supportate	supported_execution_modes	string	Modalità di esecuzione supportate.
Può modificare?	can_modify	boolean	L'utente può modificare la query?
Può essere eseguita?	can_execute	boolean	L'utente può eseguire la query?
Altri utenti possono modificare?	others_can_modify	boolean	Altri utenti possono modificare la query?
Altri possono essere eseguiti?	others_can_execute	boolean	Gli altri utenti possono eseguire la query?
È un elenco di query?	query_list	boolean	La query è una query dell'elenco di query?
Eliminare i duplicati?	suppress_duplicates	boolean	I duplicati vengono eliminati nei risultati della query?
Selezionare un nome di query	select_from_query_name	string	Nome della query utilizzata come selezione di base per la query.
Selezionare un ID query	select_from_query_id	integer	ID del record di sistema della query utilizzata come selezione di base per la query.
Ultima esecuzione	date_last_run	date-time	Data dell'ultima esecuzione della query.
Numero di record	num_records	integer	Numero di record trovati l'ultima volta che è stata eseguita la query.
Tempo trascorso	elapsed_ms	integer	Tempo trascorso (in millisecondi) dell'ultima esecuzione della query.
Data di creazione	date_added	date-time	Data di creazione della query.
Creato da	added_by	string	Nome dell'utente che ha creato la query.
Data modificata	date_changed	date-time	Data dell'ultima modifica della query.
Modificato da	last_changed_by	string	Nome dell'utente che ha modificato l'ultima query.

QueryApi.QuerySummaryCollection

Queries

Nome	Percorso	Tipo	Descrizione
queries	queries	array of QueryApi.QuerySummary	Set di elementi inclusi nella risposta.