Blackbaud Raisers Edge NXT 交互

Blackbaud Raiser 的 Edge NXT 是一个全面的基于云的筹款和捐赠者管理解决方案,专为非营利组织和整个社会良好社区而构建。 使用 Interactions 连接器管理构成作。

此连接器在以下产品和区域中可用:

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部(DoD)
Power Apps 高级 除以下各项外的所有 Power Apps 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
Power Automate 高级 除以下各项外的所有 Power Automate 区域
     - 美国政府 (GCC)
     - 美国政府 (GCC High)
     - 由世纪互联运营的中国云
     - 美国国防部(DoD)
联系人​​
Name Blackbaud 支持
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
连接器元数据
发布者 Blackbaud, Inc.
网站 https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
隐私策略 https://www.blackbaud.com/privacy-shield
类别 销售和 CRM;生产力

募捐者的 Edge NXT 是一个全面的基于云的筹款和捐赠者管理解决方案,专为非营利组织和整个社会良好社区而构建。

此连接器基于 Blackbaud 的 SKY API 构建,并提供作来帮助管理 Raiser 边缘 NXT 中的构成间和相关实体,包括:

  • 行动
  • 作自定义字段
  • 作附件
  • 等等...

有关详细信息,请查看 文档

先决条件

若要使用此连接器,必须具有一个 Blackbaud ID 帐户,该帐户有权访问一个或多个 Blackbaud 环境。

此外,组织的管理员还必须在系统中执行管理员级作,使此连接器能够访问 Blackbaud 环境。 有关这些先决条件的详细信息,请参阅 初始安装 文档。

如何获取凭据?

组织的管理员将向组织的 Raiser Edge NXT 环境发送邀请,并在环境中配置用户帐户权限。 使用此连接器不需要其他凭据。

已知问题和限制

连接器将在用户帐户的上下文中运行,因此会受到环境中的用户权限的约束。

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

列出作

返回作列表。

列出作自定义字段

列出作的自定义字段。

列出作附件

列出作的附件。

列出构成作

列出构成项的作。

创建作自定义域

创建新的作自定义域。

创建作附件

创建新的作附件。

创建构成作

创建新的构成作。

更新作自定义域

更新作自定义域。

更新作附件

更新作附件。

更新构成作

更新构成作。

获取构成作

返回有关构成作的信息。

列出作

返回作列表。

参数

名称 密钥 必需 类型 说明
列出
list_id string

定义用于筛选指定列表中包含的作集的列表标识符。 如果设置了此值,将忽略其他指定的筛选器。

计算状态
computed_status string

表示基于计算作状态的结果筛选器。 可用值为 Open、Completed 或 PastDue。

状态
status_code string

表示筛选结果的作状态代码(仅当系统配置为使用作状态代码时才适用)。 例如,“挂起”返回状态为“Pending”的作。

限度
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”)。

返回

行动

列出作自定义字段

列出作的自定义字段。

参数

名称 密钥 必需 类型 说明
操作 ID
action_id True string

作的系统记录 ID。

返回

自定义字段

列出作附件

列出作的附件。

参数

名称 密钥 必需 类型 说明
操作 ID
action_id True string

作的系统记录 ID。

返回

附件

列出构成作

列出构成项的作。

参数

名称 密钥 必需 类型 说明
构成 ID
constituent_id True string

构成的系统记录 ID。

返回

行动

创建作自定义域

创建新的作自定义域。

参数

名称 密钥 必需 类型 说明
身体
body True dynamic

一个对象,表示要创建的自定义字段。

返回

已创建作自定义域

创建作附件

创建新的作附件。

参数

名称 密钥 必需 类型 说明
操作 ID
parent_id True string

与附件关联的作的系统记录 ID。

类型
type True string

附件类型。 物理附件是上传的文件,例如本地或网络上保存的图像、PDF 或 Word 文档。 它们存储在系统中并管理。 链接附件是指向联机或云存储帐户中的图像、博客文章或 YouTube 视频等文件的链接。 它们以外部方式存储和管理。

Name
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
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 string

作摘要和说明的作者。 如果未提供,将基于用户帐户设置默认集。 字符限制:50。

募捐者(s)
fundraisers array of string

与作关联的募捐者的系统记录 ID 集。

返回

已创建作

更新作自定义域

更新作自定义域。

参数

名称 密钥 必需 类型 说明
自定义字段 ID
custom_field_id True string

要更新的自定义字段的系统记录 ID。

身体
body True dynamic

一个对象,表示要更新的自定义字段的属性。

更新作附件

更新作附件。

参数

名称 密钥 必需 类型 说明
附件 ID
attachment_id True string

要更新的附件的系统记录 ID。

Name
name string

附件名称。 字符限制:150。

日期
date date-time

附件的日期(例如:“2020-09-18T04:13:56Z”)。

URL
url string

附件的 URL。 这是链接附件所必需的,不适用于物理附件。

标记
tags array of string

与附件关联的标记。

更新构成作

更新构成作。

参数

名称 密钥 必需 类型 说明
操作 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 小时时间。

募捐者(s)
fundraisers array of string

与作关联的募捐者的系统记录 ID 集。

获取构成作

返回有关构成作的信息。

参数

名称 密钥 必需 类型 说明
操作 ID
action_id True string

要获取的作的系统记录 ID。

返回

Action

定义

ConstituentApi.ActionAttachmentRead

附件

名称 路径 类型 说明
ID
id string

附件的系统记录 ID。

操作 ID
parent_id string

与附件关联的作的系统记录 ID。

类型
type string

附件类型。 物理附件是上传的文件,例如本地或网络上保存的图像、PDF 或 Word 文档。 它们存储在系统中并管理。 链接附件是指向联机或云存储帐户中的图像、博客文章或 YouTube 视频等文件的链接。 它们以外部方式存储和管理。

Name
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

Action

名称 路径 类型 说明
ID
id string

作的系统记录 ID。

构成 ID
constituent_id string

与作关联的构成的系统记录 ID。

类别
category string

构成交互的通道或意图。

完成?
completed boolean

作是否已完成? 如果系统配置为使用自定义作状态,则此值基于作状态值。

完成时间
completed_date date-time

作完成的日期。

日期
date date-time

作日期。

注释
description string

详细说明作摘要。

方向
direction string

作的方向。

募捐者(s)
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

附件

名称 路径 类型 说明
计数
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。