Udostępnij przez

Interakcje NXT programu Blackbaud Raisers Edge

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 Interakcje, aby zarządzać akcjami składowymi.

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 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
Email 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 składnikami międzyoperacyjnościami i powiązanymi jednostkami w programie The Raiser's Edge NXT, w tym:

  • Czynności
  • Pola niestandardowe akcji
  • Załączniki akcji
  • i nie tylko...

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

Akcje listy

Zwraca listę akcji.
Aktualizowanie akcji składowej

Aktualizuje akcję składową.
Aktualizowanie pola niestandardowego akcji

Aktualizuje pole niestandardowe akcji.
Aktualizowanie załącznika akcji

Aktualizuje załącznik akcji.
Lista załączników akcji

Wyświetla listę załączników dla akcji.
Pobieranie akcji składowej

Zwraca informacje o akcji składowej.
Pola niestandardowe akcji listy

Wyświetla listę pól niestandardowych dla akcji.
Tworzenie akcji składowej

Tworzy nową akcję składową.
Tworzenie pola niestandardowego akcji

Tworzy nowe pole niestandardowe akcji.
Tworzenie załącznika akcji

Tworzy nowy załącznik akcji.
Wyświetlanie listy akcji składowych

Wyświetla listę akcji dla składnika.

Akcje listy

Identyfikator operacji:
ListActions

Zwraca listę akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
List
 list_id string

Definiuje identyfikator listy używany do filtrowania zestawu akcji do tych uwzględnionych na określonej liście. Jeśli ta wartość zostanie ustawiona, inne określone filtry zostaną zignorowane.
Stan obliczony
 computed_status string

Reprezentuje filtr wyników na podstawie stanu obliczonej akcji. Dostępne wartości to Open, Completed lub PastDue.
Status
 status_code string

Reprezentuje kod stanu akcji do filtrowania wyników (dotyczy tylko wtedy, gdy system jest skonfigurowany do używania kodów stanu akcji). Na przykład "Oczekujące" zwraca akcje ze stanem "Oczekiwanie".
Ograniczenie
 limit integer

Reprezentuje liczbę rekordów do zwrócenia. Wartość domyślna to 500. Wartość maksymalna to 5000.
Przesunięcie
 offset integer

Reprezentuje liczbę rekordów do pominięcia. Do użycia z podziałem na strony.
Dodano polecenie lub po
 date_added date-time

Przefiltruj wyniki do akcji utworzonych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z").
Zmodyfikowano w dniu lub po
 last_modified date-time

Przefiltruj wyniki do akcji zmodyfikowanych w określonym dniu lub po określonej dacie (np. "2020-09-18T04:13:56Z").

Zwraca

Czynności

Body
ConstituentApi.ApiCollectionOfActionRead

Aktualizowanie akcji składowej

Identyfikator operacji:
EditAction

Aktualizuje akcję składową.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator akcji
 action_id True string

Identyfikator rekordu systemu akcji do zaktualizowania.
Date
 date date-time

Data akcji (np. "2020-09-18T04:13:56Z").
Kategoria
 category string

Kanał lub intencja interakcji składowej.
Typ
 type string

Dodatkowy opis akcji w celu uzupełnienia kategorii.
Podsumowanie
 summary string

Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255.
Uwaga / Notatka
 description string

Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji.
Zakończone?
 completed boolean

Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji.
Ukończono
 completed_date date-time

Data zakończenia akcji (np. "2020-09-18T04:13:56Z").
Status
 status string

Stan akcji.
Direction
 direction string

Kierunek akcji.
Lokalizacja
 location string

Lokalizacja akcji.
Identyfikator szansy sprzedaży
 opportunity_id string

Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją.
Outcome
 outcome string

Wynik akcji.
Priority
 priority string

Priorytet akcji.
Godzina rozpoczęcia
 start_time string

Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Godzina zakończenia
 end_time string

Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Fundraiser(s)
 fundraisers array of string

Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją.

Aktualizowanie pola niestandardowego akcji

Identyfikator operacji:
EditActionCustomField

