Freigeben über


Blackbaud Raisers Edge NXT-Interaktionen

Blackbaud Raiser es Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde. Verwenden Sie den Interaktionsconnector, um konstituierende Aktionen zu verwalten.

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-raisers-edge-nxt
Datenschutzrichtlinie https://www.blackbaud.com/privacy-shield
Kategorien Vertrieb und CRM; Produktivität

Raisers Edge NXT ist eine umfassende cloudbasierte Spenden- und Spendermanagement-Softwarelösung, die speziell für gemeinnützige Organisationen und die gesamte soziale Gute Community entwickelt wurde.

Dieser Connector basiert auf der SKY-API von Blackbaud und bietet Vorgänge zur Verwaltung von Komponenteninteraktionen und verwandten Entitäten innerhalb von The Raiser's Edge NXT, darunter:

  • Aktionen
  • Benutzerdefinierte Aktionsfelder
  • Aktionsanlagen
  • und vieles mehr...

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 Edge NXT-Umgebung der Organisation und konfiguriert Ihre Benutzerkontoberechtigungen 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

Abrufen einer konstituierenden Aktion

Gibt Informationen zu einer konstituierenden Aktion zurück.

Aktualisieren einer Aktionsanlage

Aktualisiert eine Aktionsanlage.

Aktualisieren einer konstituierenden Aktion

Aktualisiert eine konstituierende Aktion.

Aktualisieren eines benutzerdefinierten Aktionsfelds

Aktualisiert ein benutzerdefiniertes Aktionsfeld.

Auflisten von Einzelaktionen

Listet die Aktionen für einen Bestandteil auf.

Benutzerdefinierte Listenaktionsfelder

Listet die benutzerdefinierten Felder für eine Aktion auf.

Erstellen einer Aktionsanlage

Erstellt eine neue Aktionsanlage.

Erstellen einer konstituierenden Aktion

Erstellt eine neue konstituierende Aktion.

Erstellen eines benutzerdefinierten Aktionsfelds

Erstellt ein neues benutzerdefiniertes Aktionsfeld.

Listenaktionen

Gibt eine Liste von Aktionen zurück.

Listenaktionsanlagen

Listet die Anlagen für eine Aktion auf.

Abrufen einer konstituierenden Aktion

Gibt Informationen zu einer konstituierenden Aktion zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Aktions-ID
action_id True string

Die Systemdatensatz-ID der abzurufenden Aktion.

Gibt zurück

Maßnahme

Aktualisieren einer Aktionsanlage

Aktualisiert eine Aktionsanlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anlagen-ID
attachment_id True string

Die Systemdatensatz-ID der zu aktualisierenden Anlage.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z').

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

Aktualisieren einer konstituierenden Aktion

Aktualisiert eine konstituierende Aktion.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Aktions-ID
action_id True string

Die Systemdatensatz-ID der zu aktualisierenden Aktion.

Datum
date date-time

Das Aktionsdatum (z. B. '2020-09-18T04:13:56Z').

Kategorie
category string

Der Kanal oder die Absicht der konstituierenden Interaktion.

Typ
type string

Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.

Zusammenfassung
summary string

Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.

Hinweis
description string

Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.

Abgeschlossen?
completed boolean

Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.

Abgeschlossen am
completed_date date-time

Das Datum, an dem die Aktion abgeschlossen wurde (z. B. '2020-09-18T04:13:56Z').

Der Status
status string

Der Aktionsstatus.

Richtung
direction string

Die Richtung der Aktion.

Standort
location string

Die Position der Aktion.

Verkaufschancen-ID
opportunity_id string

Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.

Ergebnis
outcome string

Das Ergebnis der Aktion.

Priority
priority string

Die Priorität der Aktion.

Startzeit
start_time string

Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Endzeitpunkt
end_time string

Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Fundraiser(en)
fundraisers array of string

Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.

Aktualisieren eines benutzerdefinierten Aktionsfelds

Aktualisiert ein benutzerdefiniertes Aktionsfeld.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
ID des benutzerdefinierten Felds
custom_field_id True string

