Blackbaud FENXT Query (Vorschau)

Blackbaud Financial Edge NXT ist eine umfassende cloudbasierte Buchhaltungssoftwarelösung, die speziell für gemeinnützige Organisationen entwickelt wurde. Verwenden Sie den Abfrageconnector, um Abfragen zu verwalten und auszuführen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:      – Azure Government-Regionen      - Azure China-Regionen      - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:      - US Government (GCC)      - US Government (GCC High)      - China Cloud betrieben von 21Vianet      - US Department of Defense (DoD)

Kontakt
Name	Blackbaud Support
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Connectormetadaten
Herausgeber	Blackbaud. Inc
Webseite	https://www.blackbaud.com/products/blackbaud-financial-edge-nxt
Datenschutzrichtlinie	https://www.blackbaud.com/privacy-shield
Kategorien	Vertrieb und CRM; Produktivität

Financial Edge NXT ist eine umfassende cloudbasierte Buchhaltungssoftwarelösung, die speziell für gemeinnützige Organisationen entwickelt wurde.

Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Abfragen und verwandten Entitäten in The Financial Edge NXT.

Weitere Informationen finden Sie in der Dokumentation.

Voraussetzungen

Um diesen Connector zu verwenden, müssen Sie über ein Blackbaud ID-Konto mit Zugriff auf eine oder mehrere Blackbaud-Umgebungen verfügen.

Darüber hinaus muss der Administrator Ihrer Organisation auch eine Aktion auf Administratorebene innerhalb des Systems ausführen, damit dieser Connector auf Ihre Blackbaud-Umgebung zugreifen kann. Weitere Informationen zu diesen Voraussetzungen finden Sie in der Ersteinrichtungsdokumentation .

Wie erhalten Sie Anmeldeinformationen?

Der Administrator Ihrer Organisation sendet Ihnen eine Einladung zur Financial Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontenberechtigungen innerhalb der Umgebung. Für die Verwendung dieses Connectors sind keine zusätzlichen Anmeldeinformationen erforderlich.

Bekannte Probleme und Einschränkungen

Der Connector wird im Kontext Ihres Benutzerkontos ausgeführt und unterliegt daher Ihren Benutzerberechtigungen innerhalb der Umgebung.

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abbrechen eines Abfrageausführungsauftrags	Aktualisiert den Status eines Abfrageausführungsauftrags auf den Abbruch.
Abfrageauftragsstatus abrufen	Gibt Informationen zu einem Hintergrundabfrageausführungsauftrag zurück.
Abfragen auflisten (v2)	Gibt eine Liste von Abfragen zurück.
Auflisten von Abfragen	Gibt eine Liste von Abfragen zurück.
Löschen einer Abfrage	Löscht eine Abfrage.
Starten eines Abfrageauftrags	Startet einen Hintergrundauftrag zum Ausführen der angegebenen Abfrage.
Starten eines Ad-hoc-Abfrageauftrags	Startet einen Hintergrundauftrag, um die angegebene Ad-hoc-Abfragedefinition auszuführen.
Starten eines statischen Aktualisierungsabfrageauftrags	Startet einen Hintergrundauftrag, um die gespeicherten Schlüssel für die angegebene statische Abfrage zu aktualisieren.

Abbrechen eines Abfrageausführungsauftrags

Vorgangs-ID:

CancelJob

Aktualisiert den Status eines Abfrageausführungsauftrags auf den Abbruch.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Auftrags-ID	job_id	True	string	Die Systemdatensatz-ID des Abfrageausführungsauftrags, der abgebrochen werden soll.

Gibt zurück

Abfrageauftrag gestartet

Body

QueryApi.ExecuteQueryResponse

Abfrageauftragsstatus abrufen

Vorgangs-ID:

GetQueryJobStatus

Gibt Informationen zu einem Hintergrundabfrageausführungsauftrag zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Auftrags-ID	job_id	True	string	Die Systemdatensatz-ID des Abfrageausführungsauftrags.
Ergebnis-URL einschließen?	include_read_url		string	Fügen Sie die URL zur Abfrageergebnisdatei hinzu?
Löschung von Inhalten	content_disposition		string	Gibt an, wie die Abfrageergebnisse angezeigt werden.

Gibt zurück

Abfrageausführungsauftrag

Body

QueryApi.QueryExecutionJob

Abfragen auflisten (v2)

Vorgangs-ID:

ListQueriesV2

