Condividi tramite

Interazioni NXT di Blackbaud Raisers Edge

Blackbaud Raiser Edge NXT è una soluzione software completa di raccolta fondi e gestione dei donatori basata sul cloud creata appositamente per organizzazioni no profit e l'intera comunità sociale. Usare il connettore Interazioni per gestire le azioni costitutive.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio Class Regions
Copilot Studio Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Normale Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Di alta qualità Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Di alta qualità Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Supporto blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadati del connettore
Editore Blackbaud, Inc.
Sito web https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Informativa sulla privacy https://www.blackbaud.com/privacy-shield
Categorie Vendite e CRM; Produttività

Edge NXT di Raiser è una soluzione software completa di raccolta fondi e gestione dei donatori basata sul cloud creata appositamente per organizzazioni no profit e l'intera comunità sociale.

Questo connettore si basa sull'API SKY di Blackbaud e fornisce operazioni che consentono di gestire le interoperabilità costitutive e le entità correlate all'interno di Edge NXT di The Raiser, tra cui:

  • Azioni
  • Campi personalizzati azione
  • Allegati azione
  • E altro ancora...

Per altre informazioni, vedere la documentazione.

Prerequisiti

Per usare questo connettore, è necessario disporre di un account Blackbaud ID con accesso a uno o più ambienti Blackbaud.

Inoltre, l'amministratore dell'organizzazione deve eseguire un'azione a livello di amministratore all'interno del sistema per consentire a questo connettore di accedere all'ambiente Blackbaud. Altre informazioni su questi prerequisiti sono disponibili nella documentazione di configurazione iniziale .

Come ottenere le credenziali?

L'amministratore dell'organizzazione invierà un invito all'ambiente NXT edge dell'organizzazione e configurerà le autorizzazioni dell'account utente all'interno dell'ambiente. Per usare questo connettore non sono necessarie credenziali aggiuntive.

Problemi noti e limitazioni

Il connettore funzionerà nel contesto dell'account utente e sarà quindi soggetto alle autorizzazioni utente all'interno dell'ambiente.

Limiti per la limitazione delle richieste

Nome Chiamate Periodo di rinnovo
Chiamate API per connessione 100 60 secondi

Azioni

Aggiornare un'azione costitutiva

Aggiorna un'azione costitutiva.
Aggiornare un allegato di azione

Aggiorna un allegato di azione.
Aggiornare un campo personalizzato di un'azione

Aggiorna un campo personalizzato dell'azione.
Creare un'azione costitutiva

Crea una nuova azione costitutiva.
Creare un allegato azione

Crea un nuovo allegato di azione.
Creare un campo personalizzato dell'azione

Crea un nuovo campo personalizzato azione.
Elencare gli allegati delle azioni

Elenca gli allegati per un'azione.
Elencare i campi personalizzati dell'azione

Elenca i campi personalizzati per un'azione.
Elencare le azioni

Restituisce un elenco di azioni.
Elencare le azioni costitutive

Elenca le azioni per un componente.
Ottenere un'azione costitutiva

Restituisce informazioni su un'azione costitutiva.

Aggiornare un'azione costitutiva

ID operazione:
EditAction

Aggiorna un'azione costitutiva.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID azione
 action_id True string

ID record di sistema dell'azione da aggiornare.
Date
 date date-time

Data dell'azione (ad esempio: '2020-09-18T04:13:56Z').
Categoria
 category string

Canale o finalità dell'interazione costituente.
TIPO
 type string

Descrizione aggiuntiva dell'azione per completare la categoria.
Riassunto
 summary string

Breve descrizione dell'azione visualizzata nella parte superiore del record. Limite di caratteri: 255.
Annotazioni
 description string

Spiegazione dettagliata che elabora il riepilogo dell'azione.
Finito?
 completed boolean

L'azione è stata completata? Se il sistema è configurato per l'uso di stati di azione personalizzati, questo valore è basato sul valore dello stato dell'azione.
Data di completamento
 completed_date date-time

Data di completamento dell'azione (ad esempio: '2020-09-18T04:13:56Z').
stato
 status string

Stato dell'azione.
Direction
 direction string

Direzione dell'azione.
Posizione
 location string

Posizione dell'azione.
ID opportunità
 opportunity_id string

ID record di sistema dell'opportunità associata all'azione.
Risultato
 outcome string

Risultato dell'azione.
Priority
 priority string

Priorità dell'azione.
Ora di avvio
 start_time string

Ora di inizio dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
Ora di fine
 end_time string

Ora di fine dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
Raccolta fondi
 fundraisers array of string

Set di ID di record di sistema per le raccolte fondi associate all'azione.

Aggiornare un allegato di azione

ID operazione:
EditActionAttachment

Aggiorna un allegato di azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID allegato
 attachment_id True string