Aktualizuje pole niestandardowe akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator pola niestandardowego
 custom_field_id True string

Identyfikator rekordu systemowego pola niestandardowego do zaktualizowania.
body
 body True dynamic

Obiekt reprezentujący właściwości pola niestandardowego do zaktualizowania.

Aktualizowanie załącznika akcji

Identyfikator operacji:
EditActionAttachment

Aktualizuje załącznik akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator załącznika
 attachment_id True string

Identyfikator rekordu systemu załącznika do aktualizacji.
Name
 name string

Nazwa załącznika. Limit znaków: 150.
Date
 date date-time

Data załącznika (np. "2020-09-18T04:13:56Z").
adres URL
 url string

Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych.
Etykiety
 tags array of string

Tagi skojarzone z załącznikiem.

Lista załączników akcji

Identyfikator operacji:
ListActionAttachments

Wyświetla listę załączników dla akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator akcji
 action_id True string

Identyfikator rekordu systemu akcji.

Zwraca

Załączniki

Body
ConstituentApi.ApiCollectionOfActionAttachmentRead

Pobieranie akcji składowej

Identyfikator operacji:
GetAction

Zwraca informacje o akcji składowej.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator akcji
 action_id True string

Identyfikator rekordu systemu akcji do pobrania.

Zwraca

Akcja

Body
ConstituentApi.ActionRead

Pola niestandardowe akcji listy

Identyfikator operacji:
ListActionCustomFields

Wyświetla listę pól niestandardowych dla akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator akcji
 action_id True string

Identyfikator rekordu systemu akcji.

Zwraca

Pola niestandardowe

Body
ConstituentApi.ApiCollectionOfActionCustomFieldRead

Tworzenie akcji składowej

Identyfikator operacji:
CreateAction

Tworzy nową akcję składową.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator składowy
 constituent_id True string

Identyfikator rekordu systemu składnika skojarzonego z akcją.
Date
 date True date-time

Data akcji (np. "2020-09-18T04:13:56Z").
Kategoria
 category True string

Kanał lub intencja interakcji składowej.
Typ
 type string

Dodatkowy opis akcji w celu uzupełnienia kategorii.
Podsumowanie
 summary string

Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255.
Uwaga / Notatka
 description string

Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji.
Zakończone?
 completed boolean

Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji.
Ukończono
 completed_date date-time

Data zakończenia akcji (np. "2020-09-18T04:13:56Z").
Status
 status string

Stan akcji.
Direction
 direction string

Kierunek akcji.
Lokalizacja
 location string

Lokalizacja akcji.
Identyfikator szansy sprzedaży
 opportunity_id string

Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją.
Outcome
 outcome string

Wynik akcji.
Priority
 priority string

Priorytet akcji.
Godzina rozpoczęcia
 start_time string

Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Godzina zakończenia
 end_time string

Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Author
 author string

Autor podsumowania i opisu akcji. Jeśli nie zostanie podany, zostanie ustawiony domyślny zestaw na podstawie konta użytkownika. Limit znaków: 50.
Fundraiser(s)
 fundraisers array of string

Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją.

Zwraca

Utworzona akcja

Body
ConstituentApi.CreatedAction

Tworzenie pola niestandardowego akcji

Identyfikator operacji:
CreateActionCustomField

Tworzy nowe pole niestandardowe akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
body
 body True dynamic

Obiekt reprezentujący pole niestandardowe do utworzenia.

Zwraca

Pole niestandardowe utworzonej akcji

Body
ConstituentApi.CreatedActionCustomField

Tworzenie załącznika akcji

Identyfikator operacji:
CreateActionAttachment

Tworzy nowy załącznik akcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator akcji
 parent_id True string

Identyfikator rekordu systemu akcji skojarzonej z załącznikiem.
Typ
 type True string

Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie.
Name
 name string

Nazwa załącznika. Limit znaków: 150.
Date
 date date-time

