Consulta FENXT de Blackbaud (versión preliminar)
Blackbaud Financial Edge AUTOMÁTICO es una completa solución de software de contabilidad basada en la nube creada específicamente para organizaciones sin ánimo de lucro. Use el conector de consultas para administrar y ejecutar consultas.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Blackbaud |
| URL | https://www.blackbaud.com/support |
| Correo Electrónico | skyapi@blackbaud.com |
| Metadatos del conector | |
|---|---|
| Publicador | Blackbaud. Inc |
| Sitio web | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| Directiva de privacidad | https://www.blackbaud.com/privacy-shield |
| Categorías | Ventas y CRM; Productividad |
Financial Edge AUTOMÁTICO es una solución total de contabilidad en la nube diseñada específicamente para satisfacer las necesidades únicas de organizaciones sin ánimo de lucro y entidades gubernamentales.
Este conector se basa en la API SKY de Blackbaud y proporciona operaciones para ayudar a administrar consultas y entidades relacionadas que se encuentran en Financial Edge STREAM.
Para obtener más información, consulte la documentación.
Prerrequisitos
Para usar este conector, debe tener una cuenta de identificador de Blackbaud con acceso a uno o varios entornos de Blackbaud.
Además, la aplicación Microsoft Power Platform de Blackbaud Marketplace debe estar conectada al entorno. Puede encontrar más información sobre estos requisitos previos en la documentación de configuración inicial .
¿Cómo obtener credenciales?
El administrador de la organización le enviará una invitación al entorno de FINANCIAL Edge STORAGE de la organización y configurará los permisos de la cuenta de usuario dentro del entorno. No se requieren credenciales adicionales para usar este conector.
Problemas y limitaciones conocidos
El conector funcionará en el contexto de la cuenta de usuario y, por tanto, estará sujeto a los permisos de usuario dentro del entorno.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Enumerar consultas |
Devuelve una lista de consultas. |
| Inicio de un trabajo de consulta |
Inicia un trabajo en segundo plano para ejecutar la consulta especificada. |
| Inicio de un trabajo de consulta ad hoc |
Inicia un trabajo en segundo plano para ejecutar la definición de consulta ad hoc especificada. |
| Inicio de un trabajo de consulta estática de actualización |
Inicia un trabajo en segundo plano para actualizar las claves guardadas de la consulta estática especificada. |
| Obtención del estado del trabajo de consulta |
Devuelve información sobre un trabajo de ejecución de consultas en segundo plano. |
Enumerar consultas
Devuelve una lista de consultas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Módulo
|
module | True | string |
Módulo FINANCIAL Edge STREAM para la solicitud. |
|
Tipo
|
query_type_id | integer |
Filtre el conjunto de consultas a aquellos con un tipo de consulta específico. |
|
|
Categoría
|
category | integer |
Filtre el conjunto de consultas a aquellos con una categoría específica. |
|
|
Formato
|
query_format | string |
Filtre el conjunto de consultas a aquellos con un formato específico. |
|
|
Buscar texto
|
search_text | string |
Texto de búsqueda del campo de nombre para filtrar los resultados. |
|
|
¿Solo favoritos?
|
my_fav_queries_only | boolean |
¿Incluye solo consultas favoritas? |
|
|
¿Solo mis consultas?
|
my_queries_only | boolean |
¿Incluye solo las consultas que he creado? |
|
|
¿Solo consultas combinadas?
|
merged_queries_only | boolean |
¿Incluir solo consultas combinadas? |
|
|
Ordenar columna
|
sort_column | string |
Ordene los resultados por la columna especificada. |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados a las consultas creadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
|
|
Agregado por id.
|
added_by | string |
Filtre los resultados a las consultas agregadas por el identificador de usuario especificado. |
|
|
¿Ordena descendente?
|
sort_descending | boolean |
¿Ordena los resultados en orden descendente? |
|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 50. El máximo es 200. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
Devoluciones
Queries
Inicio de un trabajo de consulta
Inicia un trabajo en segundo plano para ejecutar la consulta especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Módulo
|
module | True | string |
Módulo FINANCIAL Edge STREAM para la solicitud. |
|
Tipo
|
v_query_type_id | True | integer |
Filtre el conjunto de consultas a aquellos con un tipo de consulta específico. |
|
Query
|
id | True | integer |
Consulta que se va a ejecutar. |
|
Formato de salida
|
output_format | string |
Indica el formato de salida del archivo de resultados de la consulta. |
|
|
Modo de formato
|
formatting_mode | string |
Indica si y cómo se debe aplicar formato a los resultados de la consulta. |
|
|
Modo de generación de SQL
|
sql_generation_mode | string |
Indica cómo se deben controlar los campos de selección de consultas. Cuando se selecciona "Consulta", la salida incluirá los campos de selección definidos para la consulta más QRECID. Cuando se selecciona "Exportar", la salida incluirá los campos de selección definidos para la consulta SOLO. Cuando se selecciona "Informe", la salida SOLO incluirá QRECID. |
|
|
¿Usar una consulta estática?
|
use_static_query_id_set | boolean |
Use la consulta estática como origen de registros (si no es así, la consulta se ejecutará dinámicamente)? |
|
|
Filename
|
results_file_name | string |
Nombre del archivo que se va a descargar, sin la extensión de archivo. |
Devoluciones
Trabajo de consulta iniciado
Inicio de un trabajo de consulta ad hoc
Inicia un trabajo en segundo plano para ejecutar la definición de consulta ad hoc especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Módulo
|
module | True | string |
Módulo FINANCIAL Edge STREAM para la solicitud. |
|
Definición de consulta
|
query | True | object |
Representación JSON de la definición de consulta. |
|
Formato de salida
|
output_format | string |
Indica el formato de salida del archivo de resultados de la consulta. |
|
|
Modo de formato
|
formatting_mode | string |
Indica si y cómo se debe aplicar formato a los resultados de la consulta. |
|
|
Filename
|
results_file_name | string |
Nombre del archivo que se va a descargar, sin la extensión de archivo. |
Devoluciones
Trabajo de consulta iniciado
Inicio de un trabajo de consulta estática de actualización
Inicia un trabajo en segundo plano para actualizar las claves guardadas de la consulta estática especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Módulo
|
module | True | string |
Módulo FINANCIAL Edge STREAM para la solicitud. |
|
Tipo
|
v_query_type_id | True | integer |
Filtre el conjunto de consultas a aquellos con un tipo de consulta específico. |
|
Query
|
id | True | integer |
Consulta que se va a ejecutar. |
Devoluciones
Trabajo de consulta iniciado
Obtención del estado del trabajo de consulta
Devuelve información sobre un trabajo de ejecución de consultas en segundo plano.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Módulo
|
module | True | string |
Módulo FINANCIAL Edge STREAM para la solicitud. |
|
Id. del trabajo
|
job_id | True | string |
Identificador de registro del sistema del trabajo de ejecución de consultas. |
|
¿Incluye la dirección URL de resultados?
|
include_read_url | string |
¿Incluye la dirección URL al archivo de resultados de la consulta? |
|
|
Disposición de contenido
|
content_disposition | string |
Indica cómo se verán los resultados de la consulta. |
Devoluciones
Trabajo de ejecución de consultas
Definiciones
QueryApi.ExecuteQueryResponse
Trabajo de consulta iniciado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del trabajo
|
id | string |
Identificador del trabajo de consulta. |
|
Estado
|
status | string |
Estado del trabajo de consulta resultante. 'Pendiente': el trabajo se ha puesto en cola, pero aún no se ha iniciado la ejecución. "En ejecución" : el trabajo se está ejecutando. 'Completado': el trabajo se completó correctamente. 'Failed': error en el trabajo. 'Cancelación': se ha solicitado la cancelación del trabajo (pero puede completarse correctamente). 'Cancelado': se canceló el trabajo. "Limitado": el trabajo se ha limitado y se ejecutará cuando haya espacio disponible. |
|
Message
|
message | string |
Mensaje asociado a la respuesta. |
QueryApi.QueryExecutionJob
Trabajo de ejecución de consultas
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del trabajo
|
id | string |
Identificador del trabajo de consulta. |
|
Estado
|
status | string |
Estado del trabajo de consulta resultante. 'Pendiente': el trabajo se ha puesto en cola, pero aún no se ha iniciado la ejecución. "En ejecución" : el trabajo se está ejecutando. 'Completado': el trabajo se completó correctamente. 'Failed': error en el trabajo. 'Cancelación': se ha solicitado la cancelación del trabajo (pero puede completarse correctamente). 'Cancelado': se canceló el trabajo. "Limitado": el trabajo se ha limitado y se ejecutará cuando haya espacio disponible. |
|
Recuento de filas
|
row_count | integer |
Número de registros de la consulta. |
|
URI de resultados de la consulta
|
sas_uri | string |
Identificador URI para acceder a los resultados de la consulta. Este URI debe tratarse como una credencial segura para acceder a los resultados de la consulta: el valor se considera confidencial y el URI expirará después de 15 minutos. |
QueryApi.QuerySummary
Query
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | integer |
Identificador de registro del sistema de la consulta. |
|
Nombre
|
name | string |
Nombre único de la consulta. |
|
Description
|
description | string |
Descripción de la consulta. |
|
Tipo
|
type | string |
Tipo de la consulta. |
|
Identificador de tipo
|
type_id | integer |
Identificador de registro del sistema del tipo de consulta. |
|
Categoría
|
category | string |
Categoría de la consulta. |
|
Id. de categoría
|
category_id | integer |
Identificador de registro del sistema de la categoría de consulta. |
|
Formato
|
format | string |
Formato de consulta. |
|
¿Se admite la vista?
|
view_supported | boolean |
¿Se puede ver la consulta? |
|
¿Editar compatible?
|
edit_supported | boolean |
¿Se puede editar la consulta? |
|
¿Es favorito?
|
favorite | boolean |
¿La consulta es favorita? |
|
¿Tiene campos de preguntas?
|
has_ask_fields | boolean |
¿La consulta incluye campos de filtro con el operador ask? |
|
¿Creado por consulta?
|
created_by_query | boolean |
¿Se creó la consulta en el módulo de consulta? |
|
Modos de ejecución admitidos
|
supported_execution_modes | string |
Los modos de ejecución admitidos. |
|
¿Se puede modificar?
|
can_modify | boolean |
¿El usuario puede modificar la consulta? |
|
¿Se puede ejecutar?
|
can_execute | boolean |
¿El usuario puede ejecutar la consulta? |
|
¿Otros pueden modificar?
|
others_can_modify | boolean |
¿Pueden otros usuarios modificar la consulta? |
|
¿Otros pueden ejecutarse?
|
others_can_execute | boolean |
¿Pueden otros usuarios ejecutar la consulta? |
|
¿Suprimir duplicados?
|
suppress_duplicates | boolean |
¿Se suprimen los duplicados en los resultados de la consulta? |
|
Selección del nombre de la consulta
|
select_from_query_name | string |
Nombre de la consulta usada como selección base para la consulta. |
|
Selección del identificador de consulta
|
select_from_query_id | integer |
Identificador de registro del sistema de la consulta utilizada como selección base para la consulta. |
|
Última ejecución
|
date_last_run | date-time |
Fecha en que se ejecutó por última vez la consulta. |
|
Número de registros
|
num_records | integer |
Número de registros encontrados la última vez que se ejecutó la consulta. |
|
Tiempo transcurrido
|
elapsed_ms | integer |
Tiempo transcurrido (en milisegundos) la última vez que se ejecutó la consulta. |
|
Fecha de creación
|
date_added | date-time |
Fecha en que se creó la consulta. |
|
Creado por
|
added_by | string |
Nombre del usuario que creó la consulta. |
|
Fecha de cambio
|
date_changed | date-time |
Fecha en la que se cambió por última vez la consulta. |
|
Cambiado por
|
last_changed_by | string |
Nombre del usuario que modificó la consulta por última vez. |
QueryApi.QuerySummaryCollection
Queries
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Conjunto de elementos incluidos en la respuesta. |