ID record di sistema dell'allegato da aggiornare.
Nome
 name string

Nome dell'allegato. Limite di caratteri: 150.
Date
 date date-time

Data dell'allegato (ad esempio: '2020-09-18T04:13:56Z').
URL
 url string

URL dell'allegato. Questa operazione è necessaria per gli allegati di collegamento e non applicabile per gli allegati fisici.
Etichette
 tags array of string

Tag associati all'allegato.

Aggiornare un campo personalizzato di un'azione

ID operazione:
EditActionCustomField

Aggiorna un campo personalizzato dell'azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID campo personalizzato
 custom_field_id True string

ID del record di sistema del campo personalizzato da aggiornare.
body
 body True dynamic

Oggetto che rappresenta le proprietà del campo personalizzato da aggiornare.

Creare un'azione costitutiva

ID operazione:
CreateAction

Crea una nuova azione costitutiva.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID costitutivo
 constituent_id True string

ID del record di sistema dell'elemento costitutivo associato all'azione.
Date
 date True date-time

Data dell'azione (ad esempio: '2020-09-18T04:13:56Z').
Categoria
 category True string

Canale o finalità dell'interazione costituente.
TIPO
 type string

Descrizione aggiuntiva dell'azione per completare la categoria.
Riassunto
 summary string

Breve descrizione dell'azione visualizzata nella parte superiore del record. Limite di caratteri: 255.
Annotazioni
 description string

Spiegazione dettagliata che elabora il riepilogo dell'azione.
Finito?
 completed boolean

L'azione è stata completata? Se il sistema è configurato per l'uso di stati di azione personalizzati, questo valore è basato sul valore dello stato dell'azione.
Data di completamento
 completed_date date-time

Data di completamento dell'azione (ad esempio: '2020-09-18T04:13:56Z').
stato
 status string

Stato dell'azione.
Direction
 direction string

Direzione dell'azione.
Posizione
 location string

Posizione dell'azione.
ID opportunità
 opportunity_id string

ID record di sistema dell'opportunità associata all'azione.
Risultato
 outcome string

Risultato dell'azione.
Priority
 priority string

Priorità dell'azione.
Ora di avvio
 start_time string

Ora di inizio dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
Ora di fine
 end_time string

Ora di fine dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
Autore
 author string

Autore del riepilogo e della descrizione dell'azione. Se non specificato, avrà un set predefinito basato sull'account dell'utente. Limite di caratteri: 50.
Raccolta fondi
 fundraisers array of string

Set di ID di record di sistema per le raccolte fondi associate all'azione.

Restituisce

Azione creata

Corpo
ConstituentApi.CreatedAction

Creare un allegato azione

ID operazione:
CreateActionAttachment

Crea un nuovo allegato di azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID azione
 parent_id True string

ID record di sistema dell'azione associata all'allegato.
TIPO
 type True string

Tipo di allegato. Gli allegati fisici vengono caricati file come immagini, PDF o documenti di Word salvati in locale o in rete. Vengono archiviati e gestiti nel sistema. Gli allegati di collegamento sono collegamenti a file come immagini, post di blog o video di YouTube online o in un account di archiviazione cloud. Vengono archiviati e gestiti esternamente.
Nome
 name string

Nome dell'allegato. Limite di caratteri: 150.
Date
 date date-time

Data dell'allegato (ad esempio: '2020-09-18T04:13:56Z'). Questo campo viene impostato per impostazione predefinita sulla data e l'ora correnti, se non specificata.
URL
 url string

URL dell'allegato. Questa operazione è necessaria per gli allegati di collegamento e non applicabile per gli allegati fisici.
Nome del file
 file_name string

Nome del file. Limite di caratteri: 36. Solo per gli allegati fisici.
File ID
 file_id string

Identificatore del file. Limite di caratteri: 36. Solo per gli allegati fisici.
ID anteprima
 thumbnail_id string

Identificatore dell'anteprima. Limite di caratteri: 36. Solo per gli allegati fisici.
Etichette
 tags array of string

Tag associati all'allegato.

Restituisce

Allegato azione creato

Corpo
ConstituentApi.CreatedActionAttachment

Creare un campo personalizzato dell'azione

ID operazione:
CreateActionCustomField

Crea un nuovo campo personalizzato azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
body
 body True dynamic

Oggetto che rappresenta il campo personalizzato da creare.

Restituisce

Campo personalizzato dell'azione creato

Corpo
ConstituentApi.CreatedActionCustomField

Elencare gli allegati delle azioni

ID operazione:
ListActionAttachments

Elenca gli allegati per un'azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID azione
 action_id True string

ID record di sistema dell'azione.

Restituisce

Attachments

Corpo
ConstituentApi.ApiCollectionOfActionAttachmentRead

Elencare i campi personalizzati dell'azione

ID operazione:
ListActionCustomFields

