Blackbaud Raisers Edge NXT Fundraising
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 の上に構築されており、次を含む、Raiser's Edge NXT 内で検索された資金調達エンティティの管理に役立つ操作を提供します:
- キャンペーン
- 資金
- アピール
- パッケージ
- その他...
詳細については、ドキュメントを参照してください。
前提条件
このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。
さらに、組織の管理者は、この コネクタが Blackbaud 環境にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。
資格情報の入手方法
組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。
既知の問題と制限事項
コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アピールを取得する |
アピールに関する情報を返します。 |
| キャンペーン カスタム フィールドを一覧表示する |
キャンペーンのカスタム フィールドを一覧表示します。 |
| キャンペーンのカスタム フィールドを作成する |
新しいキャンペーンのカスタム フィールドを作成します。 |
| キャンペーンのカスタム フィールドを更新する |
キャンペーンのカスタム フィールドを更新します。 |
| キャンペーンのリストの表示 |
キャンペーンの一覧を返します。 |
| キャンペーンの添付ファイルを作成する |
新しいキャンペーンの添付ファイルを作成します。 |
| キャンペーンを作成する |
新しいキャンペーンを作成します。 |
| キャンペーンを取得する |
キャンペーンに関する情報を返します。 |
| キャンペーンを更新する |
キャンペーンを更新します。 |
| キャンペーン添付ファイルを更新する |
キャンペーン添付ファイルを更新します。 |
| キャンペーン添付資料を一覧表示する |
キャンペーンの添付資料を一覧表示します。 |
| スタッフの異議申し立てを一覧表示する |
スタッフの異議申し立てを一覧表示します。 |
| スタッフの異議申し立てを作成する |
新しいスタッフの異議申し立てを作成します。 |
| スタッフの異議申し立てを更新する |
スタッフの異議申し立てを更新します。 |
| スタッフの資金リレーションシップを一覧表示する |
スタッフの資金リレーションシップ関連付けを一覧表示します。 |
| パッケージをリストする |
パッケージのリストを返します。 |
| パッケージを取得する |
パッケージに関する情報を返します。 |
| 異議申し立ての作成 |
新しい異議申し立てを作成します。 |
| 異議申し立てを一覧表示する |
異議申し立ての一覧を返します。 |
| 異議申し立てを更新する |
異議申し立てを更新します。 |
| 異議申し立てカスタム フィールドを一覧表示する |
異議申し立てのカスタム フィールドを一覧表示します。 |
| 異議申し立てカスタム フィールドを作成する |
新しい異議申し立てカスタム フィールドを作成します。 |
| 異議申し立てカスタム フィールドを更新する |
異議申し立てカスタム フィールドを更新します。 |
| 異議申し立て添付ファイルを作成する |
新しい異議申し立て添付ファイルを作成します。 |
| 異議申し立て添付ファイルを更新する |
異議申し立て添付ファイルを更新します。 |
| 異議申し立て添付資料を一覧表示する |
異議申し立ての添付資料を一覧表示します。 |
| 資金のカスタム フィールドを作成する |
新しい資金のカスタム フィールドを作成します。 |
| 資金のカスタム フィールドを更新する |
資金のカスタム フィールドを更新します。 |
| 資金のスタッフ リレーションシップを一覧表示する |
資金のスタッフ リレーションシップを一覧表示します。 |
| 資金の一覧 |
資金のリストを返します。 |
| 資金の作成 |
新しい資金を作成します。 |
| 資金の添付ファイルを一覧表示する |
資金の添付ファイルを一覧表示します。 |
| 資金の添付ファイルを更新する |
資金の添付ファイルを更新します。 |
| 資金の添付資料を作成する |
新しい資金の添付資料を作成します。 |
| 資金を取得する |
資金に関する情報を返します。 |
| 資金を更新する |
資金を更新します。 |
| 資金カスタム フィールドを一覧表示する |
資金のカスタム フィールドを一覧表示します。 |
アピールを取得する
アピールに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アピール ID
|
appeal_id | True | string |
取得するアピールのシステム レコード ID。 |
戻り値
アピール
キャンペーン カスタム フィールドを一覧表示する
キャンペーンのカスタム フィールドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
campaign_id | True | string |
キャンペーンのシステム レコード ID。 |
戻り値
カスタム フィールド
キャンペーンのカスタム フィールドを作成する
新しいキャンペーンのカスタム フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
本文
|
body | True | dynamic |
作成するカスタム フィールドを表すオブジェクト。 |
戻り値
作成済みキャンペーンのカスタム フィールド
キャンペーンのカスタム フィールドを更新する
キャンペーンのカスタム フィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カスタム フィールド ID
|
custom_field_id | True | string |
更新するカスタム フィールドのシステム レコード ID。 |
|
本文
|
body | True | dynamic |
更新するカスタム フィールドのプロパティを表すオブジェクト。 |
キャンペーンのリストの表示
キャンペーンの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
非アクティブを含む?
|
include_inactive | boolean |
非アクティブなキャンペーンを含みますか? |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成されたキャンペーンに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に修正されたキャンペーンに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
戻り値
キャンペーン
キャンペーンの添付ファイルを作成する
新しいキャンペーンの添付ファイルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン 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 |
添付ファイルに関連付けられているタグ |
戻り値
作成済みキャンペーン添付ファイル
キャンペーンを作成する
新しいキャンペーンを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索 ID
|
campaign_id | True | string |
キャンペーンのユーザー定義の識別子。 |
|
説明
|
description | True | string |
キャンペーンの説明。 |
|
開始日
|
start_date | date |
キャンペーンの開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
キャンペーンの終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
campaign_category_id | integer |
キャンペーンのカテゴリー。 |
|
|
ゴール
|
goal | double |
キャンペーンを通じて調達する目標額。 |
|
|
メモ
|
notes | string |
キャンペーンに関連付けたメモ。 |
|
|
非アクティブですか?
|
inactive | boolean |
キャンペーンは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
|
既定の資金 ID
|
default_fund_id | integer |
キャンペーンに関連付けられている既定のファンドの ID。 |
戻り値
作成されたキャンペーン
キャンペーンを取得する
キャンペーンに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
campaign_id | True | string |
取得するキャンペーンのシステム レコード ID。 |
戻り値
キャンペーン
キャンペーンを更新する
キャンペーンを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
キャンペーン ID
|
id | True | integer |
更新するキャンペーンのシステム レコード ID。 |
|
検索 ID
|
campaign_id | string |
キャンペーンのユーザー定義の識別子。 |
|
|
説明
|
description | string |
キャンペーンの説明。 |
|
|
開始日
|
start_date | date |
キャンペーンの開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
キャンペーンの終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
campaign_category_id | integer |
キャンペーンのカテゴリー。 |
|
|
ゴール
|
goal | double |
キャンペーンを通じて調達する目標額。 |
|
|
メモ
|
notes | string |
キャンペーンに関連付けたメモ。 |
|
|
非アクティブですか?
|
inactive | boolean |
キャンペーンは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
|
既定の資金 ID
|
default_fund_id | integer |
キャンペーンに関連付けられている既定のファンドの ID。 |
キャンペーン添付ファイルを更新する
キャンペーン添付ファイルを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
添付ファイル 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
|
campaign_id | True | string |
キャンペーンのシステム レコード ID。 |
戻り値
Attachments
スタッフの異議申し立てを一覧表示する
スタッフの異議申し立てを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
スタッフのシステム レコード ID。 |
戻り値
スタッフの異議申し立て
スタッフの異議申し立てを作成する
新しいスタッフの異議申し立てを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | integer |
スタッフの異議申し立てに関連付けられているスタッフのシステム レコード ID。 |
|
異議申し立ての説明
|
appeal_description | True | string |
異議申し立ての説明; 異議申し立てレコード ID を検索するために使用されます。 |
|
パッケージの説明
|
package_description | string |
パッケージの説明; パッケージ レコード ID を検索するために使用されます。 |
|
|
日付
|
appeal_date | date |
スタッフの異議申し立て日付 (例: '2005-09-18') |
|
|
応答
|
response_description | string |
スタッフの異議申し立てに対する応答の長い説明。 |
|
|
マーケティング セグメント
|
marketing_segment | string |
スタッフの異議申し立てと関連するマーケティング セグメント。 |
|
|
マーケティング ソース コード
|
marketing_source_code | string |
スタッフの異議申し立てと関連するマーケティング ソース コード。 |
|
|
郵送先 ID
|
mailing_id | integer |
スタッフの異議申し立ての郵送先 ID。 |
|
|
検索番号
|
market_finder_number | string |
スタッフの異議申し立てと関連するマーケティング検索番号。 |
|
|
コメント
|
comments | string |
スタッフの異議申し立てに関連付けるコメント。 |
|
|
インポート ID
|
import_id | string |
スタッフの異議申し立てのインポート ID。 |
戻り値
作成されたスタッフの異議申し立て
スタッフの異議申し立てを更新する
スタッフの異議申し立てを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフの異議申し立て ID
|
id | True | integer |
更新するスタッフの異議申し立てのシステム レコード ID。 |
|
異議申し立ての説明
|
appeal_description | string |
異議申し立ての説明; 異議申し立てレコード ID を検索するために使用されます。 |
|
|
パッケージの説明
|
package_description | string |
パッケージの説明; パッケージ レコード ID を検索するために使用されます。 |
|
|
日付
|
appeal_date | date |
スタッフの異議申し立て日付 (例: '2005-09-18') |
|
|
応答
|
response_description | string |
スタッフの異議申し立てに対する応答の長い説明。 |
|
|
マーケティング セグメント
|
marketing_segment | string |
スタッフの異議申し立てと関連するマーケティング セグメント。 |
|
|
マーケティング ソース コード
|
marketing_source_code | string |
スタッフの異議申し立てと関連するマーケティング ソース コード。 |
|
|
郵送先 ID
|
mailing_id | integer |
スタッフの異議申し立ての郵送先 ID。 |
|
|
検索番号
|
market_finder_number | string |
スタッフの異議申し立てと関連するマーケティング検索番号。 |
|
|
コメント
|
comments | string |
スタッフの異議申し立てに関連付けるコメント。 |
スタッフの資金リレーションシップを一覧表示する
スタッフの資金リレーションシップ関連付けを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituentId | True | integer |
スタッフのシステム レコード ID。 |
|
限度
|
limit | integer |
返されるレコード数を表します。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
戻り値
資金リレーションシップ
パッケージをリストする
パッケージのリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アピール ID
|
appeal_id | string |
結果をフィルター処理する、異議申し立てシステム レコード ID のコンマ区切りリストを表します。 たとえば、「506,918」は、異議申し立て 506 または異議申し立て 918 のパッケージのみを返します。 |
|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
非アクティブを含む?
|
include_inactive | boolean |
非アクティブなパッケージを含みますか? |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成されたパッケージに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
結果を、指定日以降に変更したパッケージにフィルター処理する (例: '2020-09-18T04:13:56Z')。 |
戻り値
パッケージ
パッケージを取得する
パッケージに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パッケージ ID
|
package_id | True | string |
取得するパッケージのシステム レコード ID。 |
戻り値
パッケージ
異議申し立ての作成
新しい異議申し立てを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索 ID
|
appeal_id | True | string |
異議申し立てのユーザー定義の識別子。 |
|
説明
|
description | True | string |
異議申し立ての説明。 |
|
開始日
|
start_date | date |
異議申し立ての開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
異議申し立ての終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
appeal_category_id | integer |
異議申し立てのカテゴリー。 |
|
|
ゴール
|
goal | double |
異議申し立てを通じて調達する目標額。 |
|
|
既定のギフト金額
|
default_gift_amount | double |
既定のギフトの金額。 金額が指定されていない場合、このプロパティの既定は 0.00 です。 |
|
|
募集数
|
number_solicited | integer |
異議申し立て内のスタッフ送信請求の数。 |
|
|
メモ
|
notes | string |
異議申し立てに関連付けたメモ。 |
|
|
既定のキャンペーンID
|
campaign_id | integer |
異議申し立てに関連付けられているキャンペーンの ID。 |
|
|
既定の資金 ID
|
default_fund_id | integer |
異議申し立てに関連付けられている既定の資金の ID。 |
|
|
非アクティブですか?
|
inactive | boolean |
異議申し立ては非アクティブ (現在の日付が開始日より後で、終了日より前) ですか? |
戻り値
作成済み異議申し立て
異議申し立てを一覧表示する
異議申し立ての一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
非アクティブを含む?
|
include_inactive | boolean |
非アクティブな異議申し立てを含みますか? |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成された異議申し立てに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に修正された異議申し立てに結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
戻り値
異議申し立て
異議申し立てを更新する
異議申し立てを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
異議申し立て ID
|
id | True | integer |
更新する異議申し立てのシステム レコード ID。 |
|
検索 ID
|
appeal_id | string |
異議申し立てのユーザー定義の識別子。 |
|
|
説明
|
description | string |
異議申し立ての説明。 |
|
|
開始日
|
start_date | date |
異議申し立ての開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
異議申し立ての終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
appeal_category_id | integer |
異議申し立てのカテゴリー。 |
|
|
ゴール
|
goal | double |
異議申し立てを通じて調達する目標額。 |
|
|
既定のギフト金額
|
default_gift_amount | double |
既定のギフトの金額。 金額が指定されていない場合、このプロパティの既定は 0.00 です。 |
|
|
募集数
|
number_solicited | integer |
異議申し立て内のスタッフ送信請求の数。 |
|
|
メモ
|
notes | string |
異議申し立てに関連付けたメモ。 |
|
|
既定のキャンペーンID
|
campaign_id | integer |
異議申し立てに関連付けられているキャンペーンの ID。 |
|
|
既定の資金 ID
|
default_fund_id | integer |
異議申し立てに関連付けられている既定の資金の ID。 |
|
|
非アクティブですか?
|
inactive | boolean |
異議申し立ては非アクティブ (現在の日付が開始日より後で、終了日より前) ですか? |
異議申し立てカスタム フィールドを一覧表示する
異議申し立てのカスタム フィールドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
訴求力 ID
|
appeal_id | True | string |
異議申し立てのシステム レコード ID。 |
戻り値
カスタム フィールド
異議申し立てカスタム フィールドを作成する
新しい異議申し立てカスタム フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
本文
|
body | True | dynamic |
作成するカスタム フィールドを表すオブジェクト。 |
戻り値
作成したアピールのカスタム フィールド
異議申し立てカスタム フィールドを更新する
異議申し立てカスタム フィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カスタム フィールド ID
|
custom_field_id | True | string |
更新するカスタム フィールドのシステム レコード ID。 |
|
本文
|
body | True | dynamic |
更新するカスタム フィールドのプロパティを表すオブジェクト。 |
異議申し立て添付ファイルを作成する
新しい異議申し立て添付ファイルを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
訴求力 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 |
添付ファイルに関連付けられているタグ |
戻り値
作成済み異議申し立て添付ファイル
異議申し立て添付ファイルを更新する
異議申し立て添付ファイルを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
添付ファイル 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
|
appeal_id | True | string |
異議申し立てのシステム レコード ID。 |
戻り値
Attachments
資金のカスタム フィールドを作成する
新しい資金のカスタム フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
本文
|
body | True | dynamic |
作成するカスタム フィールドを表すオブジェクト。 |
戻り値
作成した資金のカスタム フィールド
資金のカスタム フィールドを更新する
資金のカスタム フィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カスタム フィールド ID
|
custom_field_id | True | string |
更新するカスタム フィールドのシステム レコード ID。 |
|
本文
|
body | True | dynamic |
更新するカスタム フィールドのプロパティを表すオブジェクト。 |
資金のスタッフ リレーションシップを一覧表示する
資金のスタッフ リレーションシップを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
fundId | True | integer |
資金のシステム レコード ID。 |
|
制限
|
limit | integer |
返されるレコード数を表します。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
戻り値
スタッフ リレーションシップ
資金の一覧
資金のリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
限度
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
非アクティブを含む?
|
include_inactive | boolean |
非アクティブな資金を含みますか? |
|
|
以降に追加済
|
date_added | date-time |
指定した日付以降に作成された資金に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に修正された資金に結果をフィルタリングします (例: '2020-09-18T04:13:56Z')。 |
戻り値
資金
資金の作成
新しい資金を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索 ID
|
fund_id | True | string |
資金のユーザー定義の識別子。 |
|
説明
|
description | True | string |
資金の説明。 |
|
開始日
|
start_date | date |
資金の開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
資金の終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
fund_category_id | integer |
資金のカテゴリー。 |
|
|
タイプ
|
fund_type_id | integer |
資金タイプです。 |
|
|
ゴール
|
goal | double |
資金の調達する目標額。 |
|
|
メモ
|
notes | string |
資金に関連付けたメモ。 |
|
|
制限付き?
|
restricted | boolean |
資金は特定のユーザーに制限されていますか? |
|
|
非アクティブですか?
|
inactive | boolean |
資金は非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
|
キャンペーン ID
|
campaign_id | integer |
資金に関連付けられているキャンペーンの ID。 |
|
|
既定の異議申し立て ID
|
default_appeal_id | integer |
資金に関連付けられている既定の申し立ての ID。 |
戻り値
作成された資金
資金の添付ファイルを一覧表示する
資金の添付ファイルを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
fund_id | True | string |
資金のシステム レコード ID。 |
戻り値
添付ファイル
資金の添付ファイルを更新する
資金の添付ファイルを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
添付ファイル 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
|
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 |
添付ファイルに関連付けられているタグ |
戻り値
作成済みの資金添付ファイル
資金を取得する
資金に関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
fund_id | True | string |
取得する資金のシステム レコード ID。 |
戻り値
資金
資金を更新する
資金を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
id | True | integer |
更新する資金のシステム レコード ID。 |
|
検索 ID
|
fund_id | string |
資金のユーザー定義の識別子。 |
|
|
説明
|
description | string |
資金の説明。 |
|
|
開始日
|
start_date | date |
資金の開始日 (例: '2005-09-18')。 |
|
|
終了日
|
end_date | date |
資金の終了日 (例: '2005-09-18')。 |
|
|
カテゴリー
|
fund_category_id | integer |
資金のカテゴリー。 |
|
|
タイプ
|
fund_type_id | integer |
資金タイプです。 |
|
|
ゴール
|
goal | double |
資金の調達する目標額。 |
|
|
メモ
|
notes | string |
資金に関連付けたメモ。 |
|
|
制限付き?
|
restricted | boolean |
資金は特定のユーザーに制限されていますか? |
|
|
非アクティブですか?
|
inactive | boolean |
資金は非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
|
キャンペーン ID
|
campaign_id | integer |
資金に関連付けられているキャンペーンの ID。 |
|
|
既定の異議申し立て ID
|
default_appeal_id | integer |
資金に関連付けられている既定の申し立ての ID。 |
資金カスタム フィールドを一覧表示する
資金のカスタム フィールドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
fund_id | True | string |
資金のシステム レコード ID。 |
戻り値
カスタム フィールド
定義
ConstituentApi.ApiCollectionOfConstituentAppealRead
スタッフの異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of ConstituentApi.ConstituentAppealRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
ConstituentApi.ConstituentAppealRead
スタッフの異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
スタッフの異議申し立てのシステム レコード ID。 |
|
ID
|
appeal.id | string |
アピールのシステム レコード ID。 |
|
description
|
appeal.description | string |
異議申し立ての説明。 |
|
ID
|
package.id | string |
パッケージのシステム レコード ID。 |
|
description
|
package.description | string |
パッケージの説明。 |
|
日
|
date | date-time |
スタッフの異議申し立ての日付。 |
|
回答
|
response | string |
スタッフの異議申し立てに対する応答。 |
|
マーケティング セグメント
|
marketing_segment | string |
スタッフの異議申し立てに対するマーケティング セグメント。 |
|
マーケティング ソース コード
|
marketing_source_code | string |
スタッフの異議申し立てに対するマーケティング ソース コード。 |
|
郵送先 ID
|
mailing_id | string |
スタッフの異議申し立てに対する、ユーザーが定義した郵送先識別子。 |
|
検索番号
|
finder_number | string |
スタッフの異議申し立てに対するマーケティング検索番号。 |
|
コメント
|
comments | string |
スタッフの異議申し立てに対するユーザー コメント。 |
FundraisingApi.ApiCollectionOfAppealAttachmentRead
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.AppealAttachmentRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfAppealCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.AppealCustomFieldRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfAppealRead
異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.AppealRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfCampaignAttachmentRead
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.CampaignAttachmentRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfCampaignCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.CampaignCustomFieldRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfCampaignRead
キャンペーン
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.CampaignRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfFundAttachmentRead
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.FundAttachmentRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfFundCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.FundCustomFieldRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfFundRead
資金
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.FundRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.ApiCollectionOfPackageRead
パッケージ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of FundraisingApi.PackageRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
FundraisingApi.AppealAttachmentRead
添付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
添付ファイルに関連付けられているタグ |
FundraisingApi.AppealCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
カスタム フィールドが最終変更された日付。 |
FundraisingApi.AppealRead
異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
異議申し立てのシステム レコード ID。 |
|
カテゴリ
|
category | string |
異議申し立てのカテゴリ。 |
|
追加した日付
|
date_added | date-time |
異議申し立てが作成された日付。 |
|
変更日
|
date_modified | date-time |
異議申し立てが最終変更された日付。 |
|
内容
|
description | string |
異議申し立ての表示名。 |
|
終了日
|
end_date | date-time |
異議申し立ての終了日。 |
|
値
|
goal.value | double |
金額。 |
|
非アクティブ?
|
inactive | boolean |
異議申し立ては非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
検索 ID
|
lookup_id | string |
異議申し立てのユーザー定義の識別子。 |
|
開始日
|
start_date | date-time |
異議申し立ての開始日。 |
FundraisingApi.CampaignAttachmentRead
添付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
添付ファイルに関連付けられているタグ |
FundraisingApi.CampaignCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
カスタム フィールドが最終変更された日付。 |
FundraisingApi.CampaignRead
キャンペーン
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
キャンペーンのシステム レコード ID。 |
|
カテゴリ
|
category | string |
キャンペーンのカテゴリ。 |
|
追加した日付
|
date_added | date-time |
キャンペーンが作成された日付。 |
|
変更日
|
date_modified | date-time |
キャンペーンが最終変更された日付。 |
|
内容
|
description | string |
キャンペーンの表示名。 |
|
終了日
|
end_date | date-time |
キャンペーンの終了日。 |
|
値
|
goal.value | double |
金額。 |
|
非アクティブ?
|
inactive | boolean |
キャンペーンは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
検索 ID
|
lookup_id | string |
キャンペーンのユーザー定義の識別子。 |
|
開始日
|
start_date | date-time |
キャンペーンの開始日。 |
FundraisingApi.CreatedAppealAttachment
作成済み異議申し立て添付資料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成された異議申し立ての添付資料の ID。 |
FundraisingApi.CreatedAppealCustomField
作成済み異議申し立てカスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成された異議申し立てのカスタム フィールドの ID。 |
FundraisingApi.CreatedCampaignAttachment
作成済みキャンペーン添付資料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたキャンペーンの添付資料の ID。 |
FundraisingApi.CreatedCampaignCustomField
作成済みキャンペーンのカスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたキャンペーンのカスタム フィールドの ID。 |
FundraisingApi.CreatedFundAttachment
作成済み資金の添付資料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成された資金の添付資料の ID。 |
FundraisingApi.CreatedFundCustomField
作成済み資金のカスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成された資金のカスタム フィールドの ID。 |
FundraisingApi.FundAttachmentRead
添付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
添付ファイルに関連付けられているタグ |
FundraisingApi.FundCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
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 |
カスタム フィールドが最終変更された日付。 |
FundraisingApi.FundRead
資金
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
資金のシステム レコード ID。 |
|
カテゴリ
|
category | string |
資金のカテゴリ。 |
|
追加した日付
|
date_added | date-time |
資金が作成された日付。 |
|
変更日
|
date_modified | date-time |
資金が最終変更された日付。 |
|
内容
|
description | string |
資金の表示名。 |
|
終了日
|
end_date | date-time |
資金の終了日。 |
|
値
|
goal.value | double |
金額。 |
|
非アクティブ?
|
inactive | boolean |
資金は非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
検索 ID
|
lookup_id | string |
資金のユーザー定義の識別子。 |
|
開始日
|
start_date | date-time |
資金の開始日。 |
|
タイプ
|
type | string |
資金の種類。 |
FundraisingApi.PackageRead
パッケージ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
パッケージのシステム レコード ID。 |
|
訴求力 ID
|
appeal_id | string |
パッケージに関連付けられた異議申し立てのシステム レコード ID。 |
|
カテゴリ
|
category | string |
パッケージのカテゴリ。 |
|
追加した日付
|
date_added | date-time |
パッケージが作成された日付。 |
|
変更日
|
date_modified | date-time |
パッケージが最終変更しされた日付。 |
|
値
|
default_gift_amount.value | double |
金額。 |
|
内容
|
description | string |
パッケージの表示名。 |
|
終了日
|
end | date-time |
パッケージの終了日。 |
|
値
|
goal.value | double |
金額。 |
|
非アクティブ?
|
inactive | boolean |
パッケージは非アクティブ (現在の日付が任意の開始日より後で、終了日より前) ですか? |
|
検索 ID
|
lookup_id | string |
パッケージのユーザー定義の識別子。 |
|
メモ
|
notes | string |
パッケージのメモ。 |
|
受信者数
|
recipient_count | integer |
パッケージの受信者数。 |
|
開始日
|
start | date-time |
パッケージの開始日。 |
NXTDataIntegrationApi.ConstituentRelationship
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
スタッフ ID
|
relation_id | integer |
関係スタッフのシステム レコード ID。 |
|
リレーションの説明
|
relation_description | string |
リレーションの説明です。 |
|
リレーションシップのタイプ
|
relationship_type | string |
リレーションシップのタイプです。 |
|
相互リレーションシップ タイプ
|
reciprocal_relationship_type | string |
相互リレーションシップ タイプです。 |
|
開始日
|
date_from | date-time |
リレーションシップの開始日です。 |
|
終了日
|
date_to | date-time |
リレーションシップの終了日です。 |
|
メモ
|
notes | string |
リレーションシップ メモです。 |
NXTDataIntegrationApi.ConstituentRelationshipCollection
スタッフ リレーションシップ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.ConstituentRelationship |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
NXTDataIntegrationApi.CreatedAppeal
作成済み異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した異議申し立ての ID。 |
NXTDataIntegrationApi.CreatedCampaign
作成されたキャンペーン
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したキャンペーンの ID。 |
NXTDataIntegrationApi.CreatedConstituentAppeal
作成されたスタッフの異議申し立て
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したスタッフの異議申し立ての ID。 |
NXTDataIntegrationApi.CreatedFund
作成された資金
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成した資金の ID。 |
NXTDataIntegrationApi.FundRelationship
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
資金 ID
|
relation_id | integer |
関係する資金のシステム レコード ID。 |
|
リレーションの説明
|
relation_description | string |
リレーションの説明です。 |
|
リレーションシップの種類
|
relationship_type | string |
リレーションシップのタイプです。 |
|
相互リレーションシップ タイプ
|
reciprocal_relationship_type | string |
相互リレーションシップ タイプです。 |
|
開始日
|
date_from | date-time |
リレーションシップの開始日です。 |
|
終了日
|
date_to | date-time |
リレーションシップの終了日です。 |
|
メモ
|
notes | string |
リレーションシップ メモです。 |
NXTDataIntegrationApi.FundRelationshipCollection
資金リレーションシップ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.FundRelationship |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |