Consulta RENXT de Blackbaud (versión preliminar)
Blackbaud Raiser's Edge EDITION es una completa solución de software de recaudación de fondos y administración de donantes basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad de buena comunidad social. 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-raisers-edge-nxt |
| Directiva de privacidad | https://www.blackbaud.com/privacy-shield |
| Categorías | Ventas y CRM; Productividad |
Raiser's Edge EDITION es una solución completa de software de gestión de donantes y recaudación de fondos basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad social.
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 The Raiser's Edge STORAGE.
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, el administrador de la organización también debe realizar una acción de nivel de administrador dentro del sistema para permitir que este conector acceda al entorno de Blackbaud. 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 edge DE RAISER de raiser 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
| Cancelación de un trabajo de ejecución de consultas |
Actualiza el estado de un trabajo de ejecución de consultas para cancelar. |
| Eliminación de una consulta |
Elimina una consulta. |
| Enumerar consultas |
Devuelve una lista de consultas. |
| Enumerar consultas (v2) |
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. |
Cancelación de un trabajo de ejecución de consultas
Actualiza el estado de un trabajo de ejecución de consultas para cancelar.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del trabajo
|
job_id | True | string |
Identificador de registro del sistema del trabajo de ejecución de consultas que se va a cancelar. |
Devoluciones
Trabajo de consulta iniciado
Eliminación de una consulta
Elimina una consulta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de consulta
|
query_id | True | integer |
Identificador de registro del sistema de la consulta que se va a eliminar. |
Enumerar consultas
Devuelve una lista de consultas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
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? |
|
|
¿Excluir consultas de lista?
|
list_queries | string |
¿Excluir consultas de lista de consultas? |
|
|
Ordenar columna
|
sort_column | string |
Ordene los resultados por la columna especificada. |
|
|
¿Ordena descendente?
|
sort_descending | boolean |
¿Ordena los resultados en orden descendente? |
|
|
Se agregó al
|
date_added | date-time |
Filtre los resultados de las consultas creadas en 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. |
|
|
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
Enumerar consultas (v2)
Devuelve una lista de consultas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
query_type_ids | 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. |
|
|
Diseño de resultados
|
result_layout | string |
Filtre el conjunto de consultas a aquellos con un diseño de resultado 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? |
|
|
¿Excluir consultas de lista?
|
list_queries | string |
¿Excluir consultas de lista de consultas? |
|
|
Ordenar columna
|
sort_column | string |
Ordene los resultados por la columna especificada. |
|
|
¿Ordena descendente?
|
sort_descending | boolean |
¿Ordena los resultados en orden descendente? |
|
|
Se agregó al
|
date_added | date-time |
Filtre los resultados de las consultas creadas en 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. |
|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 50. El máximo es 200. |
|
|
Token de continuación
|
continuation_token | string |
Token de continuación para paginar a través de los resultados. |
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 |
|---|---|---|---|---|
|
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 |
Opcional: el nombre del archivo que se va a descargar, sin la extensión de archivo. Si no se proporciona, el nombre de archivo se generará en función del nombre de la consulta. |
|
|
Diferencia horaria
|
time_zone_offset_in_minutes | integer |
Desplazamiento de zona horaria expresado en minutos. |
|
|
¿Usa descripciones largas?
|
display_code_table_long_description | boolean |
Mostrar entradas de tabla de código por descripción larga (en lugar de una descripción breve)? |
|
|
operator
|
operator | True | string |
Operador de campo de filtro. |
|
values
|
filter_values | array of |
Valores para el filtro (el operador filter determina el número necesario de valores). |
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 |
|---|---|---|---|---|
|
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 |
Opcional: el nombre del archivo que se va a descargar, sin la extensión de archivo. Si no se proporciona, el nombre de archivo se generará en función del nombre de la consulta. |
|
|
Diferencia horaria
|
time_zone_offset_in_minutes | integer |
Desplazamiento de zona horaria expresado en minutos. |
|
|
¿Usa descripciones largas?
|
display_code_table_long_description | boolean |
Mostrar entradas de tabla de código por descripción larga (en lugar de una descripción breve)? |
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 |
|---|---|---|---|---|
|
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. |
|
Diferencia horaria
|
time_zone_offset_in_minutes | integer |
Desplazamiento de zona horaria expresado en minutos. |
|
|
¿Usa descripciones largas?
|
display_code_table_long_description | boolean |
Mostrar entradas de tabla de código por descripción larga (en lugar de una descripción breve)? |
|
|
operator
|
operator | True | string |
Operador de campo de filtro. |
|
values
|
filter_values | array of |
Valores para el filtro (el operador filter determina el número necesario de valores). |
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 |
|---|---|---|---|---|
|
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? |
|
¿Es una lista de consultas?
|
query_list | boolean |
¿La consulta es una consulta de lista de consultas? |
|
¿Suprimir duplicados?
|
suppress_duplicates | boolean |
¿Se suprimen los duplicados en los resultados de la consulta? |
|
tipo
|
output_limit.type | string |
Tipo de límite de salida. |
|
value
|
output_limit.limit | integer |
Número o porcentaje de filas que se van a guardar (según el tipo de límite de salida especificado). |
|
¿Incluir componentes inactivos?
|
constituent_filters.include_inactive | boolean |
¿Incluir componentes inactivos en el procesamiento de consultas? |
|
¿Incluir a los constituyentes fallecidos?
|
constituent_filters.include_deceased | boolean |
¿Incluir componentes fallecidos en el procesamiento de consultas? |
|
¿No se incluyen direcciones válidas?
|
constituent_filters.include_no_valid_addresses | boolean |
¿Incluir componentes sin direcciones válidas en el procesamiento de consultas? |
|
Diseño de resultados
|
result_layout | string | |
|
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. |
|
¿Hay tipos de consulta?
|
any_query_types | boolean |
¿Tiene el usuario acceso a cualquier tipo de consulta? |
|
Count
|
count | integer |
Número total de elementos de la colección antes del límite o desplazamiento. |
|
Limit
|
limit | integer |
Límite de la solicitud de lista. |
|
Desplazar
|
offset | integer |
Desplazamiento en la solicitud de lista. |
QueryApi.QuerySummaryV2Collection
Queries
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Conjunto de elementos incluidos en la respuesta. |
|
¿Hay tipos de consulta?
|
any_query_types | boolean |
¿Tiene el usuario acceso a cualquier tipo de consulta? |
|
Limit
|
limit | integer |
Límite de la solicitud de lista. |
|
Token de continuación
|
continuation_token | string |
Token de continuación para la solicitud de lista. |