Blackbaud Raisers Edge NXT 互動

Blackbaud Raiser 的 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
Email	skyapi@blackbaud.com

連接器中繼資料
Publisher	布萊克博德公司
網站	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
隱私策略	https://www.blackbaud.com/privacy-shield
類別	銷售和客戶關係管理;生產力

Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案，專為非營利組織和整個社會公益社區構建。

該連接器建立在 Blackbaud 的 SKY API 之上，並提供操作來幫助管理 The Raiser's Edge NXT 中的組成互動和相關實體，包括：

• 行動
• 動作自訂欄位
• 動作附件
• 不勝枚舉...

如需詳細資訊，請檢視 文件。

先決條件

若要使用此連接器，您必須擁有 Blackbaud ID 帳戶，才能存取一或多個 Blackbaud 環境。

此外，您組織的管理員還必須在系統內執行管理員層級動作，才能讓此連接器存取您的 Blackbaud 環境。 有關這些先決條件的詳細資訊，請參閱 初始設定 文件。

如何取得憑證？

您組織的管理員將向您發送組織的 Raiser's Edge NXT 環境的邀請，並在環境中配置您的用戶帳戶權限。 使用此連接器不需要其他認證。

已知問題與限制

連接器將在您的使用者帳戶的內容中運作，因此將受限於您在環境中的使用者權限。

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

列出動作	傳回動作清單。
列出動作自訂欄位	列出動作的自訂欄位。
列出動作附件	列出動作的附件。
列出組成動作	列出選區的動作。
取得選民動作	傳回組成動作的相關資訊。
建立動作自訂欄位	建立新的動作自訂欄位。
建立動作附件	建立新的動作附件。
建立組成動作	建立新的組成動作。
更新動作自訂欄位	更新動作自訂欄位。
更新動作附件	更新動作附件。
更新組成動作	更新組成動作。

列出動作

作業識別碼：

ListActions

傳回動作清單。

參數

名稱	機碼	必要	類型	Description
清單	list_id		string	定義清單識別碼，用來將動作集篩選為指定清單中包含的動作集。 如果設定此值，則會忽略其他指定的篩選器。
計算狀態	computed_status		string	代表根據計算動作狀態的結果篩選器。 可用的值為 Open、Completed 或 PastDue。
地位	status_code		string	代表用於篩選結果的動作狀態碼 （僅適用於系統設定為使用動作狀態碼時）。 例如，「擱置中」會傳回狀態為「擱置中」的動作。
限制	limit		integer	代表要傳回的記錄數目。 預設值為 500。 最大值為 5000。
Offset	offset		integer	代表要略過的記錄數。 用於分頁。
添加日期或之後	date_added		date-time	將結果篩選為在指定日期或之後建立的動作 （例如：「2020-09-18T04：13：56Z」）。
修改日期或之後	last_modified		date-time	將結果篩選為在指定日期或之後修改的動作 （例如：「2020-09-18T04：13：56Z」）。

傳回

行動

身體

ConstituentApi.ApiCollectionOfActionRead

列出動作自訂欄位

作業識別碼：

ListActionCustomFields

列出動作的自訂欄位。

參數

名稱	機碼	必要	類型	Description
作ID	action_id	True	string	動作的系統記錄 ID。

傳回

自訂欄位

身體

ConstituentApi.ApiCollectionOfActionCustomFieldRead

列出動作附件

作業識別碼：

ListActionAttachments

列出動作的附件。

參數

名稱	機碼	必要	類型	Description
作ID	action_id	True	string	動作的系統記錄 ID。

傳回

Attachments

身體

ConstituentApi.ApiCollectionOfActionAttachmentRead

列出組成動作

作業識別碼：

ListConstituentActions

列出選區的動作。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	成分的系統記錄 ID。

傳回

行動

身體

ConstituentApi.ApiCollectionOfActionRead

取得選民動作

作業識別碼：

GetAction

傳回組成動作的相關資訊。

參數

名稱	機碼	必要	類型	Description
作ID	action_id	True	string	要取得之動作的系統記錄 ID。

傳回

行動

身體

ConstituentApi.ActionRead

建立動作自訂欄位

作業識別碼：

CreateActionCustomField

建立新的動作自訂欄位。

參數

名稱	機碼	必要	類型	Description
body	body	True	dynamic	代表要建立的自訂欄位的物件。

傳回

已建立動作自訂欄位

身體

ConstituentApi.CreatedActionCustomField

建立動作附件

作業識別碼：

CreateActionAttachment

建立新的動作附件。

參數

名稱	機碼	必要	類型	Description
作ID	parent_id	True	string	與附件相關聯之動作的系統記錄 ID。
類型	type	True	string	附件類型。 實體附件是儲存在本機或網路上的上傳檔案，例如影像、PDF 或 Word 文件。 它們在系統中儲存和管理。 連結附件是指向線上或雲端儲存帳戶中的檔案（例如圖像、部落格文章或 YouTube 影片）的連結。 它們在外部儲存和管理。
名稱	name		string	附件的名稱。 字元限制：150。
Date	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	與附件相關聯的標籤。

傳回

已建立的動作附件

身體

ConstituentApi.CreatedActionAttachment

建立組成動作

作業識別碼：

