Requête NXT Financial Edge [DÉPRÉCIÉE]
Blackbaud Financial Edge NXT est une solution logicielle de comptabilité basée sur le cloud complète conçue spécifiquement pour les organisations à but non lucratif. Utilisez le connecteur de requête pour gérer et exécuter des requêtes.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge de Blackbaud |
| URL | https://www.blackbaud.com/support |
| Messagerie électronique | skyapi@blackbaud.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Blackbaud. Inc |
| Site internet | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| Politique de confidentialité | https://www.blackbaud.com/privacy-shield |
| Catégories | Ventes et CRM ; Productivité |
Financial Edge NXT est une solution de comptabilité cloud totale conçue spécifiquement pour répondre aux besoins uniques des organisations à but non lucratif et des entités gouvernementales.
Ce connecteur est basé sur l’API SKY de Blackbaud et fournit des opérations pour aider à gérer les requêtes et les entités associées trouvées dans Financial Edge NXT.
Pour plus d’informations, consultez la documentation.
Prerequisites
Pour utiliser ce connecteur, vous devez disposer d’un compte Blackbaud ID avec accès à un ou plusieurs environnements Blackbaud.
En outre, l’application Microsoft Power Platform à partir de la Place de marché Blackbaud doit être connectée à l’environnement. Vous trouverez plus d’informations sur ces prérequis dans la documentation de configuration initiale .
Comment obtenir des informations d’identification ?
L’administrateur de votre organisation vous envoie une invitation à l’environnement Financial Edge NXT de l’organisation et configure les autorisations de votre compte d’utilisateur dans l’environnement. Aucune information d’identification supplémentaire n’est requise pour utiliser ce connecteur.
Problèmes connus et limitations
Le connecteur fonctionne dans le contexte de votre compte d’utilisateur et sera donc soumis à vos autorisations utilisateur dans l’environnement.
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Démarrer un travail de requête (déconseillé) [DÉPRÉCIÉ] |
Démarre un travail en arrière-plan pour exécuter la requête spécifiée (déconseillée). |
| Démarrer un travail de requête ad hoc (déconseillé) [DÉPRÉCIÉ] |
Démarre un travail en arrière-plan pour exécuter la définition de requête ad hoc spécifiée (déconseillée). |
| Démarrer un travail de requête statique d’actualisation (déconseillé) [DÉCONSEILLÉ] |
Démarre une tâche en arrière-plan pour actualiser les clés enregistrées pour la requête statique spécifiée (déconseillée). |
| Obtenir l’état du travail de requête (déconseillé) [DÉCONSEILLÉ] |
Retourne des informations sur un travail d’exécution de requête en arrière-plan (déconseillé). |
| Répertorier les requêtes (déconseillées) [DÉCONSEILLÉE] |
Retourne une liste de requêtes (déconseillées). |
Démarrer un travail de requête (déconseillé) [DÉPRÉCIÉ]
Démarre un travail en arrière-plan pour exécuter la requête spécifiée (déconseillée).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
Module NXT Financial Edge pour la demande. |
|
Type
|
v_query_type_id | True | integer |
Filtrez l’ensemble de requêtes sur ceux avec un type de requête spécifique. |
|
Query
|
id | True | integer |
Requête à exécuter. |
|
Format de sortie
|
output_format | string |
Indique le format de sortie du fichier de résultats de requête. |
|
|
Mode mise en forme
|
formatting_mode | string |
Indique si la mise en forme doit être appliquée aux résultats de la requête. |
|
|
Mode de génération SQL
|
sql_generation_mode | string |
Indique comment les champs de sélection de requête doivent être gérés. Lorsque « Requête » est sélectionnée, la sortie inclut les champs sélectionnés définis pour la requête et QRECID. Lorsque « Exporter » est sélectionné, la sortie inclut les champs sélectionnés définis pour la requête UNIQUEMENT. Lorsque « Rapport » est sélectionné, la sortie inclut UNIQUEMENT QRECID. |
|
|
Utilisez une requête statique ?
|
use_static_query_id_set | boolean |
Utilisez la requête statique comme source d’enregistrements (si ce n’est pas le cas, la requête sera exécutée dynamiquement) ? |
Retours
Travail de requête démarré
Démarrer un travail de requête ad hoc (déconseillé) [DÉPRÉCIÉ]
Démarre un travail en arrière-plan pour exécuter la définition de requête ad hoc spécifiée (déconseillée).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
Module NXT Financial Edge pour la demande. |
|
Définition de la requête
|
query | True | object |
Représentation JSON de la définition de requête. |
|
Format de sortie
|
output_format | string |
Indique le format de sortie du fichier de résultats de requête. |
|
|
Mode mise en forme
|
formatting_mode | string |
Indique si la mise en forme doit être appliquée aux résultats de la requête. |
Retours
Travail de requête démarré
Démarrer un travail de requête statique d’actualisation (déconseillé) [DÉCONSEILLÉ]
Démarre une tâche en arrière-plan pour actualiser les clés enregistrées pour la requête statique spécifiée (déconseillée).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
Module NXT Financial Edge pour la demande. |
|
Type
|
v_query_type_id | True | integer |
Filtrez l’ensemble de requêtes sur ceux avec un type de requête spécifique. |
|
Query
|
id | True | integer |
Requête à exécuter. |
Retours
Travail de requête démarré
Obtenir l’état du travail de requête (déconseillé) [DÉCONSEILLÉ]
Retourne des informations sur un travail d’exécution de requête en arrière-plan (déconseillé).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
Module NXT Financial Edge pour la demande. |
|
ID du travail
|
job_id | True | string |
ID d’enregistrement système du travail d’exécution de requête. |
|
Inclure l’URL des résultats ?
|
include_read_url | string |
Incluez l’URL du fichier de résultats de la requête ? |
|
|
Disposition du contenu
|
content_disposition | string |
Indique comment les résultats de la requête seront consultés. |
Retours
Travail d’exécution de requête
Répertorier les requêtes (déconseillées) [DÉCONSEILLÉE]
Retourne une liste de requêtes (déconseillées).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Module
|
module | True | string |
Module NXT Financial Edge pour la demande. |
|
Type
|
query_type_id | integer |
Filtrez l’ensemble de requêtes sur ceux avec un type de requête spécifique. |
|
|
Catégorie
|
category | integer |
Filtrez l’ensemble de requêtes sur ceux avec une catégorie spécifique. |
|
|
Format
|
query_format | string |
Filtrez l’ensemble de requêtes avec un format spécifique. |
|
|
Texte de recherche
|
search_text | string |
Texte de recherche de champ de nom pour filtrer les résultats. |
|
|
Mes requêtes uniquement ?
|
my_queries_only | boolean |
Inclure uniquement les requêtes que j’ai créées ? |
|
|
Requêtes fusionnées uniquement ?
|
merged_queries_only | boolean |
Inclure uniquement des requêtes fusionnées ? |
|
|
Colonne de tri
|
sort_column | string |
Triez les résultats par la colonne spécifiée. |
|
|
Tri décroissant ?
|
sort_descending | boolean |
Trier les résultats dans l’ordre décroissant ? |
|
|
Limit
|
limit | integer |
Représente le nombre d’enregistrements à retourner. La valeur par défaut est 50. Le maximum est de 500. |
|
|
Décalage
|
offset | integer |
Représente le nombre d’enregistrements à ignorer. Pour une utilisation avec la pagination. |
Retours
Queries
Définitions
QueryApi.ExecuteQueryResponse
Travail de requête démarré
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du travail
|
id | string |
Identificateur du travail de requête. |
|
Statut
|
status | string |
État du travail de requête résultant. « En attente » : le travail a été mis en file d’attente, mais n’a pas encore commencé à s’exécuter. 'En cours d’exécution' : le travail est en cours d’exécution. 'Terminé' : le travail s’est terminé avec succès. « Échec » : le travail a échoué. « Annulation » : l’annulation du travail a été demandée (mais peut toujours se terminer avec succès). « Annulé » : le travail a été annulé. « Limité » : le travail a été limité et s’exécute lorsque l’espace est disponible. |
|
Message
|
message | string |
Message associé à la réponse. |
QueryApi.QueryExecutionJob
Travail d’exécution de requête
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du travail
|
id | string |
Identificateur du travail de requête. |
|
Statut
|
status | string |
État du travail de requête résultant. « En attente » : le travail a été mis en file d’attente, mais n’a pas encore commencé à s’exécuter. 'En cours d’exécution' : le travail est en cours d’exécution. 'Terminé' : le travail s’est terminé avec succès. « Échec » : le travail a échoué. « Annulation » : l’annulation du travail a été demandée (mais peut toujours se terminer avec succès). « Annulé » : le travail a été annulé. « Limité » : le travail a été limité et s’exécute lorsque l’espace est disponible. |
|
Nombre de lignes
|
row_count | integer |
Nombre d’enregistrements dans la requête. |
|
URI des résultats de requête
|
sas_uri | string |
URI pour accéder aux résultats de la requête. Cet URI doit être traité comme des informations d’identification sécurisées pour accéder aux résultats de la requête : la valeur est considérée comme sensible et l’URI expire après 15 minutes. |
QueryApi.QuerySummary
Query
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
ID d’enregistrement système de la requête. |
|
Nom
|
name | string |
Nom unique de la requête. |
|
Descriptif
|
description | string |
Description de la requête. |
|
Type
|
type | string |
Type de la requête. |
|
Type ID
|
type_id | integer |
ID d’enregistrement système du type de requête. |
|
Catégorie
|
category | string |
Catégorie de la requête. |
|
ID de catégorie
|
category_id | integer |
ID d’enregistrement système de la catégorie de requête. |
|
Format
|
format | string |
Format de requête. |
|
Affichage pris en charge ?
|
view_supported | boolean |
La requête est-elle visible ? |
|
Modes d’exécution pris en charge
|
supported_execution_modes | string |
Modes d’exécution pris en charge. |
|
Peut-il être modifié ?
|
can_modify | boolean |
L’utilisateur peut-il modifier la requête ? |
|
Peut-il s’exécuter ?
|
can_execute | boolean |
L’utilisateur peut-il exécuter la requête ? |
|
D’autres peuvent modifier ?
|
others_can_modify | boolean |
D’autres utilisateurs peuvent-ils modifier la requête ? |
|
D’autres peuvent s’exécuter ?
|
others_can_execute | boolean |
D’autres utilisateurs peuvent-ils exécuter la requête ? |
|
Supprimer les doublons ?
|
suppress_duplicates | boolean |
Les doublons sont-ils supprimés dans les résultats de la requête ? |
|
Sélectionner dans le nom de la requête
|
select_from_query_name | string |
Nom de la requête utilisée comme sélection de base pour la requête. |
|
Sélectionner à partir de l’ID de requête
|
select_from_query_id | integer |
ID d’enregistrement système de la requête utilisée comme sélection de base pour la requête. |
|
Dernière exécution
|
date_last_run | date-time |
Date de la dernière exécution de la requête. |
|
Nombre d’enregistrements
|
num_records | integer |
Nombre d’enregistrements trouvés la dernière fois que la requête a été exécutée. |
|
Temps écoulé
|
elapsed_ms | integer |
Temps écoulé (en millisecondes) la dernière exécution de la requête. |
|
Date de création
|
date_added | date-time |
Date de création de la requête. |
|
Créé par
|
added_by | string |
Nom de l’utilisateur qui a créé la requête. |
|
Date modifiée
|
date_changed | date-time |
Date de la dernière modification de la requête. |
|
Modifié par
|
last_changed_by | string |
Nom de l’utilisateur qui a modifié la requête pour la dernière fois. |
QueryApi.QuerySummaryCollection
Queries
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Ensemble d’éléments inclus dans la réponse. |