Elenca i campi personalizzati per un'azione.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID azione
 action_id True string

ID record di sistema dell'azione.

Restituisce

Campi personalizzati

Corpo
ConstituentApi.ApiCollectionOfActionCustomFieldRead

Elencare le azioni

ID operazione:
ListActions

Restituisce un elenco di azioni.

Parametri

Nome Chiave Necessario Tipo Descrizione
Elenco
 list_id string

Definisce un identificatore di elenco utilizzato per filtrare il set di azioni in base a quelli inclusi nell'elenco specificato. Se questo valore è impostato, gli altri filtri specificati verranno ignorati.
Stato calcolato
 computed_status string

Rappresenta un filtro per i risultati in base allo stato dell'azione calcolata. I valori disponibili sono Open, Completed o PastDue.
stato
 status_code string

Rappresenta un codice di stato dell'azione per filtrare i risultati (applicabile solo quando il sistema è configurato per l'uso dei codici di stato dell'azione). Ad esempio, "In sospeso" restituisce azioni con stato "In sospeso".
Limite
 limit integer

Rappresenta il numero di record da restituire. Il valore predefinito è 500. Il valore massimo è 5000.
Offset
 offset integer

Rappresenta il numero di record da ignorare. Per l'uso con la paginazione.
Aggiunta in o dopo
 date_added date-time

Filtrare i risultati in base alle azioni create alla data specificata (ad esempio: '2020-09-18T04:13:56Z').
Modificato in o dopo
 last_modified date-time

Filtrare i risultati in base alle azioni modificate alla data specificata (ad esempio: '2020-09-18T04:13:56Z').

Restituisce

Azioni

Corpo
ConstituentApi.ApiCollectionOfActionRead

Elencare le azioni costitutive

ID operazione:
ListConstituentActions

Elenca le azioni per un componente.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID costitutivo
 constituent_id True string

ID del record di sistema dell'elemento costitutivo.

Restituisce

Azioni

Corpo
ConstituentApi.ApiCollectionOfActionRead

Ottenere un'azione costitutiva

ID operazione:
GetAction

Restituisce informazioni su un'azione costitutiva.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID azione
 action_id True string

ID record di sistema dell'azione da ottenere.

Restituisce

Action

Corpo
ConstituentApi.ActionRead

Definizioni

ConstituentApi.ActionAttachmentRead

Attachment

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID del record di sistema dell'allegato.
ID azione
 parent_id string

ID record di sistema dell'azione associata all'allegato.
TIPO
 type string

Tipo di allegato. Gli allegati fisici vengono caricati file come immagini, PDF o documenti di Word salvati in locale o in rete. Vengono archiviati e gestiti nel sistema. Gli allegati di collegamento sono collegamenti a file come immagini, post di blog o video di YouTube online o in un account di archiviazione cloud. Vengono archiviati e gestiti esternamente.
Nome
 name string

Nome dell'allegato. Limite di caratteri: 150.
Date
 date date-time

Data dell'allegato.
URL
 url string

URL dell'allegato. Questa operazione è necessaria per gli allegati di collegamento e non applicabile per gli allegati fisici.
Nome del file
 file_name string

Nome del file. Limite di caratteri: 36. Solo per gli allegati fisici.
File ID
 file_id string

Identificatore del file. Limite di caratteri: 36. Solo per gli allegati fisici.
ID anteprima
 thumbnail_id string

Identificatore dell'anteprima. Limite di caratteri: 36. Solo per gli allegati fisici.
URL anteprima
 thumbnail_url string

URL di un'anteprima. Per gli allegati fisici che sono solo immagini. Contiene una firma con associazione a tempo che limita l'accesso a 60 minuti.
Tipo di contenuto
 content_type string

Tipo di contenuto. Solo per gli allegati fisici.
Dimensione del file
 file_size integer

Dimensioni del file in byte. Solo per gli allegati fisici.
Etichette
 tags array of string

Tag associati all'allegato.

ConstituentApi.ActionCustomFieldRead

Il campo personalizzato

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID record di sistema del campo personalizzato.
ID azione
 parent_id string

ID record di sistema dell'azione associata al campo personalizzato.
Categoria
 category string

Categoria di campi personalizzati.
TIPO
 type string

Tipo di dati rappresentato dal campo personalizzato.
Value
 value

Valore del campo personalizzato.
Valore di testo
 text_value string

Valore di testo del campo personalizzato.
Valore numerico
 number_value integer

Valore numerico del campo personalizzato.
Valore data
 date_value date

Valore della data del campo personalizzato.
Valore valuta
 currency_value double

Valore di valuta del campo personalizzato.
Valore booleano
 boolean_value boolean

Valore booleano del campo personalizzato.
Valore voce tabella
 codetableentry_value string

