Consulta RENXT blackbaud (versão prévia)
O Blackbaud Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector de consulta para gerenciar e executar consultas.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Blackbaud |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Publicador | Blackbaud. Inc |
| Site | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Política de privacidade | https://www.blackbaud.com/privacy-shield |
| Categorias | Vendas e CRM; Produtividade |
O Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social.
Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar consultas e entidades relacionadas encontradas no NXT de Borda do Raiser.
Para obter mais informações, veja a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta de ID do Blackbaud com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação no nível do administrador dentro do sistema para permitir que esse conector acesse seu ambiente blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de instalação inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente do Raiser's Edge NXT da organização e configurará suas permissões de conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas e limitações conhecidos
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às permissões do usuário dentro do ambiente.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Iniciar um trabalho de consulta |
Inicia um trabalho em segundo plano para executar a consulta especificada. |
| Iniciar um trabalho de consulta ad hoc |
Inicia um trabalho em segundo plano para executar a definição de consulta ad hoc especificada. |
| Iniciar um trabalho de consulta estática de atualização |
Inicia um trabalho em segundo plano para atualizar as chaves salvas para a consulta estática especificada. |
| Listar consultas |
Retorna uma lista de consultas. |
| Obter o status do trabalho de consulta |
Retorna informações sobre um trabalho de execução de consulta em segundo plano. |
Iniciar um trabalho de consulta
Inicia um trabalho em segundo plano para executar a consulta especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
v_query_type_id | True | integer |
Filtre o conjunto de consultas para aqueles com um tipo de consulta específico. |
|
Query
|
id | True | integer |
A consulta a ser executada. |
|
Formato da saída
|
output_format | string |
Indica o formato de saída do arquivo de resultados da consulta. |
|
|
Modo de formatação
|
formatting_mode | string |
Indica se e como a formatação deve ser aplicada aos resultados da consulta. |
|
|
Modo de geração do SQL
|
sql_generation_mode | string |
Indica como os campos de seleção de consulta devem ser tratados. Quando 'Query' é selecionado, a saída incluirá os campos selecionados definidos para a consulta mais QRECID. Quando 'Exportar' for selecionado, a saída incluirá os campos selecionados definidos apenas para a consulta. Quando 'Report' for selecionado, a saída incluirá APENAS QRECID. |
|
|
Usar consulta estática?
|
use_static_query_id_set | boolean |
Usar a consulta estática como a origem dos registros (caso contrário, a consulta será executada dinamicamente)? |
|
|
Nome do Arquivo
|
results_file_name | string |
O nome do arquivo a ser baixado, sem a extensão de arquivo. |
Retornos
Trabalho de consulta iniciado
Iniciar um trabalho de consulta ad hoc
Inicia um trabalho em segundo plano para executar a definição de consulta ad hoc especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Definição de consulta
|
query | True | object |
A representação JSON da definição de consulta. |
|
Formato da saída
|
output_format | string |
Indica o formato de saída do arquivo de resultados da consulta. |
|
|
Modo de formatação
|
formatting_mode | string |
Indica se e como a formatação deve ser aplicada aos resultados da consulta. |
|
|
Nome do Arquivo
|
results_file_name | string |
O nome do arquivo a ser baixado, sem a extensão de arquivo. |
Retornos
Trabalho de consulta iniciado
Iniciar um trabalho de consulta estática de atualização
Inicia um trabalho em segundo plano para atualizar as chaves salvas para a consulta estática especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
v_query_type_id | True | integer |
Filtre o conjunto de consultas para aqueles com um tipo de consulta específico. |
|
Query
|
id | True | integer |
A consulta a ser executada. |
Retornos
Trabalho de consulta iniciado
Listar consultas
Retorna uma lista de consultas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo
|
query_type_id | integer |
Filtre o conjunto de consultas para aqueles com um tipo de consulta específico. |
|
|
Categoria
|
category | integer |
Filtre o conjunto de consultas para aqueles com uma categoria específica. |
|
|
Formato
|
query_format | string |
Filtre o conjunto de consultas para aqueles com um formato específico. |
|
|
Pesquisar texto
|
search_text | string |
O texto de pesquisa do campo de nome para filtrar os resultados. |
|
|
Apenas favoritos?
|
my_fav_queries_only | boolean |
Incluir apenas consultas favoritas? |
|
|
Só minhas consultas?
|
my_queries_only | boolean |
Incluir somente consultas que criei? |
|
|
Somente consultas mescladas?
|
merged_queries_only | boolean |
Incluir apenas consultas mescladas? |
|
|
Excluir consultas de lista?
|
list_queries | string |
Excluir consultas da Lista de Consultas? |
|
|
Classificar coluna
|
sort_column | string |
Classifique os resultados pela coluna especificada. |
|
|
Classificação decrescente?
|
sort_descending | boolean |
Classificar os resultados em ordem decrescente? |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para consultas criadas em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
Adicionado por ID
|
added_by | string |
Filtre os resultados para consultas adicionadas pela ID de usuário especificada. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 50. O máximo é 200. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Queries
Obter o status do trabalho de consulta
Retorna informações sobre um trabalho de execução de consulta em segundo plano.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
A ID de registro do sistema do trabalho de execução da consulta. |
|
Incluir URL de resultados?
|
include_read_url | string |
Incluir a URL no arquivo de resultados da consulta? |
|
|
Disposição de conteúdo
|
content_disposition | string |
Indica como os resultados da consulta serão exibidos. |
Retornos
Trabalho de execução de consulta
Definições
QueryApi.ExecuteQueryResponse
Trabalho de consulta iniciado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do trabalho
|
id | string |
O identificador do trabalho de consulta. |
|
Situação
|
status | string |
O status do trabalho de consulta resultante. 'Pendente' - o trabalho foi enfileirado, mas ainda não começou a ser executado. 'Running' – o trabalho está em execução. 'Concluído' – o trabalho foi concluído com êxito. 'Falha' – o trabalho falhou. 'Cancelando' – o cancelamento do trabalho foi solicitado (mas ainda pode ser concluído com êxito). 'Cancelado' - o trabalho foi cancelado. 'Limitado' - o trabalho foi limitado e será executado quando o espaço estiver disponível. |
|
Message
|
message | string |
Uma mensagem associada à resposta. |
QueryApi.QueryExecutionJob
Trabalho de execução de consulta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do trabalho
|
id | string |
O identificador do trabalho de consulta. |
|
Situação
|
status | string |
O status do trabalho de consulta resultante. 'Pendente' - o trabalho foi enfileirado, mas ainda não começou a ser executado. 'Running' – o trabalho está em execução. 'Concluído' – o trabalho foi concluído com êxito. 'Falha' – o trabalho falhou. 'Cancelando' – o cancelamento do trabalho foi solicitado (mas ainda pode ser concluído com êxito). 'Cancelado' - o trabalho foi cancelado. 'Limitado' - o trabalho foi limitado e será executado quando o espaço estiver disponível. |
|
Contagem de linhas
|
row_count | integer |
O número de registros na consulta. |
|
URI de resultados da consulta
|
sas_uri | string |
O URI para acessar os resultados da consulta. Esse URI deve ser tratado como uma credencial segura para acessar os resultados da consulta - o valor é considerado confidencial e o URI expirará após 15 minutos. |
QueryApi.QuerySummary
Query
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID do registro do sistema da consulta. |
|
Nome
|
name | string |
O nome exclusivo da consulta. |
|
Description
|
description | string |
A descrição da consulta. |
|
Tipo
|
type | string |
O tipo da consulta. |
|
ID do tipo
|
type_id | integer |
A ID do registro do sistema do tipo de consulta. |
|
Categoria
|
category | string |
A categoria da consulta. |
|
ID da categoria
|
category_id | integer |
A ID do registro do sistema da categoria de consulta. |
|
Formato
|
format | string |
O formato de consulta. |
|
Exibição com suporte?
|
view_supported | boolean |
A consulta pode ser visualizada? |
|
Editar com suporte?
|
edit_supported | boolean |
A consulta é editável? |
|
É favorito?
|
favorite | boolean |
A consulta é uma das favoritas? |
|
Perguntou campos?
|
has_ask_fields | boolean |
A consulta inclui campos de filtro com o operador ask? |
|
Criado por consulta?
|
created_by_query | boolean |
A consulta foi criada no módulo de consulta? |
|
Modos de execução com suporte
|
supported_execution_modes | string |
Os modos de execução com suporte. |
|
Pode modificar?
|
can_modify | boolean |
O usuário pode modificar a consulta? |
|
Pode ser executado?
|
can_execute | boolean |
O usuário pode executar a consulta? |
|
Outros podem modificar?
|
others_can_modify | boolean |
Outros usuários podem modificar a consulta? |
|
Outros podem ser executados?
|
others_can_execute | boolean |
Outros usuários podem executar a consulta? |
|
Uma lista de consultas?
|
query_list | boolean |
A consulta é uma consulta de Lista de Consultas? |
|
Suprimir duplicatas?
|
suppress_duplicates | boolean |
As duplicatas são suprimidas nos resultados da consulta? |
|
Selecione entre o nome da consulta
|
select_from_query_name | string |
O nome da consulta usada como a seleção base para a consulta. |
|
Selecionar na ID da consulta
|
select_from_query_id | integer |
A ID do registro do sistema da consulta usada como a seleção base para a consulta. |
|
Última execução
|
date_last_run | date-time |
A data em que a consulta foi executada pela última vez. |
|
Número de registros
|
num_records | integer |
O número de registros encontrado na última vez em que a consulta foi executada. |
|
Tempo decorrido
|
elapsed_ms | integer |
O tempo decorrido (em milissegundos) na última vez em que a consulta foi executada. |
|
Data da criação
|
date_added | date-time |
A data em que a consulta foi criada. |
|
Criado por
|
added_by | string |
O nome do usuário que criou a consulta. |
|
Data alterada
|
date_changed | date-time |
A data em que a consulta foi alterada pela última vez. |
|
Alterado por
|
last_changed_by | string |
O nome do usuário que alterou a consulta pela última vez. |
QueryApi.QuerySummaryCollection
Queries
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
O conjunto de itens incluídos na resposta. |