Die Systemdatensatz-ID des zu aktualisierenden benutzerdefinierten Felds.

body
body True dynamic

Ein Objekt, das die Eigenschaften des zu aktualisierenden benutzerdefinierten Felds darstellt.

Auflisten von Einzelaktionen

Listet die Aktionen für einen Bestandteil auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Bestandteils.

Gibt zurück

Aktionen

Benutzerdefinierte Listenaktionsfelder

Listet die benutzerdefinierten Felder für eine Aktion auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Aktions-ID
action_id True string

Die Systemdatensatz-ID der Aktion.

Gibt zurück

Benutzerdefinierte Felder

Erstellen einer Aktionsanlage

Erstellt eine neue Aktionsanlage.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Aktions-ID
parent_id True string

Die Systemdatensatz-ID der Aktion, die der Anlage zugeordnet ist.

Typ
type True string

Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage (z. B. '2020-09-18T04:13:56Z'). Dieses Feld wird standardmäßig auf das aktuelle Datum und die aktuelle Uhrzeit festgelegt, wenn nicht angegeben.

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Dateiname
file_name string

Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Datei-ID
file_id string

Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-ID
thumbnail_id string

Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

Gibt zurück

Erstellte Aktionsanlage

Erstellen einer konstituierenden Aktion

Erstellt eine neue konstituierende Aktion.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Bestandteil-ID
constituent_id True string

Die Systemdatensatz-ID des Mit der Aktion verknüpften Bestandteils.

Datum
date True date-time

Das Aktionsdatum (z. B. '2020-09-18T04:13:56Z').

Kategorie
category True string

Der Kanal oder die Absicht der konstituierenden Interaktion.

Typ
type string

Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.

Zusammenfassung
summary string

Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.

Hinweis
description string

Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.

Abgeschlossen?
completed boolean

Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.

Abgeschlossen am
completed_date date-time

Das Datum, an dem die Aktion abgeschlossen wurde (z. B. '2020-09-18T04:13:56Z').

Der Status
status string

Der Aktionsstatus.

Richtung
direction string

Die Richtung der Aktion.

Standort
location string

Die Position der Aktion.

Verkaufschancen-ID
opportunity_id string

Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.

Ergebnis
outcome string

Das Ergebnis der Aktion.

Priority
priority string

Die Priorität der Aktion.

Startzeit
start_time string

Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Endzeitpunkt
end_time string

Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Autor
author string

Der Autor der Zusammenfassung und Beschreibung der Aktion. Wenn nicht angegeben, wird ein Standardsatz basierend auf dem Konto des Benutzers festgelegt. Zeichenlimit: 50.

Fundraiser(en)
fundraisers array of string

Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.

Gibt zurück

Erstellte Aktion

Erstellen eines benutzerdefinierten Aktionsfelds

Erstellt ein neues benutzerdefiniertes Aktionsfeld.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
body
body True dynamic

Ein Objekt, das das zu erstellende benutzerdefinierte Feld darstellt.

Gibt zurück

Benutzerdefiniertes Aktionsfeld erstellt

Listenaktionen

Gibt eine Liste von Aktionen zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
List
list_id string

Definiert einen Listenbezeichner, der zum Filtern der Gruppe von Aktionen verwendet wird, die in der angegebenen Liste enthalten sind. Wenn dieser Wert festgelegt ist, werden andere angegebene Filter ignoriert.

Berechneter Status
computed_status string

Stellt einen Filter für Ergebnisse basierend auf dem berechneten Aktionsstatus dar. Verfügbare Werte sind "Open", "Completed" oder "PastDue".

Der Status
status_code string

Stellt einen Aktionsstatuscode zum Filtern der Ergebnisse dar (gilt nur, wenn das System für die Verwendung von Aktionsstatuscodes konfiguriert ist). Beispielsweise gibt "Ausstehend" Aktionen mit dem Status "Ausstehend" zurück.

Limit
limit integer

Stellt die Anzahl der zurückzugebenden Datensätze dar. Der Standardwert ist 500. Das Maximum beträgt 5000.

Offset
offset integer

Stellt die Anzahl der zu überspringenden Datensätze dar. Zur Verwendung mit Paginierung.