Gibt eine Liste von Abfragen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Typ	query_type_ids		integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Abfragetyp.
Kategorie	category		integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einer bestimmten Kategorie.
Format	query_format		string	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Format.
Ergebnislayout	result_layout		string	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Ergebnislayout.
Suchtext	search_text		string	Der Suchtext des Namensfelds, um die Ergebnisse zu filtern.
Nur Favoriten?	my_fav_queries_only		boolean	Nur Favoritenabfragen einschließen?
Meine Abfragen nur?	my_queries_only		boolean	Nur erstellte Abfragen einschließen?
Nur zusammengeführte Abfragen?	merged_queries_only		boolean	Nur zusammengeführte Abfragen einschließen?
Listenabfragen ausschließen?	list_queries		string	Abfragelistenabfragen ausschließen?
Spalte sortieren	sort_column		string	Sortieren Sie die Ergebnisse nach der angegebenen Spalte.
Absteigend sortieren?	sort_descending		boolean	Sortieren Sie die Ergebnisse in absteigender Reihenfolge?
Hinzugefügt am	date_added		date-time	Filtern Sie die Ergebnisse nach Abfragen, die am angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").
Hinzugefügt nach ID	added_by		string	Filtern Sie die Ergebnisse nach Abfragen, die von der angegebenen Benutzer-ID hinzugefügt wurden.
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 50. Das Maximum beträgt 200.
Fortsetzungstoken	continuation_token		string	Fortsetzungstoken für das Auslagerungsergebnis.

Gibt zurück

Fragen

Body

QueryApi.QuerySummaryV2Collection

Auflisten von Abfragen

Vorgangs-ID:

ListQueries

Gibt eine Liste von Abfragen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Typ	query_type_id		integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Abfragetyp.
Kategorie	category		integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einer bestimmten Kategorie.
Format	query_format		string	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Format.
Suchtext	search_text		string	Der Suchtext des Namensfelds, um die Ergebnisse zu filtern.
Nur Favoriten?	my_fav_queries_only		boolean	Nur Favoritenabfragen einschließen?
Meine Abfragen nur?	my_queries_only		boolean	Nur erstellte Abfragen einschließen?
Nur zusammengeführte Abfragen?	merged_queries_only		boolean	Nur zusammengeführte Abfragen einschließen?
Spalte sortieren	sort_column		string	Sortieren Sie die Ergebnisse nach der angegebenen Spalte.
Hinzugefügt am	date_added		date-time	Filtern Sie die Ergebnisse nach Abfragen, die am angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").
Hinzugefügt nach ID	added_by		string	Filtern Sie die Ergebnisse nach Abfragen, die von der angegebenen Benutzer-ID hinzugefügt wurden.
Absteigend sortieren?	sort_descending		boolean	Sortieren Sie die Ergebnisse in absteigender Reihenfolge?
Limit	limit		integer	Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 50. Das Maximum beträgt 200.
Offset	offset		integer	Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Gibt zurück

Fragen

Body

QueryApi.QuerySummaryCollection

Löschen einer Abfrage

Vorgangs-ID:

DeleteQuery

Löscht eine Abfrage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Abfrage-ID	query_id	True	integer	Die Systemdatensatz-ID der zu löschenden Abfrage.

Starten eines Abfrageauftrags

Vorgangs-ID:

StartQueryExecutionJob

Startet einen Hintergrundauftrag zum Ausführen der angegebenen Abfrage.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Typ	v_query_type_id	True	integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Abfragetyp.
Query	id	True	integer	Die auszuführende Abfrage.
Ausgabeformat	output_format		string	Gibt das Ausgabeformat für die Abfrageergebnisdatei an.
Formatierungsmodus	formatting_mode		string	Gibt an, ob und wie die Formatierung auf die Abfrageergebnisse angewendet werden soll.
SQL-Generierungsmodus	sql_generation_mode		string	Gibt an, wie Abfrageauswahlfelder behandelt werden sollen. Wenn "Abfrage" ausgewählt ist, enthält die Ausgabe die für die Abfrage definierten Auswahlfelder plus QRECID. Wenn "Exportieren" ausgewählt ist, enthält die Ausgabe nur die für die Abfrage definierten Auswahlfelder. Wenn "Bericht" ausgewählt ist, enthält die Ausgabe NUR QRECID.
Statische Abfrage verwenden?	use_static_query_id_set		boolean	Verwenden Sie die statische Abfrage als Quelle von Datensätzen (wenn nicht, wird die Abfrage dynamisch ausgeführt)?
Dateiname	results_file_name		string	Optional - der Name der Datei, die heruntergeladen werden soll, ohne die Dateierweiterung. Wenn nicht angegeben, wird der Dateiname basierend auf dem Abfragenamen generiert.
Zeitzonenoffset	time_zone_offset_in_minutes		integer	Der In Minuten ausgedrückte Zeitzonenoffset.
Verwenden Sie lange Beschreibungen?	display_code_table_long_description		boolean	Codetabelleneinträge nach langer Beschreibung anzeigen (anstelle einer kurzen Beschreibung)?
operator	operator	True	string	Der Filterfeldoperator.
values	filter_values		array of	Werte für den Filter (der Filteroperator bestimmt die erforderliche Anzahl von Werten).

