Consulta Blackbaud RENXT (Pré-visualização)
O Edge NXT da Blackbaud Raiser é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social. Use o conector de consulta para gerenciar e executar consultas.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Blackbaud |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Editora | Blackbaud. S.A. |
| Sítio Web | 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 angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social do bem.
Este conector é construído sobre a API SKY do Blackbaud e fornece operações para ajudar a gerenciar consultas e entidades relacionadas encontradas no NXT do The Raiser's Edge.
Para mais informações, consulte a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta Blackbaud ID com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação de nível de 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 configuração inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente Raiser's Edge NXT da organização e configurará as permissões da sua conta de utilizador no ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas conhecidos e limitações
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às suas permissões de usuário dentro do ambiente.
Limites de Limitação
| Nome | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Cancelar um trabalho de execução de consulta |
Atualiza o estado de um trabalho de execução de consulta para cancelamento. |
| Consultas de lista (v2) |
Retorna uma lista de consultas. |
| Excluir uma consulta |
Apaga uma consulta. |
| 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 status do trabalho de consulta |
Retorna informações sobre um trabalho de execução de consulta em segundo plano. |
Cancelar um trabalho de execução de consulta
Atualiza o estado de um trabalho de execução de consulta para cancelamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID do trabalho
|
job_id | True | string |
O ID do registo do sistema do trabalho de execução da consulta a cancelar. |
Devoluções
Trabalho de consulta iniciado
Consultas de lista (v2)
Retorna uma lista de consultas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
Tipo
|
query_type_ids | integer |
Filtre o conjunto de consultas para aqueles com um tipo de consulta específico. |
|
|
Categoria
|
category | integer |
Filtre o conjunto de consultas para aquelas com uma categoria específica. |
|
|
Formato
|
query_format | string |
Filtre o conjunto de consultas para aquelas com um formato específico. |
|
|
Disposição dos resultados
|
result_layout | string |
Filtre o conjunto de consultas para aquelas com um layout de resultados 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? |
|
|
Apenas as minhas consultas?
|
my_queries_only | boolean |
Incluir apenas 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? |
|
|
Coluna Ordenar
|
sort_column | string |
Classifique os resultados pela coluna especificada. |
|
|
Ordenar descendente?
|
sort_descending | boolean |
Ordenar os resultados por ordem decrescente? |
|
|
Adicionado
|
date_added | date-time |
Filtre os resultados para consultas criadas na data especificada (ex: '2020-09-18T04:13:56Z'). |
|
|
Adicionado por ID
|
added_by | string |
Filtre os resultados para consultas adicionadas pelo ID de usuário especificado. |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. A predefinição é 50. O máximo é 200. |
|
|
Token de continuação
|
continuation_token | string |
Token de continuação para paginação dos resultados. |
Devoluções
Queries
Excluir uma consulta
Apaga uma consulta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
ID da Consulta
|
query_id | True | integer |
O ID do registo do sistema da consulta a eliminar. |
Iniciar um trabalho de consulta
Inicia um trabalho em segundo plano para executar a consulta especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
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 de saída
|
output_format | string |
Indica o formato de saída para o 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 SQL
|
sql_generation_mode | string |
Indica como os campos de seleção de consulta devem ser tratados. Quando 'Consulta' é selecionado, a saída incluirá os campos de seleção definidos para a consulta mais QRECID. Quando 'Exportar' é selecionado, a saída incluirá os campos de seleção definidos para a consulta APENAS. Quando 'Relatório' é selecionado, a saída incluirá APENAS QRECID. |
|
|
Usa consulta estática?
|
use_static_query_id_set | boolean |
Usar a consulta estática como fonte de registros (caso contrário, a consulta será executada dinamicamente)? |
|
|
Nome do ficheiro
|
results_file_name | string |
Opcional - o nome do ficheiro a descarregar, sem a extensão do ficheiro. Se não for fornecido, o nome do ficheiro será gerado com base no nome da consulta. |
|
|
Deslocamento de fuso horário
|
time_zone_offset_in_minutes | integer |
O deslocamento de fuso horário expresso em minutos. |
|
|
Usar descrições longas?
|
display_code_table_long_description | boolean |
Mostrar as entradas da tabela de códigos por descrição longa (em vez de descrição curta)? |
|
|
operador
|
operator | True | string |
O operador de campo de filtro. |
|
values
|
filter_values | array of |
Valores para o filtro (o operador do filtro determina o número necessário de valores). |
Devoluções
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 | Descrição |
|---|---|---|---|---|
|
Definição de consulta
|
query | True | object |
A representação JSON da definição de consulta. |
|
Formato de saída
|
output_format | string |
Indica o formato de saída para o 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 ficheiro
|
results_file_name | string |
Opcional - o nome do ficheiro a descarregar, sem a extensão do ficheiro. Se não for fornecido, o nome do ficheiro será gerado com base no nome da consulta. |
|
|
Deslocamento de fuso horário
|
time_zone_offset_in_minutes | integer |
O deslocamento de fuso horário expresso em minutos. |
|
|
Usar descrições longas?
|
display_code_table_long_description | boolean |
Mostrar as entradas da tabela de códigos por descrição longa (em vez de descrição curta)? |
Devoluções
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 | Descrição |
|---|---|---|---|---|
|
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. |
|
Deslocamento de fuso horário
|
time_zone_offset_in_minutes | integer |
O deslocamento de fuso horário expresso em minutos. |
|
|
Usar descrições longas?
|
display_code_table_long_description | boolean |
Mostrar as entradas da tabela de códigos por descrição longa (em vez de descrição curta)? |
|
|
operador
|
operator | True | string |
O operador de campo de filtro. |
|
values
|
filter_values | array of |
Valores para o filtro (o operador do filtro determina o número necessário de valores). |
Devoluções
Trabalho de consulta iniciado
Listar consultas
Retorna uma lista de consultas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
|
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 aquelas com uma categoria específica. |
|
|
Formato
|
query_format | string |
Filtre o conjunto de consultas para aquelas 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? |
|
|
Apenas as minhas consultas?
|
my_queries_only | boolean |
Incluir apenas 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? |
|
|
Coluna Ordenar
|
sort_column | string |
Classifique os resultados pela coluna especificada. |
|
|
Ordenar descendente?
|
sort_descending | boolean |
Ordenar os resultados por ordem decrescente? |
|
|
Adicionado
|
date_added | date-time |
Filtre os resultados para consultas criadas na data especificada (ex: '2020-09-18T04:13:56Z'). |
|
|
Adicionado por ID
|
added_by | string |
Filtre os resultados para consultas adicionadas pelo ID de usuário especificado. |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. A predefinição é 50. O máximo é 200. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
Devoluções
Queries
Obter 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 | Descrição |
|---|---|---|---|---|
|
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 o URL no ficheiro de resultados da consulta? |
|
|
Disposição de conteúdo
|
content_disposition | string |
Indica como os resultados da consulta serão exibidos. |
Devoluções
Trabalho de execução de consulta
Definições
QueryApi.ExecuteQueryResponse
Trabalho de consulta iniciado
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ID do trabalho
|
id | string |
O identificador de tarefa de consulta. |
|
Situação
|
status | string |
O status do trabalho de consulta resultante. 'Pendente' - o trabalho foi colocado na fila, mas ainda não começou a ser executado. 'Em execução' - o trabalho está em execução. 'Concluído' - o trabalho concluído com sucesso. 'Falhou' - o trabalho falhou. 'Cancelamento' - o cancelamento do trabalho foi solicitado (mas ainda pode ser concluído com sucesso). 'Cancelado' - o trabalho foi cancelado. 'Acelerado' - o trabalho foi acelerado e será executado quando houver espaço disponível. |
|
Message
|
message | string |
Uma mensagem associada à resposta. |
QueryApi.QueryExecutionJob
Trabalho de execução de consulta
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
ID do trabalho
|
id | string |
O identificador de tarefa de consulta. |
|
Situação
|
status | string |
O status do trabalho de consulta resultante. 'Pendente' - o trabalho foi colocado na fila, mas ainda não começou a ser executado. 'Em execução' - o trabalho está em execução. 'Concluído' - o trabalho concluído com sucesso. 'Falhou' - o trabalho falhou. 'Cancelamento' - o cancelamento do trabalho foi solicitado (mas ainda pode ser concluído com sucesso). 'Cancelado' - o trabalho foi cancelado. 'Acelerado' - o trabalho foi acelerado e será executado quando houver espaço disponível. |
|
Contagem de linhas
|
row_count | integer |
O número de registros na consulta. |
|
URI dos 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 | Descrição |
|---|---|---|---|
|
ID
|
id | integer |
O ID de 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 |
O ID de registro do sistema do tipo de consulta. |
|
Categoria
|
category | string |
A categoria da consulta. |
|
ID da categoria
|
category_id | integer |
A ID de registro do sistema da categoria de consulta. |
|
Formato
|
format | string |
O formato da consulta. |
|
Ver suportado?
|
view_supported | boolean |
A consulta é visível? |
|
Edição suportada?
|
edit_supported | boolean |
A consulta é editável? |
|
É favorito?
|
favorite | boolean |
A consulta é favorita? |
|
Tem campos de pergunta?
|
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 dentro do módulo de consulta? |
|
Modos de execução suportados
|
supported_execution_modes | string |
Os modos de execução suportados. |
|
Pode modificar?
|
can_modify | boolean |
O usuário pode modificar a consulta? |
|
Pode executar?
|
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 executar?
|
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? |
|
tipo
|
output_limit.type | string |
O tipo de limite de saída. |
|
value
|
output_limit.limit | integer |
O número ou percentagem de linhas a guardar (dependendo do tipo de limite de saída especificado). |
|
Incluir constituintes inativos?
|
constituent_filters.include_inactive | boolean |
Incluir constituintes inativos no processamento da consulta? |
|
Incluir eleitores falecidos?
|
constituent_filters.include_deceased | boolean |
Incluir os eleitores falecidos no processamento da consulta? |
|
Não incluir endereços válidos?
|
constituent_filters.include_no_valid_addresses | boolean |
Incluir constituintes sem endereços válidos no processamento da consulta? |
|
Disposição dos resultados
|
result_layout | string | |
|
Selecionar a partir do nome da consulta
|
select_from_query_name | string |
O nome da consulta usada como seleção base para a consulta. |
|
Selecionar a partir do ID da consulta
|
select_from_query_id | integer |
O ID de registro do sistema da consulta usada como 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 registos
|
num_records | integer |
O número de registros encontrados na última vez que a consulta foi executada. |
|
Tempo decorrido
|
elapsed_ms | integer |
O tempo decorrido (em milissegundos) da última vez que a consulta foi executada. |
|
Data de 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 | Descrição |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
O conjunto de itens incluídos na resposta. |
|
Algum tipo de consulta?
|
any_query_types | boolean |
O utilizador tem acesso a algum tipo de consulta? |
|
Contar
|
count | integer |
O número total de itens na coleção antes do limite/deslocamento. |
|
Limite
|
limit | integer |
O limite no pedido de lista. |
|
Compensação
|
offset | integer |
O deslocamento no pedido da lista. |
QueryApi.QuerySummaryV2Collection
Queries
| Nome | Caminho | Tipo | Descrição |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
O conjunto de itens incluídos na resposta. |
|
Algum tipo de consulta?
|
any_query_types | boolean |
O utilizador tem acesso a algum tipo de consulta? |
|
Limite
|
limit | integer |
O limite no pedido de lista. |
|
Token de continuação
|
continuation_token | string |
O token de continuação para o pedido da lista. |