Blackbaud RENXT Query (Preview)
Blackbaud Raiser's Edge NXT je komplexní cloudové softwarové řešení pro správu fondů a dárců vytvořené speciálně pro neziskové organizace a celou komunitu, která je vhodná pro sociální sítě. Ke správě a spouštění dotazů použijte konektor dotazů.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Podpora blackbaudu |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Blackbaud. Inc |
| Internetová stránka | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Zásady ochrany osobních údajů | https://www.blackbaud.com/privacy-shield |
| Kategorie | Prodej a CRM; Produktivita |
Raiser's Edge NXT je komplexní cloudové softwarové řešení pro správu fondů a dárců vytvořené speciálně pro neziskové organizace a celou komunitu, která je vhodná pro sociální sítě.
Tento konektor je založený na rozhraní SKY API společnosti Blackbaud a poskytuje operace, které pomáhají spravovat dotazy a související entity nalezené v NXT aplikace Raiser.
Další informace najdete v dokumentaci.
Požadavky
Pokud chcete tento konektor použít, musíte mít účet ID Blackbaud s přístupem k jednomu nebo více prostředím Blackbaud.
Kromě toho musí správce vaší organizace v systému také provést akci na úrovni správce, aby tento konektor umožnil přístup k prostředí Blackbaud. Další informace o těchto požadavcích najdete v počáteční dokumentaci k instalaci .
Jak získat přihlašovací údaje?
Správce vaší organizace vám pošle pozvánku do prostředí Raiser Edge NXT vaší organizace a nakonfiguruje oprávnění k vašemu uživatelskému účtu v rámci prostředí. K použití tohoto konektoru nejsou potřeba žádné další přihlašovací údaje.
Známé problémy a omezení
Konektor bude fungovat v kontextu vašeho uživatelského účtu, a proto bude podléhat vašim uživatelským oprávněním v rámci prostředí.
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Spuštění úlohy ad hoc dotazu |
Spustí úlohu na pozadí, která spustí zadanou definici ad hoc dotazu. |
| Spuštění úlohy dotazu |
Spustí úlohu na pozadí, která spustí zadaný dotaz. |
| Spuštění úlohy statického dotazu aktualizace |
Spustí úlohu na pozadí, která aktualizuje uložené klíče pro zadaný statický dotaz. |
| Výpis dotazů |
Vrátí seznam dotazů. |
| Získání stavu úlohy dotazu |
Vrátí informace o úloze provádění dotazu na pozadí. |
Spuštění úlohy ad hoc dotazu
Spustí úlohu na pozadí, která spustí zadanou definici ad hoc dotazu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Definice dotazu
|
query | True | object |
Reprezentace JSON definice dotazu. |
|
Výstupní formát
|
output_format | string |
Určuje výstupní formát souboru výsledků dotazu. |
|
|
Režim formátování
|
formatting_mode | string |
Určuje, jestli a jak se má formátování použít na výsledky dotazu. |
|
|
Jméno souboru
|
results_file_name | string |
Název souboru, který se má stáhnout, bez přípony souboru. |
Návraty
Spuštěná úloha dotazu
Spuštění úlohy dotazu
Spustí úlohu na pozadí, která spustí zadaný dotaz.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ
|
v_query_type_id | True | integer |
Vyfiltrujte sadu dotazů na ty, které mají konkrétní typ dotazu. |
|
Query
|
id | True | integer |
Dotaz, který se má provést. |
|
Výstupní formát
|
output_format | string |
Určuje výstupní formát souboru výsledků dotazu. |
|
|
Režim formátování
|
formatting_mode | string |
Určuje, jestli a jak se má formátování použít na výsledky dotazu. |
|
|
Režim generování SQL
|
sql_generation_mode | string |
Určuje, jak se mají zpracovávat pole výběru dotazu. Při výběru dotazu bude výstup obsahovat pole výběru definovaná pro dotaz a QRECID. Při výběru možnosti Exportovat bude výstup obsahovat vybraná pole definovaná pouze pro dotaz. Pokud je vybrána možnost Sestava, bude výstup obsahovat POUZE QRECID. |
|
|
Použít statický dotaz?
|
use_static_query_id_set | boolean |
Použijete statický dotaz jako zdroj záznamů (pokud ne, dotaz se spustí dynamicky)? |
|
|
Jméno souboru
|
results_file_name | string |
Název souboru, který se má stáhnout, bez přípony souboru. |
Návraty
Spuštěná úloha dotazu
Spuštění úlohy statického dotazu aktualizace
Spustí úlohu na pozadí, která aktualizuje uložené klíče pro zadaný statický dotaz.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ
|
v_query_type_id | True | integer |
Vyfiltrujte sadu dotazů na ty, které mají konkrétní typ dotazu. |
|
Query
|
id | True | integer |
Dotaz, který se má provést. |
Návraty
Spuštěná úloha dotazu
Výpis dotazů
Vrátí seznam dotazů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ
|
query_type_id | integer |
Vyfiltrujte sadu dotazů na ty, které mají konkrétní typ dotazu. |
|
|
Kategorie
|
category | integer |
Vyfiltrujte sadu dotazů na ty, které mají konkrétní kategorii. |
|
|
Formát
|
query_format | string |
Vyfiltrujte sadu dotazů na dotazy s určitým formátem. |
|
|
Hledat text
|
search_text | string |
Hledaný text pole názvu pro filtrování výsledků. |
|
|
Oblíbené jenom?
|
my_fav_queries_only | boolean |
Zahrnout jenom oblíbené dotazy? |
|
|
Jenom moje dotazy?
|
my_queries_only | boolean |
Zahrnout pouze dotazy, které jsem vytvořil(a)? |
|
|
Pouze sloučené dotazy?
|
merged_queries_only | boolean |
Zahrnout pouze sloučené dotazy? |
|
|
Vyloučit dotazy seznamu?
|
list_queries | string |
Chcete vyloučit dotazy seznamu dotazů? |
|
|
Seřadit sloupec
|
sort_column | string |
Výsledky seřadí podle zadaného sloupce. |
|
|
Seřadit sestupně?
|
sort_descending | boolean |
Seřadit výsledky v sestupném pořadí? |
|
|
Přidáno dne nebo po
|
date_added | date-time |
Vyfiltrujte výsledky na dotazy vytvořené k zadanému datu nebo po tomto datu (např. 2020-09-18T04:13:56Z). |
|
|
Přidáno podle ID
|
added_by | string |
Vyfiltrujte výsledky na dotazy přidané podle zadaného ID uživatele. |
|
|
Omezení
|
limit | integer |
Představuje počet záznamů, které se mají vrátit. Výchozí volba je 50. Maximum je 200. |
|
|
Posun
|
offset | integer |
Představuje počet záznamů, které se mají přeskočit. Pro použití se stránkováním. |
Návraty
Queries
Získání stavu úlohy dotazu
Vrátí informace o úloze provádění dotazu na pozadí.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID úlohy
|
job_id | True | string |
ID systémového záznamu úlohy provádění dotazu. |
|
Zahrnout adresu URL výsledků?
|
include_read_url | string |
Zahrnout adresu URL do souboru výsledků dotazu? |
|
|
Dispozice obsahu
|
content_disposition | string |
Určuje, jak se budou zobrazovat výsledky dotazu. |
Návraty
Úloha provádění dotazů
Definice
QueryApi.ExecuteQueryResponse
Spuštěná úloha dotazu
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID úlohy
|
id | string |
Identifikátor úlohy dotazu. |
|
Stav
|
status | string |
Výsledný stav úlohy dotazu. Čeká se na vyřízení – úloha byla zařazena do fronty, ale ještě nebyla spuštěna. Spuštěno – úloha je spuštěná. Dokončeno – úloha byla úspěšně dokončena. Selhání – úloha se nezdařila. Zrušení – zrušení úlohy bylo požadováno (přesto se může úspěšně dokončit). Zrušeno – úloha byla zrušena. Omezení – úloha byla omezena a spustí se, když je k dispozici místo. |
|
Message
|
message | string |
Zpráva přidružená k odpovědi |
QueryApi.QueryExecutionJob
Úloha provádění dotazů
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID úlohy
|
id | string |
Identifikátor úlohy dotazu. |
|
Stav
|
status | string |
Výsledný stav úlohy dotazu. Čeká se na vyřízení – úloha byla zařazena do fronty, ale ještě nebyla spuštěna. Spuštěno – úloha je spuštěná. Dokončeno – úloha byla úspěšně dokončena. Selhání – úloha se nezdařila. Zrušení – zrušení úlohy bylo požadováno (přesto se může úspěšně dokončit). Zrušeno – úloha byla zrušena. Omezení – úloha byla omezena a spustí se, když je k dispozici místo. |
|
Počet řádků
|
row_count | integer |
Počet záznamů v dotazu. |
|
Identifikátor URI výsledků dotazu
|
sas_uri | string |
Identifikátor URI pro přístup k výsledkům dotazu. Tento identifikátor URI by se měl považovat za zabezpečené přihlašovací údaje pro přístup k výsledkům dotazu – hodnota se považuje za citlivou a identifikátor URI vyprší po 15 minutách. |
QueryApi.QuerySummary
Query
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID systémového záznamu dotazu. |
|
Název
|
name | string |
Jedinečný název dotazu. |
|
Description
|
description | string |
Popis dotazu. |
|
Typ
|
type | string |
Typ dotazu. |
|
ID typu
|
type_id | integer |
ID systémového záznamu typu dotazu. |
|
Kategorie
|
category | string |
Kategorie dotazu. |
|
ID kategorie
|
category_id | integer |
ID systémového záznamu kategorie dotazu. |
|
Formát
|
format | string |
Formát dotazu. |
|
Zobrazit podporované?
|
view_supported | boolean |
Je dotaz zobrazitelný? |
|
Chcete upravit podporované?
|
edit_supported | boolean |
Je dotaz upravitelný? |
|
Je oblíbená?
|
favorite | boolean |
Je dotaz oblíbený? |
|
Máte pole s dotazem?
|
has_ask_fields | boolean |
Obsahuje dotaz pole filtru s operátorem ask? |
|
Vytvořil(a) dotaz?
|
created_by_query | boolean |
Byl dotaz vytvořen v modulu dotazu? |
|
Podporované režimy spouštění
|
supported_execution_modes | string |
Podporované režimy provádění. |
|
Může se změnit?
|
can_modify | boolean |
Může uživatel dotaz upravit? |
|
Je možné provést?
|
can_execute | boolean |
Může uživatel dotaz spustit? |
|
Ostatní můžou upravovat?
|
others_can_modify | boolean |
Můžou dotaz upravovat jiní uživatelé? |
|
Ostatní můžou spouštět?
|
others_can_execute | boolean |
Můžou dotaz spustit jiní uživatelé? |
|
Je seznam dotazů?
|
query_list | boolean |
Je dotaz dotazem na seznam dotazů? |
|
Potlačit duplicity?
|
suppress_duplicates | boolean |
Jsou ve výsledcích dotazu potlačeny duplicity? |
|
Výběr z názvu dotazu
|
select_from_query_name | string |
Název dotazu použitý jako základní výběr dotazu. |
|
Výběr z ID dotazu
|
select_from_query_id | integer |
ID systémového záznamu dotazu použitého jako základní výběr dotazu. |
|
Poslední spuštění
|
date_last_run | date-time |
Datum posledního spuštění dotazu. |
|
Počet záznamů
|
num_records | integer |
Početzáznamůch |
|
Uplynulá doba
|
elapsed_ms | integer |
Uplynulý čas (v milisekundách) při posledním spuštění dotazu. |
|
Datum vytvoření
|
date_added | date-time |
Datum vytvoření dotazu. |
|
Vytvořil(a)
|
added_by | string |
Jméno uživatele, který dotaz vytvořil. |
|
Datum změny
|
date_changed | date-time |
Datum poslední změny dotazu. |
|
Změněno uživatelem
|
last_changed_by | string |
Jméno uživatele, který naposledy změnil dotaz. |
QueryApi.QuerySummaryCollection
Queries
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Sada položek zahrnutých v odpovědi. |