Blackbaud Raisers Edge NXT Interactions
Blackbaud Raiser の Edge NXT は、非営利団体およびソーシャルグッド コミュニティ全体に特化して構築された、クラウドベースの包括的な資金調達および寄付者管理ソフトウェア ソリューションです。 Interactions コネクタを使用して、構成アクションを管理します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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, Inc. |
| Website | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| プライバシー ポリシー | https://www.blackbaud.com/privacy-shield |
| カテゴリ | 販売および CRM;生産性 |
Raiser's Edge NXT は、非営利団体やソーシャルグッド コミュニティ全体に特化して構築された、クラウドベースの包括的な資金調達および寄付者管理ソフトウェア ソリューションです。
このコネクタは Blackbaud の SKY API 上に構築され、次のような、The Raiser の Edge NXT 内の構成要素の相互運用と関連エンティティを管理するための操作を提供します。
- アクション
- アクションのユーザー設定フィールド
- アクションの添付ファイル
- その他...
詳細については、 ドキュメントを参照してください。
[前提条件]
このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。
さらに、このコネクタが Blackbaud 環境にアクセスできるようにするには、組織の管理者がシステム内で管理者レベルのアクションを実行する必要もあります。 これらの前提条件の詳細については、 初期セットアップ ドキュメントを参照してください。
資格情報を取得する方法
組織の管理者から組織の Raiser の Edge NXT 環境への招待が送信され、環境内でユーザー アカウントのアクセス許可が構成されます。 このコネクタを使用するために追加の資格情報は必要ありません。
既知の問題と制限事項
コネクタはユーザー アカウントのコンテキストで動作するため、環境内のユーザーのアクセス許可の対象となります。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アクションのユーザー設定フィールドを一覧表示する |
アクションのユーザー設定フィールドを一覧表示します。 |
| アクションのユーザー設定フィールドを作成する |
新しいアクションユーザー設定フィールドを作成します。 |
| アクションのユーザー設定フィールドを更新する |
アクションのユーザー設定フィールドを更新します。 |
| アクションの添付ファイルを一覧表示する |
アクションの添付ファイルを一覧表示します。 |
| アクションの添付ファイルを作成する |
新しいアクションの添付ファイルを作成します。 |
| アクションの添付ファイルを更新する |
アクションの添付ファイルを更新します。 |
| アクションを一覧表示する |
アクションの一覧を返します。 |
| 構成アクションを一覧表示する |
構成要素のアクションを一覧表示します。 |
| 構成アクションを作成する |
新しい構成アクションを作成します。 |
| 構成アクションを取得する |
構成アクションに関する情報を返します。 |
| 構成アクションを更新する |
構成アクションを更新します。 |
アクションのユーザー設定フィールドを一覧表示する
アクションのユーザー設定フィールドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作 ID
|
action_id | True | string |
アクションのシステム レコード ID。 |
戻り値
カスタム フィールド
アクションのユーザー設定フィールドを作成する
新しいアクションユーザー設定フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
作成するユーザー設定フィールドを表すオブジェクト。 |
戻り値
作成されたアクションのユーザー設定フィールド
アクションのユーザー設定フィールドを更新する
アクションのユーザー設定フィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー設定フィールド ID
|
custom_field_id | True | string |
更新するユーザー設定フィールドのシステム レコード ID。 |
|
body
|
body | True | dynamic |
更新するユーザー設定フィールドのプロパティを表すオブジェクト。 |
アクションの添付ファイルを一覧表示する
アクションの添付ファイルを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作 ID
|
action_id | True | string |
アクションのシステム レコード ID。 |
戻り値
Attachments
アクションの添付ファイルを作成する
新しいアクションの添付ファイルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作 ID
|
parent_id | True | string |
添付ファイルに関連付けられているアクションのシステム レコード ID。 |
|
タイプ
|
type | True | string |
添付ファイルの種類。 物理的な添付ファイルは、ローカルまたはネットワーク上に保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに格納および管理されます。 リンク添付ファイルは、オンラインまたはクラウド ストレージ アカウント内の画像、ブログ投稿、YouTube ビデオなどのファイルへのリンクです。 これらは外部に格納および管理されます。 |
|
名前
|
name | string |
添付ファイルの名前。 文字制限: 150。 |
|
|
日付
|
date | date-time |
添付ファイルの日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日付と時刻に設定されます。 |
|
|
URL
|
url | string |
添付ファイルの URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。 |
|
|
ファイル名
|
file_name | string |
ファイルの名前。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
|
ファイル ID
|
file_id | string |
ファイルの識別子。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
|
サムネイル ID
|
thumbnail_id | string |
サムネイルの識別子。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
|
タグ
|
tags | array of string |
添付ファイルに関連付けられているタグ。 |
戻り値
作成されたアクションの添付ファイル
アクションの添付ファイルを更新する
アクションの添付ファイルを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
添付ファイル ID
|
attachment_id | True | string |
更新する添付ファイルのシステム レコード ID。 |
|
名前
|
name | string |
添付ファイルの名前。 文字制限: 150。 |
|
|
日付
|
date | date-time |
添付ファイルの日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
URL
|
url | string |
添付ファイルの URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。 |
|
|
タグ
|
tags | array of string |
添付ファイルに関連付けられているタグ。 |
アクションを一覧表示する
アクションの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧
|
list_id | string |
指定したリストに含まれるアクションのセットをフィルター処理するために使用するリスト識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。 |
|
|
計算された状態
|
computed_status | string |
計算されたアクションの状態に基づく結果のフィルターを表します。 使用可能な値は、Open、Completed、または PastDue です。 |
|
|
ステータス
|
status_code | string |
結果をフィルター処理するアクション状態コードを表します (システムがアクション状態コードを使用するように構成されている場合にのみ適用されます)。 たとえば、"Pending" は状態が "Pending" のアクションを返します。 |
|
|
極限
|
limit | integer |
返すレコードの数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコードの数を表します。 改ページ位置付けで使用します。 |
|
|
追加日または後
|
date_added | date-time |
指定した日付以降に作成されたアクションに結果をフィルター処理します (例: '2020-09-18T04:13:56Z')。 |
|
|
変更後
|
last_modified | date-time |
指定した日付以降に変更されたアクションに結果をフィルター処理します (例: '2020-09-18T04:13:56Z')。 |
戻り値
アクション
構成アクションを一覧表示する
構成要素のアクションを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
構成要素 ID
|
constituent_id | True | string |
構成のシステム レコード ID。 |
戻り値
アクション
構成アクションを作成する
新しい構成アクションを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
構成要素 ID
|
constituent_id | True | string |
アクションに関連付けられている構成要素のシステム レコード ID。 |
|
日付
|
date | True | date-time |
アクションの日付 (例: '2020-09-18T04:13:56Z')。 |
|
カテゴリ
|
category | True | string |
構成要素の相互作用のチャネルまたは意図。 |
|
タイプ
|
type | string |
カテゴリを補完するアクションの追加の説明。 |
|
|
概要
|
summary | string |
レコードの先頭に表示されるアクションの簡単な説明。 文字制限: 255。 |
|
|
注
|
description | string |
アクションの概要について詳しく説明する詳細な説明。 |
|
|
完了。
|
completed | boolean |
アクションは完了していますか? システムがカスタムアクションステータスを使用するように設定されている場合、この値はアクションステータス値に基づいています。 |
|
|
完了日
|
completed_date | date-time |
アクションが完了した日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
ステータス
|
status | string |
アクションの状態。 |
|
|
通信方向
|
direction | string |
アクションの方向。 |
|
|
ロケーション
|
location | string |
アクションの場所。 |
|
|
営業案件 ID
|
opportunity_id | string |
アクションに関連付けられている営業案件のシステム レコード ID。 |
|
|
結果
|
outcome | string |
アクションの結果。 |
|
|
Priority
|
priority | string |
アクションの優先順位。 |
|
|
[開始時間]
|
start_time | string |
アクションの開始時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
|
終了時刻
|
end_time | string |
アクションの終了時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
|
Author
|
author | string |
アクションの概要と説明の作成者。 指定しない場合は、ユーザーのアカウントに基づいて既定のセットが設定されます。 文字制限: 50。 |
|
|
寄付者
|
fundraisers | array of string |
アクションに関連付けられている資金調達者のシステム レコード ID のセット。 |
戻り値
作成されたアクション
構成アクションを取得する
構成アクションに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作 ID
|
action_id | True | string |
取得するアクションのシステム レコード ID。 |
戻り値
アクション
構成アクションを更新する
構成アクションを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
操作 ID
|
action_id | True | string |
更新するアクションのシステム レコード ID。 |
|
日付
|
date | date-time |
アクションの日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
カテゴリ
|
category | string |
構成要素の相互作用のチャネルまたは意図。 |
|
|
タイプ
|
type | string |
カテゴリを補完するアクションの追加の説明。 |
|
|
概要
|
summary | string |
レコードの先頭に表示されるアクションの簡単な説明。 文字制限: 255。 |
|
|
注
|
description | string |
アクションの概要について詳しく説明する詳細な説明。 |
|
|
完了。
|
completed | boolean |
アクションは完了していますか? システムがカスタムアクションステータスを使用するように設定されている場合、この値はアクションステータス値に基づいています。 |
|
|
完了日
|
completed_date | date-time |
アクションが完了した日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
ステータス
|
status | string |
アクションの状態。 |
|
|
通信方向
|
direction | string |
アクションの方向。 |
|
|
ロケーション
|
location | string |
アクションの場所。 |
|
|
営業案件 ID
|
opportunity_id | string |
アクションに関連付けられている営業案件のシステム レコード ID。 |
|
|
結果
|
outcome | string |
アクションの結果。 |
|
|
Priority
|
priority | string |
アクションの優先順位。 |
|
|
[開始時間]
|
start_time | string |
アクションの開始時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
|
終了時刻
|
end_time | string |
アクションの終了時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
|
寄付者
|
fundraisers | array of string |
アクションに関連付けられている資金調達者のシステム レコード ID のセット。 |
定義
ConstituentApi.ActionAttachmentRead
添付ファイル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
添付ファイルのシステム レコード ID。 |
|
操作 ID
|
parent_id | string |
添付ファイルに関連付けられているアクションのシステム レコード ID。 |
|
タイプ
|
type | string |
添付ファイルの種類。 物理的な添付ファイルは、ローカルまたはネットワーク上に保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに格納および管理されます。 リンク添付ファイルは、オンラインまたはクラウド ストレージ アカウント内の画像、ブログ投稿、YouTube ビデオなどのファイルへのリンクです。 これらは外部に格納および管理されます。 |
|
名前
|
name | string |
添付ファイルの名前。 文字制限: 150。 |
|
日付
|
date | date-time |
添付ファイルの日付。 |
|
URL
|
url | string |
添付ファイルの URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。 |
|
ファイル名
|
file_name | string |
ファイルの名前。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
ファイル ID
|
file_id | string |
ファイルの識別子。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
サムネイル ID
|
thumbnail_id | string |
サムネイルの識別子。 文字制限: 36。 物理的な添付ファイルの場合のみ。 |
|
サムネイル URL
|
thumbnail_url | string |
サムネイルの URL。 画像のみの物理的な添付ファイルの場合。 アクセスを 60 分に制限する期限付き署名が含まれています。 |
|
コンテンツの種類
|
content_type | string |
コンテンツ タイプ。 物理的な添付ファイルの場合のみ。 |
|
ファイル サイズ
|
file_size | integer |
ファイル サイズ (バイト単位)。 物理的な添付ファイルの場合のみ。 |
|
タグ
|
tags | array of string |
添付ファイルに関連付けられているタグ。 |
ConstituentApi.ActionCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ユーザー設定フィールドのシステム レコード ID。 |
|
操作 ID
|
parent_id | string |
ユーザー設定フィールドに関連付けられているアクションのシステム レコード ID。 |
|
カテゴリ
|
category | string |
ユーザー設定フィールド カテゴリ。 |
|
タイプ
|
type | string |
ユーザー設定フィールドが表すデータの型。 |
|
価値
|
value |
ユーザー設定フィールドの値。 |
|
|
テキスト値
|
text_value | string |
ユーザー設定フィールドのテキスト値。 |
|
数値
|
number_value | integer |
ユーザー設定フィールドの数値。 |
|
日付の値
|
date_value | date |
ユーザー設定フィールドの日付値。 |
|
通貨値
|
currency_value | double |
ユーザー設定フィールドの通貨値。 |
|
ブール値
|
boolean_value | boolean |
ユーザー設定フィールドのブール値。 |
|
テーブル エントリの値
|
codetableentry_value | string |
ユーザー設定フィールドのテーブル エントリ値。 |
|
構成要素 ID 値
|
constituentid_value | string |
ユーザー設定フィールドの構成要素 ID 値。 |
|
day
|
fuzzydate_value.d | integer |
あいまい日付の日付。 |
|
month
|
fuzzydate_value.m | integer |
あいまい日付の月。 |
|
年
|
fuzzydate_value.y | integer |
あいまい日付の年。 |
|
日付
|
date | date |
ユーザー設定フィールドの日付。 |
|
コメント
|
comment | string |
ユーザー設定フィールドのコメント。 文字制限: 50。 |
|
追加日
|
date_added | date-time |
ユーザー設定フィールドが作成された日付。 |
|
変更日
|
date_modified | date-time |
ユーザー設定フィールドが最後に変更された日付。 |
ConstituentApi.ActionRead
アクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
アクションのシステム レコード ID。 |
|
構成要素 ID
|
constituent_id | string |
アクションに関連付けられている構成要素のシステム レコード ID。 |
|
カテゴリ
|
category | string |
構成要素の相互作用のチャネルまたは意図。 |
|
完了。
|
completed | boolean |
アクションは完了していますか? システムがカスタムアクションステータスを使用するように設定されている場合、この値はアクションステータス値に基づいています。 |
|
完了日
|
completed_date | date-time |
アクションが完了した日付。 |
|
日付
|
date | date-time |
アクションの日付。 |
|
注
|
description | string |
アクションの概要について詳しく説明する詳細な説明。 |
|
通信方向
|
direction | string |
アクションの方向。 |
|
寄付者
|
fundraisers | array of string |
アクションに関連付けられている資金調達者のシステム レコード ID のセット。 |
|
ロケーション
|
location | string |
アクションの場所。 |
|
営業案件 ID
|
opportunity_id | string |
アクションに関連付けられている営業案件のシステム レコード ID。 |
|
結果
|
outcome | string |
アクションの結果。 |
|
Priority
|
priority | string |
アクションの優先順位。 |
|
[開始時間]
|
start_time | string |
アクションの開始時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
終了時刻
|
end_time | string |
アクションの終了時刻。 HH:mm 形式で 24 時間の時刻を使用します。 |
|
ステータス
|
status | string |
アクションの状態。 |
|
状態コード
|
status_code | string |
アクションの状態コード。 このプロパティは、システムがカスタム アクションの状態を使用するように構成されている場合にのみ返されます。 |
|
計算された状態
|
computed_status | string |
計算されたアクションの状態。 ユーザー設定のアクションステータスを使用するようにシステムが設定されていない場合、このフィールドは完了プロパティと日付プロパティに基づいてステータスを計算します。 そうでない場合、フィールドはアクションの日付プロパティと、アクションの Action Status プロパティが完了として構成されているかどうかに基づいて状態を計算します。 |
|
概要
|
summary | string |
レコードの先頭に表示されるアクションの簡単な説明。 文字制限: 255。 |
|
タイプ
|
type | string |
カテゴリを補完するアクションの追加の説明。 |
|
追加日
|
date_added | date-time |
アクションが作成された日付。 |
|
変更日
|
date_modified | date-time |
アクションが最後に変更された日付。 |
ConstituentApi.ApiCollectionOfActionAttachmentRead
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数える
|
count | integer |
要求パラメーターを適用した後にコレクションに取得できる項目の数。 制限パラメーターとオフセット パラメーターはカウントには影響しませんが、ページングを容易にするために、値の結果セット内の項目の数に影響を与える可能性があります。 |
|
value
|
value | array of ConstituentApi.ActionAttachmentRead |
応答に含まれる項目のセット。 これは、コレクション内の項目のサブセットである可能性があります。 |
ConstituentApi.ApiCollectionOfActionCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数える
|
count | integer |
要求パラメーターを適用した後にコレクションに取得できる項目の数。 制限パラメーターとオフセット パラメーターはカウントには影響しませんが、ページングを容易にするために、値の結果セット内の項目の数に影響を与える可能性があります。 |
|
value
|
value | array of ConstituentApi.ActionCustomFieldRead |
応答に含まれる項目のセット。 これは、コレクション内の項目のサブセットである可能性があります。 |
ConstituentApi.ApiCollectionOfActionRead
アクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数える
|
count | integer |
要求パラメーターを適用した後にコレクションに取得できる項目の数。 制限パラメーターとオフセット パラメーターはカウントには影響しませんが、ページングを容易にするために、値の結果セット内の項目の数に影響を与える可能性があります。 |
|
value
|
value | array of ConstituentApi.ActionRead |
応答に含まれる項目のセット。 これは、コレクション内の項目のサブセットである可能性があります。 |
ConstituentApi.CreatedAction
作成されたアクション
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたアクションの ID。 |
ConstituentApi.CreatedActionAttachment
作成されたアクションの添付ファイル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたアクションの添付ファイルの ID。 |
ConstituentApi.CreatedActionCustomField
作成されたアクションのユーザー設定フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたアクションのユーザー設定フィールドの ID。 |