Gibt zurück

Abfrageauftrag gestartet

Body

QueryApi.ExecuteQueryResponse

Starten eines Ad-hoc-Abfrageauftrags

Vorgangs-ID:

StartAdHocQueryExecutionJob

Startet einen Hintergrundauftrag, um die angegebene Ad-hoc-Abfragedefinition auszuführen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Definition der Abfrage	query	True	object	Die JSON-Darstellung der Abfragedefinition.
Ausgabeformat	output_format		string	Gibt das Ausgabeformat für die Abfrageergebnisdatei an.
Formatierungsmodus	formatting_mode		string	Gibt an, ob und wie die Formatierung auf die Abfrageergebnisse angewendet werden soll.
Dateiname	results_file_name		string	Optional - der Name der Datei, die heruntergeladen werden soll, ohne die Dateierweiterung. Wenn nicht angegeben, wird der Dateiname basierend auf dem Abfragenamen generiert.
Zeitzonenoffset	time_zone_offset_in_minutes		integer	Der In Minuten ausgedrückte Zeitzonenoffset.
Verwenden Sie lange Beschreibungen?	display_code_table_long_description		boolean	Codetabelleneinträge nach langer Beschreibung anzeigen (anstelle einer kurzen Beschreibung)?

Gibt zurück

Abfrageauftrag gestartet

Body

QueryApi.ExecuteQueryResponse

Starten eines statischen Aktualisierungsabfrageauftrags

Vorgangs-ID:

StartRefreshStaticQueryExecutionJob

Startet einen Hintergrundauftrag, um die gespeicherten Schlüssel für die angegebene statische Abfrage zu aktualisieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul	module	True	string	Das Financial Edge NXT-Modul für die Anforderung.
Typ	v_query_type_id	True	integer	Filtern Sie den Satz von Abfragen auf diejenigen mit einem bestimmten Abfragetyp.
Query	id	True	integer	Die auszuführende Abfrage.
Zeitzonenoffset	time_zone_offset_in_minutes		integer	Der In Minuten ausgedrückte Zeitzonenoffset.
Verwenden Sie lange Beschreibungen?	display_code_table_long_description		boolean	Codetabelleneinträge nach langer Beschreibung anzeigen (anstelle einer kurzen Beschreibung)?
operator	operator	True	string	Der Filterfeldoperator.
values	filter_values		array of	Werte für den Filter (der Filteroperator bestimmt die erforderliche Anzahl von Werten).

Gibt zurück

Abfrageauftrag gestartet

Body

QueryApi.ExecuteQueryResponse

Definitionen

QueryApi.ExecuteQueryResponse

Abfrageauftrag gestartet

Name	Pfad	Typ	Beschreibung
Auftrags-ID	id	string	Der Abfrageauftragsbezeichner.
Der Status	status	string	Der status des resultierenden Abfrageauftrags. "Ausstehend" – der Auftrag wurde in die Warteschlange eingereiht, aber noch nicht gestartet. "Wird ausgeführt" – der Auftrag wird ausgeführt. "Abgeschlossen" – der Auftrag wurde erfolgreich abgeschlossen. 'Failed' - Der Auftrag ist fehlgeschlagen. "Abbruch" – Auftragsabbruch wurde angefordert (kann aber trotzdem erfolgreich abgeschlossen werden). "Abgebrochen" – der Auftrag wurde abgebrochen. "Gedrosselt" – der Auftrag wurde gedrosselt und wird ausgeführt, wenn Speicherplatz verfügbar ist.
Nachricht	message	string	Eine Nachricht, die der Antwort zugeordnet ist.

QueryApi.QueryExecutionJob

Abfrageausführungsauftrag

Name	Pfad	Typ	Beschreibung
Auftrags-ID	id	string	Der Abfrageauftragsbezeichner.
Der Status	status	string	Der status des resultierenden Abfrageauftrags. "Ausstehend" – der Auftrag wurde in die Warteschlange eingereiht, aber noch nicht gestartet. "Wird ausgeführt" – der Auftrag wird ausgeführt. "Abgeschlossen" – der Auftrag wurde erfolgreich abgeschlossen. 'Failed' - Der Auftrag ist fehlgeschlagen. "Abbruch" – Auftragsabbruch wurde angefordert (kann aber trotzdem erfolgreich abgeschlossen werden). "Abgebrochen" – der Auftrag wurde abgebrochen. "Gedrosselt" – der Auftrag wurde gedrosselt und wird ausgeführt, wenn Speicherplatz verfügbar ist.
Zeilenanzahl	row_count	integer	Die Anzahl der Datensätze in der Abfrage.
Abfrageergebnis-URI	sas_uri	string	Der URI für den Zugriff auf die Abfrageergebnisse. Dieser URI sollte als sichere Anmeldeinformationen für den Zugriff auf die Abfrageergebnisse behandelt werden – der Wert wird als vertraulich betrachtet, und der URI läuft nach 15 Minuten ab.