Data załącznika (np. "2020-09-18T04:13:56Z"). To pole domyślnie jest domyślnie ustawiona na bieżącą datę i godzinę, jeśli nie zostanie podana.
adres URL
 url string

Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych.
Nazwa pliku
 file_name string

Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Identyfikator pliku
 file_id string

Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Identyfikator miniatury
 thumbnail_id string

Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Etykiety
 tags array of string

Tagi skojarzone z załącznikiem.

Zwraca

Utworzony załącznik akcji

Body
ConstituentApi.CreatedActionAttachment

Wyświetlanie listy akcji składowych

Identyfikator operacji:
ListConstituentActions

Wyświetla listę akcji dla składnika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator składowy
 constituent_id True string

Identyfikator rekordu systemu składnika.

Zwraca

Czynności

Body
ConstituentApi.ApiCollectionOfActionRead

Definicje

SkładnikApi.ActionAttachmentRead

Attachment

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator rekordu systemu załącznika.
Identyfikator akcji
 parent_id string

Identyfikator rekordu systemu akcji skojarzonej z załącznikiem.
Typ
 type string

Typ załącznika. Fizyczne załączniki są przekazywane, takie jak obrazy, pliki PDF lub dokumenty programu Word zapisywane lokalnie lub w sieci. Są one przechowywane i zarządzane w systemie. Załączniki linków to linki do plików, takich jak obrazy, wpisy w blogu lub filmy wideo w serwisie YouTube, które są w trybie online lub na koncie magazynu w chmurze. Są one przechowywane i zarządzane zewnętrznie.
Name
 name string

Nazwa załącznika. Limit znaków: 150.
Date
 date date-time

Data załącznika.
adres URL
 url string

Adres URL załącznika. Jest to wymagane w przypadku załączników linków i nie dotyczy załączników fizycznych.
Nazwa pliku
 file_name string

Nazwa pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Identyfikator pliku
 file_id string

Identyfikator pliku. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Identyfikator miniatury
 thumbnail_id string

Identyfikator miniatury. Limit znaków: 36. Tylko w przypadku załączników fizycznych.
Adres URL miniatury
 thumbnail_url string

Adres URL miniatury. W przypadku załączników fizycznych, które są tylko obrazami. Zawiera sygnaturę związaną z czasem, która ogranicza dostęp do 60 minut.
Typ zawartości
 content_type string

Typ zawartości. Tylko w przypadku załączników fizycznych.
Rozmiar pliku
 file_size integer

Rozmiar pliku w bajtach. Tylko w przypadku załączników fizycznych.
Etykiety
 tags array of string

Tagi skojarzone z załącznikiem.

ConstituentApi.ActionCustomFieldRead

Pole niestandardowe

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator rekordu systemowego pola niestandardowego.
Identyfikator akcji
 parent_id string

Identyfikator rekordu systemu akcji skojarzonej z polem niestandardowym.
Kategoria
 category string

Kategoria pola niestandardowego.
Typ
 type string

Typ danych reprezentowanych przez pole niestandardowe.
Wartość
 value

Wartość pola niestandardowego.
Wartość tekstowa
 text_value string

Wartość tekstowa pola niestandardowego.
Wartość liczbowa
 number_value integer

Wartość liczbowa pola niestandardowego.
Wartość daty
 date_value date

Wartość daty pola niestandardowego.
Wartość waluty
 currency_value double

Wartość waluty pola niestandardowego.
Wartość logiczna
 boolean_value boolean

Wartość logiczna pola niestandardowego.
Wartość wpisu tabeli
 codetableentry_value string

Wartość wpisu tabeli pola niestandardowego.
Wartość identyfikatora składnika
 constituentid_value string

Wartość identyfikatora składowego pola niestandardowego.
day
 fuzzydate_value.d integer

Dzień w dacie rozmytej.
miesiąca
 fuzzydate_value.m integer

Miesiąc w dacie rozmytej.
rok
 fuzzydate_value.y integer

Rok w dacie rozmytej.
Date
 date date

Data w polu niestandardowym.
Comment
 comment string

Komentarz do pola niestandardowego. Limit znaków: 50.
Data dodania
 date_added date-time

Data utworzenia pola niestandardowego.
Data modyfikacji
 date_modified date-time

Data ostatniej modyfikacji pola niestandardowego.

SkładnikApi.ActionRead

Akcja

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator rekordu systemu akcji.
Identyfikator składowy
 constituent_id string

Identyfikator rekordu systemu składnika skojarzonego z akcją.
Kategoria
 category string

Kanał lub intencja interakcji składowej.
Zakończone?
 completed boolean

Czy akcja została ukończona? Jeśli system jest skonfigurowany do używania niestandardowych stanów akcji, ta wartość jest oparta na wartości stanu akcji.
Ukończono
 completed_date date-time

Data zakończenia akcji.
Date
 date date-time

Data akcji.
Uwaga / Notatka
 description string

Szczegółowe wyjaśnienie, które zawiera podsumowanie akcji.
Direction
 direction string

Kierunek akcji.
Fundraiser(s)
 fundraisers array of string

Zestaw identyfikatorów rekordów systemowych dla fundraisers skojarzonych z akcją.
Lokalizacja
 location string

Lokalizacja akcji.
Identyfikator szansy sprzedaży
 opportunity_id string

Identyfikator rekordu systemu szansy sprzedaży skojarzonej z akcją.
Outcome
 outcome string

Wynik akcji.
Priority
 priority string

Priorytet akcji.
Godzina rozpoczęcia
 start_time string

Godzina rozpoczęcia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Godzina zakończenia
 end_time string

Godzina zakończenia akcji. Używa 24-godzinnego czasu w formacie HH:mm.
Status
 status string

Stan akcji.
Kod stanu
 status_code string

Kod stanu akcji. Ta właściwość jest zwracana tylko wtedy, gdy system jest skonfigurowany do używania niestandardowych stanów akcji.
Stan obliczony
 computed_status string

Stan obliczonej akcji. Jeśli system nie jest skonfigurowany do używania niestandardowych stanów akcji, to pole oblicza stan na podstawie właściwości ukończonych i daty. Jeśli nie, pole oblicza stan na podstawie właściwości date akcji i czy właściwość Stan akcji jest skonfigurowana jako ukończona.
Podsumowanie
 summary string

Krótki opis akcji, która jest wyświetlana w górnej części rekordu. Limit znaków: 255.
Typ
 type string

Dodatkowy opis akcji w celu uzupełnienia kategorii.
Data dodania
 date_added date-time

Data utworzenia akcji.
Data modyfikacji
 date_modified date-time

Data ostatniej modyfikacji akcji.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Załączniki

Nazwa Ścieżka Typ Opis
Liczba
 count integer

Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości.
value
 value array of ConstituentApi.ActionAttachmentRead

Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Pola niestandardowe

Nazwa Ścieżka Typ Opis
Liczba
 count integer

Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości.
value
 value array of ConstituentApi.ActionCustomFieldRead

Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji.

ConstituentApi.ApiCollectionOfActionRead

Czynności

Nazwa Ścieżka Typ Opis
Liczba
 count integer

Liczba elementów dostępnych do pobrania do kolekcji po zastosowaniu dowolnych parametrów żądania. Parametry limitu i przesunięcia nie mają wpływu na liczbę, ale aby ułatwić stronicowanie, mogą mieć wpływ na liczbę elementów w zestawie wyników wartości.
value
 value array of ConstituentApi.ActionRead

Zestaw elementów uwzględnionych w odpowiedzi. Może to być podzbiór elementów w kolekcji.

SkładnikApi.CreatedAction

Utworzona akcja

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator nowo utworzonej akcji.

SkładnikApi.CreatedActionAttachment

Utworzony załącznik akcji

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator nowo utworzonego załącznika akcji.

ConstituentApi.CreatedActionCustomField

Pole niestandardowe utworzonej akcji

Nazwa Ścieżka Typ Opis
identyfikator
 id string

Identyfikator nowo utworzonego pola niestandardowego akcji.