Hinzugefügt am oder nach
date_added date-time

Filtern Sie die Ergebnisse nach Aktionen, die an oder nach dem angegebenen Datum erstellt wurden (z. B. "2020-09-18T04:13:56Z").

Geändert am oder nach
last_modified date-time

Filtern Sie die Ergebnisse nach Aktionen, die am oder nach dem angegebenen Datum geändert wurden (z. B. '2020-09-18T04:13:56Z').

Gibt zurück

Aktionen

Listenaktionsanlagen

Listet die Anlagen für eine Aktion auf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Aktions-ID
action_id True string

Die Systemdatensatz-ID der Aktion.

Gibt zurück

Attachments

Definitionen

ConstituentApi.ActionAttachmentRead

Attachment

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Anlage.

Aktions-ID
parent_id string

Die Systemdatensatz-ID der Aktion, die der Anlage zugeordnet ist.

Typ
type string

Der Anlagentyp. Physische Anlagen werden hochgeladene Dateien wie Bilder, PDFs oder Word-Dokumente, die lokal oder im Netzwerk gespeichert werden. Sie werden im System gespeichert und verwaltet. Linkanlagen sind Links zu Dateien wie Bildern, Blogbeiträgen oder YouTube-Videos, die online oder in einem Cloudspeicherkonto gespeichert sind. Sie werden extern gespeichert und verwaltet.

Name
name string

Der Name der Anlage. Zeichenlimit: 150.

Datum
date date-time

Das Datum der Anlage.

URL
url string

Die URL für die Anlage. Dies ist für Verknüpfungsanlagen erforderlich und gilt nicht für physische Anlagen.

Dateiname
file_name string

Der Name der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Datei-ID
file_id string

Der Bezeichner der Datei. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-ID
thumbnail_id string

Der Bezeichner der Miniaturansicht. Zeichenlimit: 36. Nur für physische Anlagen.

Miniaturansichts-URL
thumbnail_url string

Die URL für eine Miniaturansicht. Nur für physische Anlagen, die Bilder sind. Enthält eine zeitgebundene Signatur, die den Zugriff auf 60 Minuten beschränkt.

Inhaltstyp
content_type string

Der Inhaltstyp. Nur für physische Anlagen.

Dateigröße
file_size integer

Die Dateigröße in Byte. Nur für physische Anlagen.

Stichwörter
tags array of string

Die tags, die der Anlage zugeordnet sind.

ConstituentApi.ActionCustomFieldRead

Benutzerdefiniertes Feld

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID des benutzerdefinierten Felds.

Aktions-ID
parent_id string

Die Systemdatensatz-ID der Aktion, die dem benutzerdefinierten Feld zugeordnet ist.

Kategorie
category string

Die Kategorie des benutzerdefinierten Felds.

Typ
type string

Der Datentyp, den das benutzerdefinierte Feld darstellt.

Wert
value

Der Wert des benutzerdefinierten Felds.

Textwert
text_value string

Der Textwert des benutzerdefinierten Felds.

Zahlenwert
number_value integer

Der numerische Wert des benutzerdefinierten Felds.

Datumswert
date_value date

Der Datumswert des benutzerdefinierten Felds.

Währungswert
currency_value double

Der Währungswert des benutzerdefinierten Felds.

Boolescher Wert
boolean_value boolean

Der boolesche Wert des benutzerdefinierten Felds.

Tabelleneintragswert
codetableentry_value string

Der Tabelleneintragswert des benutzerdefinierten Felds.

Bestandteil-ID-Wert
constituentid_value string

Der Id-Bestandteilwert des benutzerdefinierten Felds.

Tag
fuzzydate_value.d integer

Der Tag im Fuzzydatum.

Monat
fuzzydate_value.m integer

Der Monat im Fuzzydatum.

Jahr
fuzzydate_value.y integer

Das Jahr im Fuzzydatum.

Datum
date date

Das Datum im benutzerdefinierten Feld.

Kommentar
comment string

Der Kommentar für das benutzerdefinierte Feld. Zeichenlimit: 50.

Datum hinzugefügt
date_added date-time

Das Datum, an dem das benutzerdefinierte Feld erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem das benutzerdefinierte Feld zuletzt geändert wurde.

ConstituentApi.ActionRead

Maßnahme

Name Pfad Typ Beschreibung
ID
id string

Die Systemdatensatz-ID der Aktion.

Bestandteil-ID
constituent_id string

Die Systemdatensatz-ID des Mit der Aktion verknüpften Bestandteils.

Kategorie
category string

Der Kanal oder die Absicht der konstituierenden Interaktion.

Abgeschlossen?
completed boolean

Ist die Aktion abgeschlossen? Wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, basiert dieser Wert auf dem Aktionsstatuswert.

Abgeschlossen am
completed_date date-time

Das Datum, an dem die Aktion abgeschlossen wurde.

Datum
date date-time

Das Aktionsdatum.

Hinweis
description string

Die ausführliche Erläuterung, die die Aktionszusammenfassung erläutert.

Richtung
direction string

Die Richtung der Aktion.

Fundraiser(en)
fundraisers array of string

Der Satz von Systemdatensatz-IDs für die Fundraiser, die mit der Aktion verbunden sind.

Standort
location string

Die Position der Aktion.

Verkaufschancen-ID
opportunity_id string

Die Systemdatensatz-ID der Verkaufschance, die der Aktion zugeordnet ist.

Ergebnis
outcome string

Das Ergebnis der Aktion.

Priority
priority string

Die Priorität der Aktion.

Startzeit
start_time string

Die Startzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Endzeitpunkt
end_time string

Die Endzeit der Aktion. Verwendet 24-Stunden-Zeit im HH:mm-Format.

Der Status
status string

Der Aktionsstatus.

Statuscode
status_code string

Der Aktionsstatuscode. Diese Eigenschaft wird nur zurückgegeben, wenn das System für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist.

Berechneter Status
computed_status string

Der berechnete Aktionsstatus. Wenn das System nicht für die Verwendung von benutzerdefinierten Aktionsstatus konfiguriert ist, berechnet dieses Feld den Status basierend auf den Eigenschaften "Abgeschlossen" und "Datum". Andernfalls berechnet das Feld den Status basierend auf der Datumseigenschaft der Aktion und ob die Aktionsstatuseigenschaft der Aktion als abgeschlossen konfiguriert ist.

Zusammenfassung
summary string

Die kurze Beschreibung der Aktion, die oben im Datensatz angezeigt wird. Zeichenlimit: 255.

Typ
type string

Zusätzliche Beschreibung der Aktion zur Ergänzung der Kategorie.

Datum hinzugefügt
date_added date-time

Das Datum, an dem die Aktion erstellt wurde.

Änderungsdatum
date_modified date-time

Das Datum, an dem die Aktion zuletzt geändert wurde.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ActionAttachmentRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Benutzerdefinierte Felder

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ActionCustomFieldRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.ApiCollectionOfActionRead

Aktionen

Name Pfad Typ Beschreibung
Anzahl
count integer

Die Anzahl der Elemente, die nach dem Anwenden von Anforderungsparametern zum Abrufen in die Auflistung verfügbar sind. Die Parameter "Limit" und "offset" wirken sich nicht auf die Anzahl aus, aber um das Paging zu erleichtern, können sie sich auf die Anzahl der Elemente im Wertergebnissatz auswirken.

value
value array of ConstituentApi.ActionRead

Der Satz von Elementen, die in der Antwort enthalten sind. Dies kann eine Teilmenge der Elemente in der Auflistung sein.

ConstituentApi.CreatedAction

Erstellte Aktion

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Aktion.

ConstituentApi.CreatedActionAttachment

Erstellte Aktionsanlage

Name Pfad Typ Beschreibung
ID
id string

Die ID der neu erstellten Aktionsanlage.

ConstituentApi.CreatedActionCustomField

Benutzerdefiniertes Aktionsfeld erstellt

Name Pfad Typ Beschreibung
ID
id string

Die ID des neu erstellten benutzerdefinierten Aktionsfelds.