QueryApi.QuerySummary

Query

Name	Pfad	Typ	Beschreibung
ID	id	integer	Die Systemdatensatz-ID der Abfrage.
Name	name	string	Der eindeutige Name der Abfrage.
Description	description	string	Die Beschreibung der Abfrage.
Typ	type	string	Der Typ der Abfrage.
Typ-ID	type_id	integer	Die Systemdatensatz-ID des Abfragetyps.
Kategorie	category	string	Die Kategorie der Abfrage.
Kategorie-ID	category_id	integer	Die Systemdatensatz-ID der Abfragekategorie.
Format	format	string	Das Abfrageformat.
Ansicht unterstützt?	view_supported	boolean	Kann die Abfrage angezeigt werden?
Unterstützt bearbeiten?	edit_supported	boolean	Ist die Abfrage bearbeitbar?
Ist der Favorit?	favorite	boolean	Ist die Abfrage ein Favorit?
Gibt es Fragenfelder?	has_ask_fields	boolean	Enthält die Abfrage Filterfelder mit dem Ask-Operator?
Erstellt nach Abfrage?	created_by_query	boolean	Wurde die Abfrage innerhalb des Abfragemoduls erstellt?
Unterstützte Ausführungsmodi	supported_execution_modes	string	Die unterstützten Ausführungsmodi.
Kann geändert werden?	can_modify	boolean	Kann der Benutzer die Abfrage ändern?
Kann ausgeführt werden?	can_execute	boolean	Kann der Benutzer die Abfrage ausführen?
Andere können ändern?	others_can_modify	boolean	Können andere Benutzer die Abfrage ändern?
Andere können ausführen?	others_can_execute	boolean	Können andere Benutzer die Abfrage ausführen?
Duplikate unterdrücken?	suppress_duplicates	boolean	Werden Duplikate in den Abfrageergebnissen unterdrückt?
Art	output_limit.type	string	Der Ausgabegrenztyp.
value	output_limit.limit	integer	Die Anzahl oder der Prozent der zu speichernden Zeilen (abhängig vom angegebenen Ausgabegrenzwerttyp).
Ergebnislayout	result_layout	string
Aus Abfragename auswählen	select_from_query_name	string	Der Name der Abfrage, die als Basisauswahl für die Abfrage verwendet wird.
Aus Abfrage-ID auswählen	select_from_query_id	integer	Die Systemdatensatz-ID der Abfrage, die als Basisauswahl für die Abfrage verwendet wird.
Letzte Ausführung	date_last_run	date-time	Das Datum, an dem die Abfrage zuletzt ausgeführt wurde.
Anzahl der Datensätze	num_records	integer	Die Anzahl der Datensätze, die beim letzten Ausführen der Abfrage gefunden wurden.
Verstrichene Zeit	elapsed_ms	integer	Die verstrichene Zeit (in Millisekunden) beim letzten Ausführen der Abfrage.
Erstellungsdatum	date_added	date-time	Das Datum, an dem die Abfrage erstellt wurde.
Erstellt von	added_by	string	Der Name des Benutzers, der die Abfrage erstellt hat.
Datum geändert	date_changed	date-time	Das Datum, an dem die Abfrage zuletzt geändert wurde.
Geändert von	last_changed_by	string	Der Name des Benutzers, der die Abfrage zuletzt geändert hat.

QueryApi.QuerySummaryCollection

Fragen

Name	Pfad	Typ	Beschreibung
queries	queries	array of QueryApi.QuerySummary	Der Satz von Elementen, die in der Antwort enthalten sind.
Gibt es Abfragetypen?	any_query_types	boolean	Hat der Benutzer Zugriff auf Abfragetypen?
Anzahl	count	integer	Die Gesamtanzahl der Elemente in der Auflistung vor dem Grenzwert/Offset.
Limit	limit	integer	Der Grenzwert für die Listenanforderung.
Offset	offset	integer	Der Offset für die Listenanforderung.

QueryApi.QuerySummaryV2Collection

Fragen

Name	Pfad	Typ	Beschreibung
queries	queries	array of QueryApi.QuerySummary	Der Satz von Elementen, die in der Antwort enthalten sind.
Gibt es Abfragetypen?	any_query_types	boolean	Hat der Benutzer Zugriff auf Abfragetypen?
Limit	limit	integer	Der Grenzwert für die Listenanforderung.
Fortsetzungstoken	continuation_token	string	Das Fortsetzungstoken für die Listenanforderung.