Blackbaud FENXT 查詢 （預覽版）
Blackbaud Financial Edge NXT 是一款專為非營利組織打造的綜合性雲端會計軟體解決方案。 使用查詢連接器來管理和執行查詢。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | Blackbaud 支持 |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 布萊克博德。 公司 |
| 網站 | https://www.blackbaud.com/products/blackbaud-financial-edge-nxt |
| 隱私策略 | https://www.blackbaud.com/privacy-shield |
| 類別 | 銷售和客戶關係管理;生產力 |
Financial Edge NXT 是一款專為非營利組織打造的綜合性雲端會計軟體解決方案。
此連接器建立在 Blackbaud 的 SKY API 之上，並提供操作以協助管理 The Financial Edge NXT 中查詢及相關實體。
如需詳細資訊，請檢視 文件。
先決條件
若要使用此連接器，您必須擁有 Blackbaud ID 帳戶，才能存取一或多個 Blackbaud 環境。
此外，您組織的管理員還必須在系統內執行管理員層級動作，才能讓此連接器存取您的 Blackbaud 環境。 有關這些先決條件的詳細資訊，請參閱 初始設定 文件。
如何取得憑證？
您組織的管理員將向您發送組織的 Financial Edge NXT 環境的邀請，並在環境中配置您的使用者帳戶權限。 使用此連接器不需要其他認證。
已知問題與限制
連接器將在您的使用者帳戶的內容中運作，因此將受限於您在環境中的使用者權限。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 列表查詢（v2） |
傳回查詢清單。 |
| 刪除查詢 |
刪除查詢。 |
| 取得查詢作業狀態 |
傳回背景查詢執行工作的相關資訊。 |
| 取消查詢執行工作 |
更新查詢執行工作的狀態為取消中。 |
| 啟動查詢任務 |
啟動背景工作以執行指定的查詢。 |
| 啟動臨機操作查詢作業 |
啟動背景工作以執行指定的臨機操作查詢定義。 |
| 啟動重新整理靜態查詢工作 |
啟動背景工作，以重新整理指定靜態查詢的已儲存索引鍵。 |
| 清單查詢 |
傳回查詢清單。 |
列表查詢（v2）
傳回查詢清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
類型
|
query_type_ids | integer |
將查詢集篩選為具有特定查詢類型的查詢集。 |
|
|
類別
|
category | integer |
將查詢集篩選為具有特定類別的查詢集。 |
|
|
格式
|
query_format | string |
將查詢集篩選為具有特定格式的查詢集。 |
|
|
結果版面
|
result_layout | string |
將查詢集篩選為具有特定結果配置的查詢。 |
|
|
搜尋文字
|
search_text | string |
用於篩選結果的名稱欄位搜尋文字。 |
|
|
僅收藏夾？
|
my_fav_queries_only | boolean |
只包含最喜歡的查詢？ |
|
|
只有我的疑問？
|
my_queries_only | boolean |
只包含我建立的查詢？ |
|
|
僅合併查詢？
|
merged_queries_only | boolean |
只包含合併的查詢？ |
|
|
排除清單查詢？
|
list_queries | string |
排除查詢清單查詢？ |
|
|
排序欄
|
sort_column | string |
依指定的欄排序結果。 |
|
|
降序排序？
|
sort_descending | boolean |
按降序對結果進行排序？ |
|
|
新增內容
|
date_added | date-time |
將結果篩選到指定日期建立的查詢（例如：'2020-09-18T04：13：56Z'）。 |
|
|
按 ID 添加
|
added_by | string |
將結果篩選為指定使用者 ID 所新增的查詢。 |
|
|
限制
|
limit | integer |
代表要傳回的記錄數目。 預設值為 50。 最大值為 200。 |
|
|
接續權杖
|
continuation_token | string |
繼續權杖用於翻頁結果。 |
傳回
Queries
刪除查詢
刪除查詢。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
查詢識別碼
|
query_id | True | integer |
系統記錄查詢的 ID。 |
取得查詢作業狀態
傳回背景查詢執行工作的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
作業識別碼
|
job_id | True | string |
查詢執行工作的系統記錄 ID。 |
|
包含結果 URL？
|
include_read_url | string |
包含查詢結果檔案的 URL？ |
|
|
內容處置
|
content_disposition | string |
指出查詢結果的檢視方式。 |
傳回
查詢執行作業
取消查詢執行工作
更新查詢執行工作的狀態為取消中。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
作業識別碼
|
job_id | True | string |
系統記錄查詢執行工作的 ID，以進行取消。 |
傳回
已啟動查詢作業
啟動查詢任務
啟動背景工作以執行指定的查詢。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
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 |
使用靜態查詢作為記錄的來源（如果沒有，則動態執行查詢）？ |
|
|
檔名
|
results_file_name | string |
可選 - 要下載的檔案名稱，但不含副檔名。 若未提供，檔案名稱將根據查詢名稱產生。 |
|
|
時區位移
|
time_zone_offset_in_minutes | integer |
時區偏移量以分鐘表示。 |
|
|
要用長篇描述嗎？
|
display_code_table_long_description | boolean |
用長描述來顯示程式碼表條目（而不是簡短描述）？ |
|
|
操作員
|
operator | True | string |
濾波場運算子。 |
|
values
|
filter_values | array of |
濾波器的值（濾波器運算子決定所需的數值）。 |
傳回
已啟動查詢作業
啟動臨機操作查詢作業
啟動背景工作以執行指定的臨機操作查詢定義。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
查詢定義
|
query | True | object |
查詢定義的 JSON 表示法。 |
|
輸出格式
|
output_format | string |
指出查詢結果檔案的輸出格式。 |
|
|
格式化模式
|
formatting_mode | string |
指出是否以及如何將格式套用至查詢結果。 |
|
|
檔名
|
results_file_name | string |
可選 - 要下載的檔案名稱，但不含副檔名。 若未提供，檔案名稱將根據查詢名稱產生。 |
|
|
時區位移
|
time_zone_offset_in_minutes | integer |
時區偏移量以分鐘表示。 |
|
|
要用長篇描述嗎？
|
display_code_table_long_description | boolean |
用長描述來顯示程式碼表條目（而不是簡短描述）？ |
傳回
已啟動查詢作業
啟動重新整理靜態查詢工作
啟動背景工作，以重新整理指定靜態查詢的已儲存索引鍵。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
類型
|
v_query_type_id | True | integer |
將查詢集篩選為具有特定查詢類型的查詢集。 |
|
Query
|
id | True | integer |
要執行的查詢。 |
|
時區位移
|
time_zone_offset_in_minutes | integer |
時區偏移量以分鐘表示。 |
|
|
要用長篇描述嗎？
|
display_code_table_long_description | boolean |
用長描述來顯示程式碼表條目（而不是簡短描述）？ |
|
|
操作員
|
operator | True | string |
濾波場運算子。 |
|
values
|
filter_values | array of |
濾波器的值（濾波器運算子決定所需的數值）。 |
傳回
已啟動查詢作業
清單查詢
傳回查詢清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模組
|
module | True | string |
請求的 Financial Edge NXT 模組。 |
|
類型
|
query_type_id | integer |
將查詢集篩選為具有特定查詢類型的查詢集。 |
|
|
類別
|
category | integer |
將查詢集篩選為具有特定類別的查詢集。 |
|
|
格式
|
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
定義
QueryApi.ExecuteQuery回應
已啟動查詢作業
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作業識別碼
|
id | string |
查詢工作識別碼。 |
|
地位
|
status | string |
產生的查詢任務狀態。 '擱置中' - 工作已排入佇列，但尚未開始執行。 '正在執行中' - 工作正在執行中。 「已完成」 - 工作已順利完成。 'Failed' - 工作失敗。 '取消' - 已要求作業取消 （但仍可能順利完成）。 '已取消' - 工作已取消。 '節流' - 作業已節流，並在空間可用時執行。 |
|
Message
|
message | string |
與回應相關聯的訊息。 |
QueryApi.QueryExecutionJob
查詢執行作業
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作業識別碼
|
id | string |
查詢工作識別碼。 |
|
地位
|
status | string |
產生的查詢任務狀態。 '擱置中' - 工作已排入佇列，但尚未開始執行。 '正在執行中' - 工作正在執行中。 「已完成」 - 工作已順利完成。 'Failed' - 工作失敗。 '取消' - 已要求作業取消 （但仍可能順利完成）。 '已取消' - 工作已取消。 '節流' - 作業已節流，並在空間可用時執行。 |
|
資料列計數
|
row_count | integer |
查詢中的記錄數。 |
|
查詢結果 URI
|
sas_uri | string |
用於存取查詢結果的 URI。 此 URI 應被視為存取查詢結果的安全認證 - 該值被視為敏感值，並且 URI 將在 15 分鐘後過期。 |
QueryApi.QuerySummary
Query
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
查詢的系統記錄 ID。 |
|
名稱
|
name | string |
查詢的唯一名稱。 |
|
Description
|
description | string |
查詢的說明。 |
|
類型
|
type | string |
查詢的類型。 |
|
類型 ID
|
type_id | integer |
查詢類型的系統記錄 ID。 |
|
類別
|
category | string |
查詢的類別。 |
|
類別標識碼
|
category_id | integer |
查詢類別的系統記錄 ID。 |
|
格式
|
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 |
查詢結果中是否隱藏重複項？ |
|
型別
|
output_limit.type | string |
輸出限制型態。 |
|
value
|
output_limit.limit | integer |
需儲存的列數或百分比（依據指定的輸出限制類型）。 |
|
結果版面
|
result_layout | string | |
|
從查詢名稱選取
|
select_from_query_name | string |
用作查詢基本選取的查詢名稱。 |
|
從查詢識別碼中選取
|
select_from_query_id | integer |
用作查詢基本選取項之查詢的系統記錄識別碼。 |
|
上次執行
|
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.QuerySummary集合
Queries
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
回應中包含的專案集。 |
|
有查詢類型嗎？
|
any_query_types | boolean |
使用者有權限使用任何查詢類型嗎？ |
|
計數
|
count | integer |
收藏中在限制/抵銷前的總項目數量。 |
|
限制
|
limit | integer |
清單請求的上限。 |
|
Offset
|
offset | integer |
清單上的抵銷請求。 |
QueryApi.QuerySummaryV2Collection
Queries
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
回應中包含的專案集。 |
|
有查詢類型嗎？
|
any_query_types | boolean |
使用者有權限使用任何查詢類型嗎？ |
|
限制
|
limit | integer |
清單請求的上限。 |
|
延續權杖
|
continuation_token | string |
清單請求的續寫令牌。 |