Blackbaud Raisers Edge NXT Interactions

Blackbaud Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。 対話型コネクタを使用して、スタッフのアクションを管理します。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Blackbaud サポート
[URL] https://www.blackbaud.com/support
メール skyapi@blackbaud.com
Connector Metadata
発行者 Blackbaud, Inc.
Web サイト 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's Edge NXT 内の以下のようなスタッフの対話および関連エンティティを管理するのに役立つ操作を提供します。

  • アクション​​
  • アクションのカスタム フィールド
  • アクションの添付ファイル
  • その他...

詳細については、ドキュメントを参照してください。

前提条件

このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。

さらに、組織の管理者は、この コネクタが Blackbaud 環境にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。

資格情報の入手方法

組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。

既知の問題と制限事項

コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

アクション カスタム フィールドを一覧表示する

アクションのカスタム フィールドを一覧表示します。

アクション カスタム フィールドを作成する

新しいアクション カスタム フィールドを作成します。

アクションのカスタム フィールドを更新する

アクション カスタム フィールドを更新します。

アクションの添付ファイルをリストする

アクションの添付ファイルをリストする。

アクションの添付ファイルを作成する

新しいアクション添付ファイルを作成します。

アクションを一覧表示する

アクションの一覧を返します。

アクション添付ファイルを更新する

アクション添付ファイルを更新します。

スタッフ アクションを一覧表示する

スタッフのアクションを一覧表示します。

スタッフ アクションを作成する

新しいスタッフ アクションを作成します。

スタッフ アクションを取得する

スタッフ アクションに関する情報を返します。

スタッフ アクションを更新する

スタッフのアクションを更新します。

アクション カスタム フィールドを一覧表示する

アクションのカスタム フィールドを一覧表示します。

パラメーター

名前 キー 必須 説明
アクション ID
action_id True string

アクションのシステム レコード ID。

戻り値

カスタム フィールド

アクション カスタム フィールドを作成する

新しいアクション カスタム フィールドを作成します。

パラメーター

名前 キー 必須 説明
本文
body True dynamic

作成するカスタム フィールドを表すオブジェクト。

戻り値

作成済みアクション カスタム フィールド

アクションのカスタム フィールドを更新する

アクション カスタム フィールドを更新します。

パラメーター

名前 キー 必須 説明
カスタム フィールド ID
custom_field_id True string

更新するカスタム フィールドのシステム レコード ID。

本文
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
tags array of string

添付ファイルに関連付けられているタグ

戻り値

作成したアクションの添付ファイル

アクションを一覧表示する

アクションの一覧を返します。

パラメーター

名前 キー 必須 説明
一覧取得
list_id string

指定された一覧に含まれる一連のアクションをフィルタリングするために使用される一覧識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。

計算されたステータス
computed_status string

計算されたアクション ステータスに基づく結果のフィルターを表します。 有効な値は、Open、Completed、または PastDue です。

ステータス
status_code string

結果をフィルタリングするためのアクション ステータス コードを表します (システムがアクション ステータス コードを使用するように構成されている場合にのみ適用されます)。 たとえば、"保留中" はステータスが "保留中" のアクションを返します。

制限
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
attachment_id True string

更新する添付資料のシステム レコード ID。

件名
name string

添付資料の名前。 文字数制限: 150。

date date-time

添付資料の日付 (例: '2020-09-18T04:13:56Z')。

URL
url string

添付資料の URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。

Tags
tags array of string

添付ファイルに関連付けられているタグ

スタッフ アクションを一覧表示する

スタッフのアクションを一覧表示します。

パラメーター

名前 キー 必須 説明
スタッフ 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
status string

アクションの状態。

指示
direction string

アクションの指示。

場所
location string

アクションの場所。

営業案件 ID
opportunity_id string

アクションに関連付けられた営業案件のシステム レコード ID。

結果
outcome string

アクションの結果。

優先順位
priority string

アクションの優先度。

開始時刻
start_time string

アクションの開始時間。 HH:mm 形式で 24 時間制を使用します。

終了時刻
end_time string

アクションの終了時刻。 HH:mm 形式の 24 時間制を使用します。

作成者
author string

アクションの概要と説明の作成者。 指定しない場合、ユーザーのアカウントに基づいて既定が設定されます。 文字数制限: 50。

資金調達者
fundraisers array of string

アクションに関連付けられた基金調達者に対する一連のシステム レコード ID。

戻り値

作成したアクション

スタッフ アクションを取得する

スタッフ アクションに関する情報を返します。

パラメーター

名前 キー 必須 説明
アクション ID
action_id True string

取得するアクションのシステム レコード ID。

戻り値

Action

スタッフ アクションを更新する

スタッフのアクションを更新します。

パラメーター

名前 キー 必須 説明
アクション 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
status string

アクションの状態。

指示
direction string

アクションの指示。

場所
location string

アクションの場所。

営業案件 ID
opportunity_id string

アクションに関連付けられた営業案件のシステム レコード ID。

結果
outcome string

アクションの結果。

優先順位
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 値。

fuzzydate_value.d integer

あいまいな日付の中の日。

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 string

アクションの優先度。

開始時刻
start_time string

アクションの開始時間。 HH:mm 形式で 24 時間制を使用します。

終了時刻
end_time string

アクションの終了時間。 HH:mm 形式で 24 時間制を使用します。

ステータス
status string

アクションの状態。

状態コード
status_code string

アクション状態コード。 このプロパティは、システムがカスタム アクション状態を使用するように構成されている場合にのみ返されます。

計算されたステータス
computed_status string

計算されたアクション状態。 システムがカスタム アクション状態を使用するように構成されていない場合、このフィールドは完了プロパティと日付プロパティに基づいてステータスを計算します。 そうでない場合は、フィールドは、アクションの日付プロパティと、アクションのアクション状態プロパティが完了済みとして構成されているかどうかに基づいてステータスを計算します。

サマリー
summary string

レコードの上部に表示されるアクションの簡単な説明。 文字数制限: 255。

タイプ
type string

カテゴリを補完するアクションの追加説明。

追加した日付
date_added date-time

アクションが作成された日付。

変更日
date_modified date-time

アクションが最終変更された日付。

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

名前 パス 説明
カウント
count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。

value array of ConstituentApi.ActionAttachmentRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfActionCustomFieldRead

カスタム フィールド

名前 パス 説明
カウント
count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。

value array of ConstituentApi.ActionCustomFieldRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.ApiCollectionOfActionRead

アクション​​

名前 パス 説明
カウント
count integer

要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。

value array of ConstituentApi.ActionRead

応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。

ConstituentApi.CreatedAction

作成したアクション

名前 パス 説明
ID
id string

新しく作成したアクションの ID。

ConstituentApi.CreatedActionAttachment

作成済みアクション添付資料

名前 パス 説明
ID
id string

新しく作成されたアクション添付資料の ID。

ConstituentApi.CreatedActionCustomField

作成済みアクション カスタム フィールド

名前 パス 説明
ID
id string

新しく作成されたアクション カスタム フィールドの ID。