Blackbaud FENXT-query (preview)
Blackbaud Financial Edge NXT is een uitgebreide cloudgebaseerde boekhoudsoftwareoplossing die speciaal is gebouwd voor non-profitorganisaties. Gebruik de queryconnector om query's te beheren en uit te voeren.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Ondersteuning voor Blackbaud |
| URL | https://www.blackbaud.com/support |
| E-mailen | skyapi@blackbaud.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Blackbaud. Inc |
| Webpagina | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| Privacybeleid | https://www.blackbaud.com/privacy-shield |
| Categorieën | Verkoop en CRM; Productiviteit |
Financial Edge NXT is een uitgebreide cloudoplossing voor boekhoudsoftware die speciaal is gebouwd voor non-profitorganisaties.
Deze connector is gebouwd op de SKY-API van Blackbaud en biedt bewerkingen voor het beheren van query's en gerelateerde entiteiten die zijn gevonden in The Financial Edge NXT.
Raadpleeg de documentatie voor meer informatie.
Vereiste voorwaarden
Als u deze connector wilt gebruiken, moet u een Blackbaud ID-account hebben met toegang tot een of meer Blackbaud-omgevingen.
Daarnaast moet de beheerder van uw organisatie ook een actie op beheerdersniveau uitvoeren binnen het systeem om deze connector toegang te geven tot uw Blackbaud-omgeving. Meer informatie over deze vereisten vindt u in de eerste installatiedocumentatie .
Hoe kan ik referenties ophalen?
De beheerder van uw organisatie stuurt u een uitnodiging naar de Financial Edge NXT-omgeving van de organisatie en configureert uw gebruikersaccountmachtigingen in de omgeving. Er zijn geen aanvullende referenties vereist voor het gebruik van deze connector.
Bekende problemen en beperkingen
De connector werkt in de context van uw gebruikersaccount en is daarom onderhevig aan uw gebruikersmachtigingen binnen de omgeving.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Een ad-hocquerytaak starten |
Hiermee start u een achtergrondtaak om de opgegeven ad-hocquerydefinitie uit te voeren. |
| Een query verwijderen |
Hiermee verwijdert u een query. |
| Een querytaak starten |
Hiermee start u een achtergrondtaak om de opgegeven query uit te voeren. |
| Een queryuitvoeringstaak annuleren |
Hiermee wordt de status van een queryuitvoeringstaak bijgewerkt om te annuleren. |
| Een statische querytaak vernieuwen |
Hiermee start u een achtergrondtaak om de opgeslagen sleutels voor de opgegeven statische query te vernieuwen. |
| Query's weergeven |
Retourneert een lijst met query's. |
| Query's weergeven (v2) |
Retourneert een lijst met query's. |
| Status van querytaak ophalen |
Retourneert informatie over een taak voor het uitvoeren van een achtergrondquery. |
Een ad-hocquerytaak starten
Hiermee start u een achtergrondtaak om de opgegeven ad-hocquerydefinitie uit te voeren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Querydefinitie
|
query | True | object |
De JSON-weergave van de querydefinitie. |
|
Uitvoerindeling
|
output_format | string |
Geeft de uitvoerindeling voor het queryresultatenbestand aan. |
|
|
Opmaakmodus
|
formatting_mode | string |
Geeft aan of en hoe opmaak moet worden toegepast op de queryresultaten. |
|
|
Bestandsnaam
|
results_file_name | string |
Optioneel: de naam van het bestand dat moet worden gedownload, zonder de bestandsextensie. Als deze niet is opgegeven, wordt de bestandsnaam gegenereerd op basis van de querynaam. |
|
|
Tijdzoneverschil
|
time_zone_offset_in_minutes | integer |
De tijdzone-offset uitgedrukt in minuten. |
|
|
Lange beschrijvingen gebruiken?
|
display_code_table_long_description | boolean |
Codetabelvermeldingen weergeven op lange beschrijving (in plaats van korte beschrijving)? |
Retouren
Querytaak gestart
Een query verwijderen
Hiermee verwijdert u een query.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Query-id
|
query_id | True | integer |
De systeemrecord-id van de query die moet worden verwijderd. |
Een querytaak starten
Hiermee start u een achtergrondtaak om de opgegeven query uit te voeren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Typologie
|
v_query_type_id | True | integer |
Filter de set query's op query's met een specifiek querytype. |
|
Query
|
id | True | integer |
De query die moet worden uitgevoerd. |
|
Uitvoerindeling
|
output_format | string |
Geeft de uitvoerindeling voor het queryresultatenbestand aan. |
|
|
Opmaakmodus
|
formatting_mode | string |
Geeft aan of en hoe opmaak moet worden toegepast op de queryresultaten. |
|
|
SQL-generatiemodus
|
sql_generation_mode | string |
Hiermee wordt aangegeven hoe velden voor het selecteren van query's moeten worden verwerkt. Wanneer Query is geselecteerd, bevat de uitvoer de geselecteerde velden die zijn gedefinieerd voor de query plus QRECID. Wanneer Exporteren is geselecteerd, bevat de uitvoer de selectievelden die alleen voor de query zijn gedefinieerd. Wanneer Rapport is geselecteerd, bevat de uitvoer ALLEEN QRECID. |
|
|
Statische query gebruiken?
|
use_static_query_id_set | boolean |
Gebruikt u de statische query als bron van records (zo niet, wordt de query dynamisch uitgevoerd)? |
|
|
Bestandsnaam
|
results_file_name | string |
Optioneel: de naam van het bestand dat moet worden gedownload, zonder de bestandsextensie. Als deze niet is opgegeven, wordt de bestandsnaam gegenereerd op basis van de querynaam. |
|
|
Tijdzoneverschil
|
time_zone_offset_in_minutes | integer |
De tijdzone-offset uitgedrukt in minuten. |
|
|
Lange beschrijvingen gebruiken?
|
display_code_table_long_description | boolean |
Codetabelvermeldingen weergeven op lange beschrijving (in plaats van korte beschrijving)? |
|
|
operator
|
operator | True | string |
De filterveldoperator. |
|
values
|
filter_values | array of |
Waarden voor het filter (de filteroperator bepaalt het vereiste aantal waarden). |
Retouren
Querytaak gestart
Een queryuitvoeringstaak annuleren
Hiermee wordt de status van een queryuitvoeringstaak bijgewerkt om te annuleren.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Functie-ID
|
job_id | True | string |
De systeemrecord-id van de queryuitvoeringstaak die moet worden geannuleerd. |
Retouren
Querytaak gestart
Een statische querytaak vernieuwen
Hiermee start u een achtergrondtaak om de opgeslagen sleutels voor de opgegeven statische query te vernieuwen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Typologie
|
v_query_type_id | True | integer |
Filter de set query's op query's met een specifiek querytype. |
|
Query
|
id | True | integer |
De query die moet worden uitgevoerd. |
|
Tijdzoneverschil
|
time_zone_offset_in_minutes | integer |
De tijdzone-offset uitgedrukt in minuten. |
|
|
Lange beschrijvingen gebruiken?
|
display_code_table_long_description | boolean |
Codetabelvermeldingen weergeven op lange beschrijving (in plaats van korte beschrijving)? |
|
|
operator
|
operator | True | string |
De filterveldoperator. |
|
values
|
filter_values | array of |
Waarden voor het filter (de filteroperator bepaalt het vereiste aantal waarden). |
Retouren
Querytaak gestart
Query's weergeven
Retourneert een lijst met query's.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Typologie
|
query_type_id | integer |
Filter de set query's op query's met een specifiek querytype. |
|
|
Categorie
|
category | integer |
Filter de set query's op query's met een specifieke categorie. |
|
|
Formaat
|
query_format | string |
Filter de set query's op query's met een specifieke indeling. |
|
|
Zoektekst
|
search_text | string |
De zoektekst van het naamveld om de resultaten te filteren. |
|
|
Alleen favorieten?
|
my_fav_queries_only | boolean |
Alleen favoriete query's opnemen? |
|
|
Alleen mijn query's?
|
my_queries_only | boolean |
Alleen query's opnemen die ik heb gemaakt? |
|
|
Alleen samengevoegde query's?
|
merged_queries_only | boolean |
Alleen samengevoegde query's opnemen? |
|
|
Kolom sorteren
|
sort_column | string |
Sorteer de resultaten op de opgegeven kolom. |
|
|
Toegevoegd aan
|
date_added | date-time |
Filter de resultaten op query's die zijn gemaakt op de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z'). |
|
|
Toegevoegd door id
|
added_by | string |
Filter de resultaten op query's die zijn toegevoegd door de opgegeven gebruikers-id. |
|
|
Aflopend sorteren?
|
sort_descending | boolean |
Sorteer de resultaten in aflopende volgorde? |
|
|
Limit
|
limit | integer |
Geeft het aantal records weer dat moet worden geretourneerd. De standaard is 50. Het maximum is 200. |
|
|
Offset
|
offset | integer |
Geeft het aantal records aan dat moet worden overgeslagen. Voor gebruik met paginering. |
Retouren
Queries
Query's weergeven (v2)
Retourneert een lijst met query's.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Typologie
|
query_type_ids | integer |
Filter de set query's op query's met een specifiek querytype. |
|
|
Categorie
|
category | integer |
Filter de set query's op query's met een specifieke categorie. |
|
|
Formaat
|
query_format | string |
Filter de set query's op query's met een specifieke indeling. |
|
|
Resultaatindeling
|
result_layout | string |
Filter de set query's op query's met een specifieke resultaatindeling. |
|
|
Zoektekst
|
search_text | string |
De zoektekst van het naamveld om de resultaten te filteren. |
|
|
Alleen favorieten?
|
my_fav_queries_only | boolean |
Alleen favoriete query's opnemen? |
|
|
Alleen mijn query's?
|
my_queries_only | boolean |
Alleen query's opnemen die ik heb gemaakt? |
|
|
Alleen samengevoegde query's?
|
merged_queries_only | boolean |
Alleen samengevoegde query's opnemen? |
|
|
Lijstquery's uitsluiten?
|
list_queries | string |
Querylijstquery's uitsluiten? |
|
|
Kolom sorteren
|
sort_column | string |
Sorteer de resultaten op de opgegeven kolom. |
|
|
Aflopend sorteren?
|
sort_descending | boolean |
Sorteer de resultaten in aflopende volgorde? |
|
|
Toegevoegd aan
|
date_added | date-time |
Filter de resultaten op query's die zijn gemaakt op de opgegeven datum (bijvoorbeeld: '2020-09-18T04:13:56Z'). |
|
|
Toegevoegd door id
|
added_by | string |
Filter de resultaten op query's die zijn toegevoegd door de opgegeven gebruikers-id. |
|
|
Limit
|
limit | integer |
Geeft het aantal records weer dat moet worden geretourneerd. De standaard is 50. Het maximum is 200. |
|
|
Vervolgtoken
|
continuation_token | string |
Vervolgtoken voor paging via resultaten. |
Retouren
Queries
Status van querytaak ophalen
Retourneert informatie over een taak voor het uitvoeren van een achtergrondquery.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
De Financial Edge NXT-module voor de aanvraag. |
|
Functie-ID
|
job_id | True | string |
De systeemrecord-id van de queryuitvoeringstaak. |
|
Resultaten-URL opnemen?
|
include_read_url | string |
De URL naar het queryresultatenbestand opnemen? |
|
|
Verwijdering van inhoud
|
content_disposition | string |
Geeft aan hoe de queryresultaten worden weergegeven. |
Retouren
Queryuitvoeringstaak
Definities
QueryApi.ExecuteQueryResponse
Querytaak gestart
| Name | Pad | Type | Description |
|---|---|---|---|
|
Functie-ID
|
id | string |
De id van de querytaak. |
|
Toestand
|
status | string |
De resulterende status van de querytaak. 'In behandeling': de taak is in de wachtrij geplaatst, maar is nog niet gestart. 'Wordt uitgevoerd': de taak wordt uitgevoerd. Voltooid: de taak is voltooid. 'Mislukt': de taak is mislukt. 'Annuleren' - annulering van de taak is aangevraagd (maar kan nog steeds met succes worden voltooid). 'Geannuleerd': de taak is geannuleerd. 'Beperkt': de taak is beperkt en wordt uitgevoerd wanneer er ruimte beschikbaar is. |
|
Message
|
message | string |
Een bericht dat is gekoppeld aan het antwoord. |
QueryApi.QueryExecutionJob
Queryuitvoeringstaak
| Name | Pad | Type | Description |
|---|---|---|---|
|
Functie-ID
|
id | string |
De id van de querytaak. |
|
Toestand
|
status | string |
De resulterende status van de querytaak. 'In behandeling': de taak is in de wachtrij geplaatst, maar is nog niet gestart. 'Wordt uitgevoerd': de taak wordt uitgevoerd. Voltooid: de taak is voltooid. 'Mislukt': de taak is mislukt. 'Annuleren' - annulering van de taak is aangevraagd (maar kan nog steeds met succes worden voltooid). 'Geannuleerd': de taak is geannuleerd. 'Beperkt': de taak is beperkt en wordt uitgevoerd wanneer er ruimte beschikbaar is. |
|
Aantal rijen
|
row_count | integer |
Het aantal records in de query. |
|
Queryresultaten-URI
|
sas_uri | string |
De URI voor toegang tot de queryresultaten. Deze URI moet worden behandeld als een veilige referentie voor toegang tot de queryresultaten. De waarde wordt beschouwd als gevoelig en de URI verloopt na 15 minuten. |
QueryApi.QuerySummary
Query
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | integer |
De systeemrecord-id van de query. |
|
Naam
|
name | string |
De unieke naam van de query. |
|
Description
|
description | string |
De beschrijving van de query. |
|
Typologie
|
type | string |
Het type query. |
|
Type-id
|
type_id | integer |
De systeemrecord-id van het querytype. |
|
Categorie
|
category | string |
De categorie van de query. |
|
Categorie-ID
|
category_id | integer |
De systeemrecord-id van de querycategorie. |
|
Formaat
|
format | string |
De queryindeling. |
|
Ondersteunde weergave?
|
view_supported | boolean |
Kan de query worden weergegeven? |
|
Ondersteund bewerken?
|
edit_supported | boolean |
Kan de query worden bewerkt? |
|
Is favoriet?
|
favorite | boolean |
Is de query een favoriet? |
|
Heeft u vraagvelden?
|
has_ask_fields | boolean |
Bevat de query filtervelden met de vraagoperator? |
|
Gemaakt door query?
|
created_by_query | boolean |
Is de query gemaakt in de querymodule? |
|
Ondersteunde uitvoeringsmodi
|
supported_execution_modes | string |
De ondersteunde uitvoeringsmodi. |
|
Kan dit worden gewijzigd?
|
can_modify | boolean |
Kan de gebruiker de query wijzigen? |
|
Kan dit worden uitgevoerd?
|
can_execute | boolean |
Kan de gebruiker de query uitvoeren? |
|
Kunnen anderen wijzigen?
|
others_can_modify | boolean |
Kunnen andere gebruikers de query wijzigen? |
|
Kunnen anderen uitvoeren?
|
others_can_execute | boolean |
Kunnen andere gebruikers de query uitvoeren? |
|
Duplicaten onderdrukken?
|
suppress_duplicates | boolean |
Worden duplicaten onderdrukt in de queryresultaten? |
|
type
|
output_limit.type | string |
Het type uitvoerlimiet. |
|
value
|
output_limit.limit | integer |
Het aantal of het percentage rijen dat moet worden opgeslagen (afhankelijk van het opgegeven type uitvoerlimiet). |
|
Resultaatindeling
|
result_layout | string | |
|
Selecteren uit querynaam
|
select_from_query_name | string |
De naam van de query die wordt gebruikt als basisselectie voor de query. |
|
Selecteren uit query-id
|
select_from_query_id | integer |
De systeemrecord-id van de query die wordt gebruikt als basisselectie voor de query. |
|
Laatste uitvoering
|
date_last_run | date-time |
De datum waarop de query voor het laatst is uitgevoerd. |
|
Aantal records
|
num_records | integer |
Het aantal records dat is gevonden toen de query de laatste keer werd uitgevoerd. |
|
Verstreken tijd
|
elapsed_ms | integer |
De verstreken tijd (in milliseconden) de laatste keer dat de query werd uitgevoerd. |
|
Gemaakt op
|
date_added | date-time |
De datum waarop de query is gemaakt. |
|
Gemaakt door
|
added_by | string |
De naam van de gebruiker die de query heeft gemaakt. |
|
Datum gewijzigd
|
date_changed | date-time |
De datum waarop de query voor het laatst is gewijzigd. |
|
Gewijzigd door
|
last_changed_by | string |
De naam van de gebruiker die de query het laatst heeft gewijzigd. |
QueryApi.QuerySummaryCollection
Queries
| Name | Pad | Type | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
De set items die zijn opgenomen in het antwoord. |
|
Zijn er querytypen?
|
any_query_types | boolean |
Heeft de gebruiker toegang tot querytypen? |
|
Aantal
|
count | integer |
Het totale aantal items in de verzameling vóór limiet/offset. |
|
Limit
|
limit | integer |
De limiet voor de lijstaanvraag. |
|
Offset
|
offset | integer |
De offset op de lijstaanvraag. |
QueryApi.QuerySummaryV2Collection
Queries
| Name | Pad | Type | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
De set items die zijn opgenomen in het antwoord. |
|
Zijn er querytypen?
|
any_query_types | boolean |
Heeft de gebruiker toegang tot querytypen? |
|
Limit
|
limit | integer |
De limiet voor de lijstaanvraag. |
|
Vervolgtoken
|
continuation_token | string |
Het vervolgtoken voor de lijstaanvraag. |