Blackbaud RENXT Query (wersja zapoznawcza)
Blackbaud Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej dobrej społeczności społecznej. Użyj łącznika zapytań, aby zarządzać zapytaniami i wykonywać je.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate - narzędzie do automatyzacji procesów | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa rozwiązania Blackbaud |
| adres URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadane łącznika | |
|---|---|
| Publisher | Blackbaud. Inc |
| Witryna internetowa | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Zasady ochrony prywatności | https://www.blackbaud.com/privacy-shield |
| Kategorie | Sprzedaż i CRM; Produktywność |
Raiser's Edge NXT to kompleksowe oparte na chmurze rozwiązanie do zbierania funduszy i zarządzania darczyńcami opracowane specjalnie dla organizacji non-profit i całej społeczności dobra społecznego.
Ten łącznik jest oparty na interfejsie API SKY firmy Blackbaud i zapewnia operacje ułatwiające zarządzanie zapytaniami i powiązanymi jednostkami znajdującymi się w narzędziu NXT aplikacji Raiser's Edge.
Aby uzyskać więcej informacji, zapoznaj się z dokumentacją.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz mieć konto identyfikatora Blackbaud z dostępem do co najmniej jednego środowiska Blackbaud.
Ponadto administrator organizacji musi również wykonać akcję na poziomie administratora w systemie, aby umożliwić temu łącznikowi dostęp do środowiska Blackbaud. Więcej informacji na temat tych wymagań wstępnych można znaleźć w dokumentacji początkowej konfiguracji .
Jak uzyskać poświadczenia?
Administrator organizacji wyśle Ci zaproszenie do środowiska NXT aplikacji Raiser's Edge i skonfiguruje uprawnienia konta użytkownika w środowisku. Do korzystania z tego łącznika nie są wymagane żadne dodatkowe poświadczenia.
Znane problemy i ograniczenia
Łącznik będzie działać w kontekście konta użytkownika i w związku z tym będzie podlegać uprawnieniam użytkownika w środowisku.
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Anulowanie zadania wykonywania zapytania |
Aktualizuje stan zadania wykonywania zapytania w celu anulowania. |
| Pobieranie stanu zadania zapytania |
Zwraca informacje o zadaniu wykonywania zapytań w tle. |
| Uruchamianie zadania zapytania |
Uruchamia zadanie w tle w celu wykonania określonego zapytania. |
| Uruchamianie zadania zapytania ad hoc |
Uruchamia zadanie w tle, aby wykonać określoną definicję zapytania ad hoc. |
| Uruchamianie zadania zapytania statycznego odświeżania |
Uruchamia zadanie w tle w celu odświeżenia zapisanych kluczy dla określonego zapytania statycznego. |
| Usuwanie zapytania |
Usuwa zapytanie. |
| Wyświetlanie listy zapytań |
Zwraca listę zapytań. |
| Wyświetlanie listy zapytań (wersja 2) |
Zwraca listę zapytań. |
Anulowanie zadania wykonywania zapytania
Aktualizuje stan zadania wykonywania zapytania w celu anulowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator rekordu systemu zadania wykonywania zapytania do anulowania. |
Zwraca
Rozpoczęte zadanie zapytania
Pobieranie stanu zadania zapytania
Zwraca informacje o zadaniu wykonywania zapytań w tle.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zadania
|
job_id | True | string |
Identyfikator rekordu systemu zadania wykonywania zapytania. |
|
Uwzględnij adres URL wyników?
|
include_read_url | string |
Czy dołączyć adres URL do pliku wyników zapytania? |
|
|
Dyspozycja zawartości
|
content_disposition | string |
Wskazuje sposób wyświetlania wyników zapytania. |
Zwraca
Zadanie wykonywania zapytań
Uruchamianie zadania zapytania
Uruchamia zadanie w tle w celu wykonania określonego zapytania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ
|
v_query_type_id | True | integer |
Filtruj zestaw zapytań do tych z określonym typem zapytania. |
|
Query
|
id | True | integer |
Zapytanie do wykonania. |
|
Format wyjściowy
|
output_format | string |
Wskazuje format danych wyjściowych dla pliku wyników zapytania. |
|
|
Tryb formatowania
|
formatting_mode | string |
Wskazuje, czy formatowanie powinno być stosowane do wyników zapytania. |
|
|
Tryb generowania sql
|
sql_generation_mode | string |
Wskazuje sposób obsługi pól wybierania zapytań. Po wybraniu zapytania dane wyjściowe będą zawierać pola wyboru zdefiniowane dla zapytania oraz identyfikator QRECID. Po wybraniu opcji Eksportuj dane wyjściowe będą zawierać pola wyboru zdefiniowane tylko dla zapytania. Po wybraniu opcji "Raport" dane wyjściowe będą zawierać tylko identyfikator QRECID. |
|
|
Czy używać zapytania statycznego?
|
use_static_query_id_set | boolean |
Użyj zapytania statycznego jako źródła rekordów (jeśli nie, zapytanie zostanie wykonane dynamicznie)? |
|
|
Filename
|
results_file_name | string |
Opcjonalnie — nazwa pliku do pobrania bez rozszerzenia pliku. Jeśli nie zostanie podana, nazwa pliku zostanie wygenerowana na podstawie nazwy zapytania. |
|
|
Przesunięcie strefy czasowej
|
time_zone_offset_in_minutes | integer |
Przesunięcie strefy czasowej wyrażone w minutach. |
|
|
Czy używać długich opisów?
|
display_code_table_long_description | boolean |
Wyświetlać wpisy tabeli kodu według długiego opisu (zamiast krótkiego opisu)? |
|
|
operator
|
operator | True | string |
Operator pola filtru. |
|
values
|
filter_values | array of |
Wartości filtru (operator filtru określa wymaganą liczbę wartości). |
Zwraca
Rozpoczęte zadanie zapytania
Uruchamianie zadania zapytania ad hoc
Uruchamia zadanie w tle, aby wykonać określoną definicję zapytania ad hoc.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Definicja kwerendy
|
query | True | object |
Reprezentacja JSON definicji zapytania. |
|
Format wyjściowy
|
output_format | string |
Wskazuje format danych wyjściowych dla pliku wyników zapytania. |
|
|
Tryb formatowania
|
formatting_mode | string |
Wskazuje, czy formatowanie powinno być stosowane do wyników zapytania. |
|
|
Filename
|
results_file_name | string |
Opcjonalnie — nazwa pliku do pobrania bez rozszerzenia pliku. Jeśli nie zostanie podana, nazwa pliku zostanie wygenerowana na podstawie nazwy zapytania. |
|
|
Przesunięcie strefy czasowej
|
time_zone_offset_in_minutes | integer |
Przesunięcie strefy czasowej wyrażone w minutach. |
|
|
Czy używać długich opisów?
|
display_code_table_long_description | boolean |
Wyświetlać wpisy tabeli kodu według długiego opisu (zamiast krótkiego opisu)? |
Zwraca
Rozpoczęte zadanie zapytania
Uruchamianie zadania zapytania statycznego odświeżania
Uruchamia zadanie w tle w celu odświeżenia zapisanych kluczy dla określonego zapytania statycznego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ
|
v_query_type_id | True | integer |
Filtruj zestaw zapytań do tych z określonym typem zapytania. |
|
Query
|
id | True | integer |
Zapytanie do wykonania. |
|
Przesunięcie strefy czasowej
|
time_zone_offset_in_minutes | integer |
Przesunięcie strefy czasowej wyrażone w minutach. |
|
|
Czy używać długich opisów?
|
display_code_table_long_description | boolean |
Wyświetlać wpisy tabeli kodu według długiego opisu (zamiast krótkiego opisu)? |
|
|
operator
|
operator | True | string |
Operator pola filtru. |
|
values
|
filter_values | array of |
Wartości filtru (operator filtru określa wymaganą liczbę wartości). |
Zwraca
Rozpoczęte zadanie zapytania
Usuwanie zapytania
Usuwa zapytanie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zapytania
|
query_id | True | integer |
Identyfikator rekordu systemu zapytania do usunięcia. |
Wyświetlanie listy zapytań
Zwraca listę zapytań.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ
|
query_type_id | integer |
Filtruj zestaw zapytań do tych z określonym typem zapytania. |
|
|
Kategoria
|
category | integer |
Filtruj zestaw zapytań do tych z określoną kategorią. |
|
|
Format
|
query_format | string |
Filtruj zestaw zapytań do tych z określonym formatem. |
|
|
Tekst wyszukiwania
|
search_text | string |
Tekst wyszukiwania pól nazw w celu filtrowania wyników. |
|
|
Tylko ulubione?
|
my_fav_queries_only | boolean |
Uwzględnij tylko ulubione zapytania? |
|
|
Tylko moje zapytania?
|
my_queries_only | boolean |
Uwzględnij tylko utworzone zapytania? |
|
|
Tylko scalone zapytania?
|
merged_queries_only | boolean |
Czy dołączyć tylko scalone zapytania? |
|
|
Wykluczanie zapytań listy?
|
list_queries | string |
Czy wykluczyć zapytania listy zapytań? |
|
|
Sortowanie kolumny
|
sort_column | string |
Posortuj wyniki według określonej kolumny. |
|
|
Sortuj malejąco?
|
sort_descending | boolean |
Sortuj wyniki w kolejności malejącej? |
|
|
Dodano polecenie
|
date_added | date-time |
Przefiltruj wyniki do zapytań utworzonych w określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Dodano według identyfikatora
|
added_by | string |
Filtruj wyniki do zapytań dodanych przez określony identyfikator użytkownika. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Ustawieniem domyślnym jest 50. Maksymalna wartość to 200. |
|
|
Przesunięcie
|
offset | integer |
Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony. |
Zwraca
Queries
Wyświetlanie listy zapytań (wersja 2)
Zwraca listę zapytań.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ
|
query_type_ids | integer |
Filtruj zestaw zapytań do tych z określonym typem zapytania. |
|
|
Kategoria
|
category | integer |
Filtruj zestaw zapytań do tych z określoną kategorią. |
|
|
Format
|
query_format | string |
Filtruj zestaw zapytań do tych z określonym formatem. |
|
|
Układ wyników
|
result_layout | string |
Filtruj zestaw zapytań do tych z określonym układem wyników. |
|
|
Tekst wyszukiwania
|
search_text | string |
Tekst wyszukiwania pól nazw w celu filtrowania wyników. |
|
|
Tylko ulubione?
|
my_fav_queries_only | boolean |
Uwzględnij tylko ulubione zapytania? |
|
|
Tylko moje zapytania?
|
my_queries_only | boolean |
Uwzględnij tylko utworzone zapytania? |
|
|
Tylko scalone zapytania?
|
merged_queries_only | boolean |
Czy dołączyć tylko scalone zapytania? |
|
|
Wykluczanie zapytań listy?
|
list_queries | string |
Czy wykluczyć zapytania listy zapytań? |
|
|
Sortowanie kolumny
|
sort_column | string |
Posortuj wyniki według określonej kolumny. |
|
|
Sortuj malejąco?
|
sort_descending | boolean |
Sortuj wyniki w kolejności malejącej? |
|
|
Dodano polecenie
|
date_added | date-time |
Przefiltruj wyniki do zapytań utworzonych w określonej dacie (np. "2020-09-18T04:13:56Z"). |
|
|
Dodano według identyfikatora
|
added_by | string |
Filtruj wyniki do zapytań dodanych przez określony identyfikator użytkownika. |
|
|
Ograniczenie
|
limit | integer |
Reprezentuje liczbę rekordów do zwrócenia. Ustawieniem domyślnym jest 50. Maksymalna wartość to 200. |
|
|
Token kontynuacji
|
continuation_token | string |
Token kontynuacji do stronicowania za pośrednictwem wyników. |
Zwraca
Queries
Definicje
QueryApi.ExecuteQueryResponse
Rozpoczęte zadanie zapytania
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zadania
|
id | string |
Identyfikator zadania zapytania. |
|
Status
|
status | string |
Wynikowy stan zadania zapytania. "Oczekujące" — zadanie zostało jeszcze uruchomione w kolejce, ale nie zostało jeszcze uruchomione. "Uruchomiono" — zadanie jest uruchomione. "Ukończono" — zadanie zostało ukończone pomyślnie. "Niepowodzenie" — zadanie nie powiodło się. "Anulowanie" — zażądano anulowania zadania (ale nadal może zostać ukończone pomyślnie). "Anulowano" — zadanie zostało anulowane. "Throttled" — zadanie zostało ograniczone i zostanie uruchomione po udostępnieniu miejsca. |
|
Message
|
message | string |
Komunikat skojarzony z odpowiedzią. |
QueryApi.QueryExecutionJob
Zadanie wykonywania zapytań
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator zadania
|
id | string |
Identyfikator zadania zapytania. |
|
Status
|
status | string |
Wynikowy stan zadania zapytania. "Oczekujące" — zadanie zostało jeszcze uruchomione w kolejce, ale nie zostało jeszcze uruchomione. "Uruchomiono" — zadanie jest uruchomione. "Ukończono" — zadanie zostało ukończone pomyślnie. "Niepowodzenie" — zadanie nie powiodło się. "Anulowanie" — zażądano anulowania zadania (ale nadal może zostać ukończone pomyślnie). "Anulowano" — zadanie zostało anulowane. "Throttled" — zadanie zostało ograniczone i zostanie uruchomione po udostępnieniu miejsca. |
|
Liczba wierszy
|
row_count | integer |
Liczba rekordów w zapytaniu. |
|
Identyfikator URI wyników zapytania
|
sas_uri | string |
Identyfikator URI umożliwiający uzyskiwanie dostępu do wyników zapytania. Ten identyfikator URI powinien być traktowany jako bezpieczne poświadczenie w celu uzyskania dostępu do wyników zapytania — wartość jest uznawana za wrażliwą, a identyfikator URI wygaśnie po 15 minutach. |
QueryApi.QuerySummary
Query
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | integer |
Identyfikator rekordu systemu zapytania. |
|
Name
|
name | string |
Unikatowa nazwa zapytania. |
|
Description
|
description | string |
Opis zapytania. |
|
Typ
|
type | string |
Typ zapytania. |
|
Identyfikator typu
|
type_id | integer |
Identyfikator rekordu systemowego typu zapytania. |
|
Kategoria
|
category | string |
Kategoria zapytania. |
|
Identyfikator kategorii
|
category_id | integer |
Identyfikator rekordu systemu kategorii zapytania. |
|
Format
|
format | string |
Format zapytania. |
|
Czy wyświetlić obsługiwane?
|
view_supported | boolean |
Czy zapytanie jest widoczne? |
|
Edytować obsługiwane?
|
edit_supported | boolean |
Czy zapytanie jest edytowalne? |
|
Czy jest ulubiony?
|
favorite | boolean |
Czy zapytanie jest ulubione? |
|
Czy ma pola zapytań?
|
has_ask_fields | boolean |
Czy zapytanie zawiera pola filtru z operatorem ask? |
|
Utworzone przez zapytanie?
|
created_by_query | boolean |
Czy zapytanie zostało utworzone w module zapytania? |
|
Obsługiwane tryby wykonywania
|
supported_execution_modes | string |
Obsługiwane tryby wykonywania. |
|
Czy można modyfikować?
|
can_modify | boolean |
Czy użytkownik może zmodyfikować zapytanie? |
|
Czy można wykonać?
|
can_execute | boolean |
Czy użytkownik może wykonać zapytanie? |
|
Inni mogą modyfikować?
|
others_can_modify | boolean |
Czy inni użytkownicy mogą modyfikować zapytanie? |
|
Inne osoby mogą wykonywać?
|
others_can_execute | boolean |
Czy inni użytkownicy mogą wykonać zapytanie? |
|
Czy lista zapytań jest listą?
|
query_list | boolean |
Czy zapytanie jest zapytaniem listy zapytań? |
|
Pomijać duplikaty?
|
suppress_duplicates | boolean |
Czy duplikaty są pomijane w wynikach zapytania? |
|
typ
|
output_limit.type | string |
Typ limitu danych wyjściowych. |
|
value
|
output_limit.limit | integer |
Liczba lub procent wierszy do zapisania (w zależności od określonego typu limitu danych wyjściowych). |
|
Uwzględnij nieaktywne składniki?
|
constituent_filters.include_inactive | boolean |
Uwzględnij nieaktywne składniki w przetwarzaniu zapytań? |
|
Uwzględnij zmarłych składników?
|
constituent_filters.include_deceased | boolean |
Uwzględnij zmarłe składniki w przetwarzaniu zapytań? |
|
Nie uwzględniaj prawidłowych adresów?
|
constituent_filters.include_no_valid_addresses | boolean |
Uwzględnij składniki bez prawidłowych adresów w przetwarzaniu zapytań? |
|
Układ wyników
|
result_layout | string | |
|
Wybierz z nazwy zapytania
|
select_from_query_name | string |
Nazwa zapytania używanego jako wybór podstawowy dla zapytania. |
|
Wybierz z identyfikatora zapytania
|
select_from_query_id | integer |
Identyfikator rekordu systemu zapytania używanego jako podstawowy wybór zapytania. |
|
Ostatni przebieg
|
date_last_run | date-time |
Data ostatniego uruchomienia zapytania. |
|
Liczba rekordów
|
num_records | integer |
Liczba rekordów znalezionych podczas ostatniego uruchomienia zapytania. |
|
Czas
|
elapsed_ms | integer |
Czas, który upłynął (w milisekundach) podczas ostatniego uruchomienia zapytania. |
|
Data utworzenia
|
date_added | date-time |
Data utworzenia zapytania. |
|
Utworzone przez
|
added_by | string |
Nazwa użytkownika, który utworzył zapytanie. |
|
Data zmiany
|
date_changed | date-time |
Data ostatniej zmiany zapytania. |
|
Zmienione przez
|
last_changed_by | string |
Nazwa użytkownika, który ostatnio zmienił zapytanie. |
QueryApi.QuerySummaryCollection
Queries
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Zestaw elementów uwzględnionych w odpowiedzi. |
|
Jakieś typy zapytań?
|
any_query_types | boolean |
Czy użytkownik ma dostęp do jakichkolwiek typów zapytań? |
|
Liczba
|
count | integer |
Całkowita liczba elementów w kolekcji przed limitem/przesunięciem. |
|
Ograniczenie
|
limit | integer |
Limit żądania listy. |
|
Przesunięcie
|
offset | integer |
Przesunięcie żądania listy. |
QueryApi.QuerySummaryV2Collection
Queries
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Zestaw elementów uwzględnionych w odpowiedzi. |
|
Jakieś typy zapytań?
|
any_query_types | boolean |
Czy użytkownik ma dostęp do jakichkolwiek typów zapytań? |
|
Ograniczenie
|
limit | integer |
Limit żądania listy. |
|
Token kontynuacji
|
continuation_token | string |
Token kontynuacji żądania listy. |