Blackbaud FENXT 查询（预览版）
Blackbaud Financial Edge NXT 是专为非营利组织构建的综合基于云的会计软件解决方案。 使用查询连接器管理和执行查询。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 联系人 | |
|---|---|
| Name | Blackbaud 支持 |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Blackbaud。 公司 |
| 网站 | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| 隐私策略 | https://www.blackbaud.com/privacy-shield |
| 类别 | 销售和 CRM;生产力 |
Financial Edge NXT 是一个完全云会计解决方案，专为满足非营利组织和政府实体的独特需求而设计。
此连接器基于 Blackbaud 的 SKY API 构建，提供作来帮助管理在 Financial Edge NXT 中找到的查询和相关实体。
有关详细信息，请查看 文档。
先决条件
若要使用此连接器，必须具有一个 Blackbaud ID 帐户，该帐户有权访问一个或多个 Blackbaud 环境。
此外，来自 Blackbaud 市场的 Microsoft Power Platform 应用程序必须连接到环境。 有关这些先决条件的详细信息，请参阅 初始安装 文档。
如何获取凭据？
组织的管理员将向组织的 Financial Edge NXT 环境发送邀请，并在环境中配置用户帐户权限。 使用此连接器不需要其他凭据。
已知问题和限制
连接器将在用户帐户的上下文中运行，因此会受到环境中的用户权限的约束。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 列出查询 |
返回查询列表。 |
| 启动刷新静态查询作业 |
启动后台作业以刷新指定静态查询的已保存密钥。 |
| 启动即席查询作业 |
启动后台作业以执行指定的即席查询定义。 |
| 启动查询作业 |
启动后台作业以执行指定的查询。 |
| 获取查询作业状态 |
返回有关后台查询执行作业的信息。 |
列出查询
返回查询列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模块
|
module | True | string |
请求的 Financial Edge NXT 模块。 |
|
类型
|
query_type_id | integer |
将查询集筛选为具有特定查询类型的查询。 |
|
|
类别
|
category | integer |
筛选具有特定类别的查询集。 |
|
|
Format
|
query_format | string |
筛选具有特定格式的查询集。 |
|
|
搜索文本
|
search_text | string |
用于筛选结果的名称字段搜索文本。 |
|
|
仅收藏夹？
|
my_fav_queries_only | boolean |
仅包含收藏的查询？ |
|
|
仅我的查询？
|
my_queries_only | boolean |
仅包括我创建的查询？ |
|
|
仅合并的查询？
|
merged_queries_only | boolean |
仅包括合并的查询？ |
|
|
排序列
|
sort_column | string |
按指定列对结果进行排序。 |
|
|
在或之后添加
|
date_added | date-time |
将结果筛选为指定日期或之后创建的查询（例如：“2020-09-18T04：13：56Z”）。 |
|
|
按 ID 添加
|
added_by | string |
将结果筛选为指定用户 ID 添加的查询。 |
|
|
降序排序？
|
sort_descending | boolean |
按降序对结果进行排序？ |
|
|
限度
|
limit | integer |
表示要返回的记录数。 默认值为 50。 最大值为 200。 |
|
|
Offset
|
offset | integer |
表示要跳过的记录数。 用于分页。 |
返回
Queries
启动刷新静态查询作业
启动后台作业以刷新指定静态查询的已保存密钥。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模块
|
module | True | string |
请求的 Financial Edge NXT 模块。 |
|
类型
|
v_query_type_id | True | integer |
将查询集筛选为具有特定查询类型的查询。 |
|
Query
|
id | True | integer |
要执行的查询。 |
返回
已启动的查询作业
启动即席查询作业
启动后台作业以执行指定的即席查询定义。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模块
|
module | True | string |
请求的 Financial Edge NXT 模块。 |
|
查询定义
|
query | True | object |
查询定义的 JSON 表示形式。 |
|
输出格式
|
output_format | string |
指示查询结果文件的输出格式。 |
|
|
格式设置模式
|
formatting_mode | string |
指示是否以及如何将格式应用于查询结果。 |
|
|
Filename
|
results_file_name | string |
要下载的文件的名称，不带文件扩展名。 |
返回
已启动的查询作业
启动查询作业
启动后台作业以执行指定的查询。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模块
|
module | True | string |
请求的 Financial Edge NXT 模块。 |
|
类型
|
v_query_type_id | True | integer |
将查询集筛选为具有特定查询类型的查询。 |
|
Query
|
id | True | integer |
要执行的查询。 |
|
输出格式
|
output_format | string |
指示查询结果文件的输出格式。 |
|
|
格式设置模式
|
formatting_mode | string |
指示是否以及如何将格式应用于查询结果。 |
|
|
SQL 生成模式
|
sql_generation_mode | string |
指示应如何处理查询选择字段。 选择“查询”后，输出将包括为查询和 QRECID 定义的选择字段。 选择“导出”后，输出将包含仅为查询定义的选择字段。 选择“报告”后，输出将仅包括 QRECID。 |
|
|
使用静态查询？
|
use_static_query_id_set | boolean |
使用静态查询作为记录源（如果没有，将动态执行查询）？ |
|
|
Filename
|
results_file_name | string |
要下载的文件的名称，不带文件扩展名。 |
返回
已启动的查询作业
获取查询作业状态
返回有关后台查询执行作业的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
模块
|
module | True | string |
请求的 Financial Edge NXT 模块。 |
|
职位编号
|
job_id | True | string |
查询执行作业的系统记录 ID。 |
|
包括结果 URL？
|
include_read_url | string |
包含查询结果文件的 URL？ |
|
|
内容处置
|
content_disposition | string |
指示如何查看查询结果。 |
返回
查询执行作业
定义
QueryApi.ExecuteQueryResponse
已启动的查询作业
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
职位编号
|
id | string |
查询作业标识符。 |
|
状态
|
status | string |
生成的查询作业状态。 “挂起”- 作业已排队，但尚未开始运行。 “正在运行”- 作业正在运行。 “已完成”- 作业成功完成。 “Failed”- 作业失败。 “正在取消”- 已请求作业取消（但仍可能成功完成）。 “已取消”- 作业已取消。 “已限制”- 作业已受到限制，并在可用空间时运行。 |
|
Message
|
message | string |
与响应关联的消息。 |
QueryApi.QueryExecutionJob
查询执行作业
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
职位编号
|
id | string |
查询作业标识符。 |
|
状态
|
status | string |
生成的查询作业状态。 “挂起”- 作业已排队，但尚未开始运行。 “正在运行”- 作业正在运行。 “已完成”- 作业成功完成。 “Failed”- 作业失败。 “正在取消”- 已请求作业取消（但仍可能成功完成）。 “已取消”- 作业已取消。 “已限制”- 作业已受到限制，并在可用空间时运行。 |
|
行计数
|
row_count | integer |
查询中的记录数。 |
|
查询结果 URI
|
sas_uri | string |
用于访问查询结果的 URI。 此 URI 应被视为用于访问查询结果的安全凭据 - 该值被视为敏感，URI 将在 15 分钟后过期。 |
QueryApi.QuerySummary
Query
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
查询的系统记录 ID。 |
|
Name
|
name | string |
查询的唯一名称。 |
|
Description
|
description | string |
查询的说明。 |
|
类型
|
type | string |
查询的类型。 |
|
类型 ID
|
type_id | integer |
查询类型的系统记录 ID。 |
|
类别
|
category | string |
查询的类别。 |
|
类别 ID
|
category_id | integer |
查询类别的系统记录 ID。 |
|
Format
|
format | string |
查询格式。 |
|
是否支持查看？
|
view_supported | boolean |
查询是否可查看？ |
|
支持编辑？
|
edit_supported | boolean |
查询是否可编辑？ |
|
是最喜欢的吗？
|
favorite | boolean |
查询是否是收藏的？ |
|
是否有询问字段？
|
has_ask_fields | boolean |
查询是否包含带有 ask 运算符的筛选器字段？ |
|
由查询创建？
|
created_by_query | boolean |
查询是在查询模块中创建的吗？ |
|
支持的执行模式
|
supported_execution_modes | string |
支持的执行模式。 |
|
是否可以修改？
|
can_modify | boolean |
用户可以修改查询吗？ |
|
是否可以执行？
|
can_execute | boolean |
用户是否可以执行查询？ |
|
其他人可以修改？
|
others_can_modify | boolean |
其他用户是否可以修改查询？ |
|
其他人可以执行？
|
others_can_execute | boolean |
其他用户是否可以执行查询？ |
|
禁止重复项？
|
suppress_duplicates | boolean |
查询结果中是否禁止重复项？ |
|
从查询名称中进行选择
|
select_from_query_name | string |
用作查询基选择的查询的名称。 |
|
从查询 ID 中进行选择
|
select_from_query_id | integer |
用作查询基础选择的查询的系统记录 ID。 |
|
上次运行
|
date_last_run | date-time |
上次运行查询的日期。 |
|
记录数
|
num_records | integer |
上次运行查询时找到的记录数。 |
|
已用时间
|
elapsed_ms | integer |
上次运行查询的时间（以毫秒为单位）。 |
|
创建日期
|
date_added | date-time |
创建查询的日期。 |
|
创建者
|
added_by | string |
创建查询的用户的名称。 |
|
更改日期
|
date_changed | date-time |
上次更改查询的日期。 |
|
更改者
|
last_changed_by | string |
上次更改查询的用户的名称。 |
QueryApi.QuerySummaryCollection
Queries
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
响应中包含的项集。 |