Valore della voce di tabella del campo personalizzato.
Valore ID costitutivo
 constituentid_value string

Valore ID costitutivo del campo personalizzato.
Giorno
 fuzzydate_value.d integer

Giorno della data fuzzy.
mese
 fuzzydate_value.m integer

Mese nella data fuzzy.
anno
 fuzzydate_value.y integer

Anno nella data fuzzy.
Date
 date date

Data nel campo personalizzato.
Comment
 comment string

Commento sul campo personalizzato. Limite di caratteri: 50.
Data di aggiunta
 date_added date-time

Data di creazione del campo personalizzato.
Data di modifica
 date_modified date-time

Data dell'ultima modifica del campo personalizzato.

ConstituentApi.ActionRead

Action

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID record di sistema dell'azione.
ID costitutivo
 constituent_id string

ID del record di sistema dell'elemento costitutivo associato all'azione.
Categoria
 category string

Canale o finalità dell'interazione costituente.
Finito?
 completed boolean

L'azione è stata completata? Se il sistema è configurato per l'uso di stati di azione personalizzati, questo valore è basato sul valore dello stato dell'azione.
Data di completamento
 completed_date date-time

Data di completamento dell'azione.
Date
 date date-time

Data dell'azione.
Annotazioni
 description string

Spiegazione dettagliata che elabora il riepilogo dell'azione.
Direction
 direction string

Direzione dell'azione.
Raccolta fondi
 fundraisers array of string

Set di ID di record di sistema per le raccolte fondi associate all'azione.
Posizione
 location string

Posizione dell'azione.
ID opportunità
 opportunity_id string

ID record di sistema dell'opportunità associata all'azione.
Risultato
 outcome string

Risultato dell'azione.
Priority
 priority string

Priorità dell'azione.
Ora di avvio
 start_time string

Ora di inizio dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
Ora di fine
 end_time string

Ora di fine dell'azione. Usa un'ora di 24 ore nel formato HH:mm.
stato
 status string

Stato dell'azione.
Codice di stato
 status_code string

Codice di stato dell'azione. Questa proprietà viene restituita solo quando il sistema è configurato per l'uso di stati di azione personalizzati.
Stato calcolato
 computed_status string

Stato dell'azione calcolata. Se il sistema non è configurato per l'utilizzo di stati di azione personalizzati, questo campo calcola lo stato in base alle proprietà complete e di data. In caso contrario, il campo calcola lo stato in base alla proprietà date dell'azione e se la proprietà Stato azione dell'azione è configurata come completata.
Riassunto
 summary string

Breve descrizione dell'azione visualizzata nella parte superiore del record. Limite di caratteri: 255.
TIPO
 type string

Descrizione aggiuntiva dell'azione per completare la categoria.
Data di aggiunta
 date_added date-time

Data di creazione dell'azione.
Data di modifica
 date_modified date-time

Data dell'ultima modifica dell'azione.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Nome Percorso Tipo Descrizione
Conteggio
 count integer

Numero di elementi disponibili per il recupero nella raccolta dopo l'applicazione di eventuali parametri di richiesta. I parametri limite e offset non influiscono sul conteggio, ma per facilitare il paging, possono influire sul numero di elementi nel set di risultati del valore.
value
 value array of ConstituentApi.ActionAttachmentRead

Set di elementi inclusi nella risposta. Può trattarsi di un subset degli elementi nell'insieme.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Campi personalizzati

Nome Percorso Tipo Descrizione
Conteggio
 count integer

Numero di elementi disponibili per il recupero nella raccolta dopo l'applicazione di eventuali parametri di richiesta. I parametri limite e offset non influiscono sul conteggio, ma per facilitare il paging, possono influire sul numero di elementi nel set di risultati del valore.
value
 value array of ConstituentApi.ActionCustomFieldRead

Set di elementi inclusi nella risposta. Può trattarsi di un subset degli elementi nell'insieme.

ConstituentApi.ApiCollectionOfActionRead

Azioni

Nome Percorso Tipo Descrizione
Conteggio
 count integer

Numero di elementi disponibili per il recupero nella raccolta dopo l'applicazione di eventuali parametri di richiesta. I parametri limite e offset non influiscono sul conteggio, ma per facilitare il paging, possono influire sul numero di elementi nel set di risultati del valore.
value
 value array of ConstituentApi.ActionRead

Set di elementi inclusi nella risposta. Può trattarsi di un subset degli elementi nell'insieme.

ConstituentApi.CreatedAction

Azione creata

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID dell'azione appena creata.

ConstituentApi.CreatedActionAttachment

Allegato azione creato

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID dell'allegato dell'azione appena creata.

ConstituentApi.CreatedActionCustomField

Campo personalizzato dell'azione creato

Nome Percorso Tipo Descrizione
Documento d'identità
 id string

ID del campo personalizzato dell'azione appena creato.