Financial Edge NXT クエリ [非推奨]
Blackbaud Financial Edge NXT は、非営利団体向けに特別に構築されたクラウドベースの包括的な会計ソフトウェア ソリューションです。 クエリ コネクタを使用して、クエリを管理および実行します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Blackbaud のサポート |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Blackbaud。 株式 会社 |
| Website | 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 内で見つかったクエリと関連エンティティを管理するための操作を提供します。
詳細については、 ドキュメントを参照してください。
[前提条件]
このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。
さらに、Blackbaud Marketplace の Microsoft Power Platform アプリケーションを環境に接続する必要があります。 これらの前提条件の詳細については、 初期セットアップ ドキュメントを参照してください。
資格情報を取得する方法
組織の管理者から、組織の Financial Edge NXT 環境への招待が送信され、環境内でユーザー アカウントのアクセス許可が構成されます。 このコネクタを使用するために追加の資格情報は必要ありません。
既知の問題と制限事項
コネクタはユーザー アカウントのコンテキストで動作するため、環境内のユーザーのアクセス許可の対象となります。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アドホック クエリ ジョブを開始する (非推奨) [非推奨] |
指定したアドホック クエリ定義を実行するバックグラウンド ジョブを開始します (非推奨)。 |
| クエリ ジョブの状態を取得する (非推奨) [非推奨] |
バックグラウンド クエリ実行ジョブに関する情報を返します (非推奨)。 |
| クエリ ジョブを開始する (非推奨) [非推奨] |
指定したクエリを実行するバックグラウンド ジョブを開始します (非推奨)。 |
| クエリの一覧表示 (非推奨) [非推奨] |
クエリの一覧を返します (非推奨)。 |
| 更新静的クエリ ジョブを開始する (非推奨) [非推奨] |
バックグラウンド ジョブを開始して、指定した静的クエリの保存済みキーを更新します (非推奨)。 |
アドホック クエリ ジョブを開始する (非推奨) [非推奨]
指定したアドホック クエリ定義を実行するバックグラウンド ジョブを開始します (非推奨)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール
|
module | True | string |
要求の Financial Edge NXT モジュール。 |
|
クエリ定義
|
query | True | object |
クエリ定義の JSON 表現。 |
|
出力形式
|
output_format | string |
クエリ結果ファイルの出力形式を示します。 |
|
|
書式設定モード
|
formatting_mode | string |
クエリ結果に書式を適用するかどうかを示します。 |
戻り値
クエリ ジョブの開始
クエリ ジョブの状態を取得する (非推奨) [非推奨]
バックグラウンド クエリ実行ジョブに関する情報を返します (非推奨)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール
|
module | True | string |
要求の Financial Edge NXT モジュール。 |
|
職務 ID
|
job_id | True | string |
クエリ実行ジョブのシステム レコード ID。 |
|
結果の URL を含めますか?
|
include_read_url | string |
クエリ結果ファイルの URL を含めますか? |
|
|
コンテンツの処理
|
content_disposition | 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 |
静的クエリをレコードのソースとして使用します (そうでない場合、クエリは動的に実行されます)。 |
戻り値
クエリ ジョブの開始
クエリの一覧表示 (非推奨) [非推奨]
クエリの一覧を返します (非推奨)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール
|
module | True | string |
要求の Financial Edge NXT モジュール。 |
|
タイプ
|
query_type_id | integer |
クエリのセットを、特定のクエリの種類のクエリにフィルター処理します。 |
|
|
カテゴリ
|
category | integer |
特定のカテゴリを持つクエリのセットをフィルター処理します。 |
|
|
Format
|
query_format | string |
クエリのセットを特定の形式のクエリにフィルター処理します。 |
|
|
テキストを検索する
|
search_text | string |
結果をフィルター処理する名前フィールドの検索テキスト。 |
|
|
クエリのみ?
|
my_queries_only | boolean |
作成したクエリのみを含めますか? |
|
|
マージされたクエリのみ?
|
merged_queries_only | boolean |
マージされたクエリのみを含めますか? |
|
|
列の並べ替え
|
sort_column | string |
指定した列で結果を並べ替えます。 |
|
|
降順で並べ替えますか?
|
sort_descending | boolean |
結果を降順に並べ替えますか? |
|
|
極限
|
limit | integer |
返すレコードの数を表します。 既定値は 50 です。 最大値は 500 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコードの数を表します。 改ページ位置付けで使用します。 |
戻り値
Queries
更新静的クエリ ジョブを開始する (非推奨) [非推奨]
バックグラウンド ジョブを開始して、指定した静的クエリの保存済みキーを更新します (非推奨)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール
|
module | True | string |
要求の Financial Edge NXT モジュール。 |
|
タイプ
|
v_query_type_id | True | integer |
クエリのセットを、特定のクエリの種類のクエリにフィルター処理します。 |
|
Query
|
id | True | integer |
実行するクエリ。 |
戻り値
クエリ ジョブの開始
定義
QueryApi.ExecuteQueryResponse
クエリ ジョブの開始
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
職務 ID
|
id | string |
クエリ ジョブ識別子。 |
|
ステータス
|
status | string |
結果のクエリ ジョブの状態。 "保留中" - ジョブはキューに登録されていますが、まだ実行を開始していません。 "実行中" - ジョブが実行されています。 'Completed' - ジョブが正常に完了しました。 'Failed' - ジョブが失敗しました。 'Cancelling' - ジョブの取り消しが要求されました (ただし、正常に完了する可能性があります)。 'Cancelled' - ジョブが取り消されました。 "調整済み" - ジョブが調整され、空き領域が使用可能になると実行されます。 |
|
メッセージ
|
message | string |
応答に関連付けられているメッセージ。 |
QueryApi.QueryExecutionJob
クエリ実行ジョブ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
職務 ID
|
id | string |
クエリ ジョブ識別子。 |
|
ステータス
|
status | string |
結果のクエリ ジョブの状態。 "保留中" - ジョブはキューに登録されていますが、まだ実行を開始していません。 "実行中" - ジョブが実行されています。 'Completed' - ジョブが正常に完了しました。 'Failed' - ジョブが失敗しました。 'Cancelling' - ジョブの取り消しが要求されました (ただし、正常に完了する可能性があります)。 'Cancelled' - ジョブが取り消されました。 "調整済み" - ジョブが調整され、空き領域が使用可能になると実行されます。 |
|
行数
|
row_count | integer |
クエリ内のレコードの数。 |
|
クエリ結果 URI
|
sas_uri | string |
クエリ結果にアクセスするための URI。 この URI は、クエリ結果にアクセスするためのセキュリティで保護された資格情報として扱う必要があります。値は機密性が高いと見なされ、URI は 15 分後に期限切れになります。 |
QueryApi.QuerySummary
Query
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
クエリのシステム レコード ID。 |
|
名前
|
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 |
クエリは表示可能ですか? |
|
サポートされている実行モード
|
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 |
応答に含まれる項目のセット。 |