CreateAction

建立新的組成動作。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	與動作相關聯之成分的系統記錄 ID。
Date	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		string	動作摘要和描述的作者。 如果未提供，則會根據使用者的帳戶設定預設值。 字元限制：50。
籌款活動	fundraisers		array of string	與動作相關聯之募款活動的系統記錄 ID 集。

傳回

已建立動作

身體

ConstituentApi.CreatedAction

更新動作自訂欄位

作業識別碼：

EditActionCustomField

更新動作自訂欄位。

參數

名稱	機碼	必要	類型	Description
自訂欄位ID	custom_field_id	True	string	要更新之自訂欄位的系統記錄 ID。
body	body	True	dynamic	代表要更新之自訂欄位屬性的物件。

更新動作附件

作業識別碼：

EditActionAttachment

更新動作附件。

參數

名稱	機碼	必要	類型	Description
附件 ID	attachment_id	True	string	要更新之附件的系統記錄 ID。
名稱	name		string	附件的名稱。 字元限制：150。
Date	date		date-time	附件的日期 （例如：「2020-09-18T04：13：56Z」）。
URL	url		string	附件的 URL。 這是連結附件所必需的，不適用於實體附件。
Tags	tags		array of string	與附件相關聯的標籤。

更新組成動作

作業識別碼：

EditAction

更新組成動作。

參數

名稱	機碼	必要	類型	Description
作ID	action_id	True	string	要更新之動作的系統記錄 ID。
Date	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

Attachment

名稱	路徑	類型	Description
ID	id	string	附件的系統記錄 ID。
作ID	parent_id	string	與附件相關聯之動作的系統記錄 ID。
類型	type	string	附件類型。 實體附件是儲存在本機或網路上的上傳檔案，例如影像、PDF 或 Word 文件。 它們在系統中儲存和管理。 連結附件是指向線上或雲端儲存帳戶中的檔案（例如圖像、部落格文章或 YouTube 影片）的連結。 它們在外部儲存和管理。
名稱	name	string	附件的名稱。 字元限制：150。
Date	date	date-time	附件的日期。
URL	url	string	附件的 URL。 這是連結附件所必需的，不適用於實體附件。
檔案名稱	file_name	string	檔案的檔名。 字元限制：36 個。 僅適用於實體附件。
檔案 ID	file_id	string	檔案的識別碼。 字元限制：36 個。 僅適用於實體附件。
縮圖 ID	thumbnail_id	string	縮圖的識別碼。 字元限制：36 個。 僅適用於實體附件。
縮圖網址	thumbnail_url	string	縮圖的 URL。 適用於僅影像的實體附件。 包含限制存取時間限制為 60 分鐘的限時簽名。
內容類型	content_type	string	內容類型。 僅適用於實體附件。
檔案大小	file_size	integer	檔案大小 （以位元組為單位）。 僅適用於實體附件。
Tags	tags	array of string	與附件相關聯的標籤。

ConstituentApi.ActionCustomField讀取

自訂欄位

名稱	路徑	類型	Description
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	date	自訂欄位上的日期。
評論	comment	string	自訂欄位上的註解。 字元限制：50。
新增日期	date_added	date-time	建立自訂欄位的日期。
修改日期	date_modified	date-time	上次修改自訂欄位的日期。

ConstituentApi.ActionRead

行動

名稱	路徑	類型	Description
ID	id	string	動作的系統記錄 ID。
選區 ID	constituent_id	string	與動作相關聯之成分的系統記錄 ID。
類別	category	string	組成互動的管道或意圖。
成？	completed	boolean	動作是否完成？ 如果系統配置為使用自訂動作狀態，則此值是以動作狀態值為基礎。
完成時間	completed_date	date-time	動作完成的日期。
Date	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	計算的動作狀態。 如果系統未配置為使用自訂動作狀態，則此欄位會根據已完成和日期內容來計算狀態。 如果沒有，則欄位會根據動作的日期屬性，以及動作的「動作狀態」屬性是否設定為已完成來計算狀態。
總結	summary	string	記錄頂端顯示的動作簡短描述。 字元限制：255。
類型	type	string	補充類別的動作的附加說明。
新增日期	date_added	date-time	建立動作的日期。
修改日期	date_modified	date-time	上次修改動作的日期。

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of ConstituentApi.ActionAttachmentRead	回應中包含的專案集。 這可能是集合中項目的子集。

ConstituentApi.ApiCollectionOfActionCustomFieldRead

自訂欄位

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of ConstituentApi.ActionCustomFieldRead	回應中包含的專案集。 這可能是集合中項目的子集。

ConstituentApi.ApiCollectionOfActionRead

行動

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of ConstituentApi.ActionRead	回應中包含的專案集。 這可能是集合中項目的子集。

ConstituentApi.CreatedAction

已建立動作

名稱	路徑	類型	Description
ID	id	string	新建立動作的 ID。

ConstituentApi.CreatedActionAttachment

已建立的動作附件

名稱	路徑	類型	Description
ID	id	string	新建立的動作附件的 ID。

ConstituentApi.CreatedActionCustomField

已建立動作自訂欄位

名稱	路徑	類型	Description
ID	id	string	新建立的動作自訂欄位的ID。