Взаимодействие Blackbaud Raisers Edge NXT
Blackbaud Raiser Edge NXT — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества. Используйте соединитель "Взаимодействие" для управления составляющими действиями.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка Blackbaud |
| URL | https://www.blackbaud.com/support |
| Адрес электронной почты | skyapi@blackbaud.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Blackbaud, Inc. |
| Веб-сайт | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Политика конфиденциальности | https://www.blackbaud.com/privacy-shield |
| Категории | Продажи и CRM; Продуктивность |
Edge NXT Raiser — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.
Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления составляющими взаимодействиями и связанными сущностями в Edge NXT Raiser, в том числе:
- Действия
- Настраиваемые поля действия
- Вложения действий
- и другие...
Дополнительные сведения см. в документации.
Предпосылки
Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .
Как получить учетные данные?
Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения
Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка вложений действий |
Выводит список вложений для действия. |
| Обновление вложения действия |
Обновляет вложение действия. |
| Обновление настраиваемого поля действия |
Обновляет настраиваемое поле действия. |
| Обновление составного действия |
Обновляет составное действие. |
| Перечисление действий |
Возвращает список действий. |
| Перечисление составляющих действий |
Перечисляет действия для составного элемента. |
| Получение составного действия |
Возвращает сведения о составном действии. |
| Создание вложения действия |
Создает новое вложение действия. |
| Создание настраиваемого поля действия |
Создает настраиваемое поле действия. |
| Создание составного действия |
Создает новое составное действие. |
| Список настраиваемых полей действия |
Выводит настраиваемые поля для действия. |
Вывод списка вложений действий
Выводит список вложений для действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия. |
Возвращаемое значение
Attachments
Обновление вложения действия
Обновляет вложение действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachment_id | True | string |
Идентификатор системной записи для обновления вложения. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
|
Date
|
date | date-time |
Дата вложения (например, '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
Обновление настраиваемого поля действия
Обновляет настраиваемое поле действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор настраиваемого поля
|
custom_field_id | True | string |
Идентификатор системной записи настраиваемого поля для обновления. |
|
body
|
body | True | dynamic |
Объект, представляющий свойства настраиваемого поля для обновления. |
Обновление составного действия
Обновляет составное действие.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия для обновления. |
|
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 |
Расположение действия. |
|
|
Идентификатор возможности
|
opportunity_id | string |
Идентификатор системной записи возможности, связанной с действием. |
|
|
Результат
|
outcome | string |
Результат действия. |
|
|
Priority
|
priority | string |
Приоритет действия. |
|
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
|
Сбор средств
|
fundraisers | array of string |
Набор идентификаторов системных записей для сборщиков средств, связанных с действием. |
Перечисление действий
Возвращает список действий.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
List
|
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"). |
Возвращаемое значение
Действия
Перечисление составляющих действий
Перечисляет действия для составного элемента.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента. |
Возвращаемое значение
Действия
Получение составного действия
Возвращает сведения о составном действии.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия для получения. |
Возвращаемое значение
Действие
Создание вложения действия
Создает новое вложение действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
parent_id | True | string |
Идентификатор системной записи действия, связанного с вложением. |
|
Тип
|
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. Только для физических вложений. |
|
|
Идентификатор файла
|
file_id | string |
Идентификатор файла. Ограничение символов: 36. Только для физических вложений. |
|
|
Идентификатор эскиза
|
thumbnail_id | string |
Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений. |
|
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
Возвращаемое значение
Созданное вложение действия
Создание настраиваемого поля действия
Создает настраиваемое поле действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Объект, представляющий настраиваемое поле для создания. |
Возвращаемое значение
Созданное настраиваемое поле действия
Создание составного действия
Создает новое составное действие.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Составной идентификатор
|
constituent_id | True | string |
Системный идентификатор записи компонента, связанного с действием. |
|
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 |
Расположение действия. |
|
|
Идентификатор возможности
|
opportunity_id | string |
Идентификатор системной записи возможности, связанной с действием. |
|
|
Результат
|
outcome | string |
Результат действия. |
|
|
Priority
|
priority | string |
Приоритет действия. |
|
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
|
Author
|
author | string |
Автор сводки и описания действия. Если он не указан, у вас будет набор по умолчанию на основе учетной записи пользователя. Ограничение символов: 50. |
|
|
Сбор средств
|
fundraisers | array of string |
Набор идентификаторов системных записей для сборщиков средств, связанных с действием. |
Возвращаемое значение
Созданное действие
Список настраиваемых полей действия
Выводит настраиваемые поля для действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор действия
|
action_id | True | string |
Идентификатор системной записи действия. |
Возвращаемое значение
Пользовательские поля
Определения
ConstituentApi.ActionAttachmentRead
Вложение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи вложения. |
|
Идентификатор действия
|
parent_id | string |
Идентификатор системной записи действия, связанного с вложением. |
|
Тип
|
type | string |
Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом. |
|
Имя
|
name | string |
Имя вложения. Ограничение символов: 150. |
|
Date
|
date | date-time |
Дата вложения. |
|
URL
|
url | string |
URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений. |
|
Имя файла
|
file_name | string |
Имя файла. Ограничение символов: 36. Только для физических вложений. |
|
Идентификатор файла
|
file_id | string |
Идентификатор файла. Ограничение символов: 36. Только для физических вложений. |
|
Идентификатор эскиза
|
thumbnail_id | string |
Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений. |
|
URL-адрес эскиза
|
thumbnail_url | string |
URL-адрес эскиза. Для физических вложений, которые являются только изображениями. Содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам. |
|
Тип контента
|
content_type | string |
Тип контента. Только для физических вложений. |
|
Размер файла
|
file_size | integer |
Размер файла в байтах. Только для физических вложений. |
|
Метки
|
tags | array of string |
Теги, связанные с вложением. |
ConstituentApi.ActionCustomFieldRead
Настраиваемое поле
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи настраиваемого поля. |
|
Идентификатор действия
|
parent_id | string |
Идентификатор системной записи действия, связанного с настраиваемым полем. |
|
Категория
|
category | string |
Категория настраиваемого поля. |
|
Тип
|
type | string |
Тип данных, которые представляет настраиваемое поле. |
|
Ценность
|
value |
Значение настраиваемого поля. |
|
|
Текстовое значение
|
text_value | string |
Текстовое значение настраиваемого поля. |
|
Числовое значение
|
number_value | integer |
Числовое значение настраиваемого поля. |
|
Значение даты
|
date_value | date |
Значение даты настраиваемого поля. |
|
Значение валюты
|
currency_value | double |
Значение валюты настраиваемого поля. |
|
Логическое значение
|
boolean_value | boolean |
Логическое значение настраиваемого поля. |
|
Значение записи таблицы
|
codetableentry_value | string |
Значение записи таблицы настраиваемого поля. |
|
Значение составного идентификатора
|
constituentid_value | string |
Значение составного идентификатора настраиваемого поля. |
|
day
|
fuzzydate_value.d | integer |
День в нечеткой дате. |
|
month
|
fuzzydate_value.m | integer |
Месяц в нечеткой дате. |
|
год
|
fuzzydate_value.y | integer |
Год в нечеткой дате. |
|
Date
|
date | date |
Дата настраиваемого поля. |
|
Комментарий
|
comment | string |
Комментарий к пользовательскому полю. Ограничение символов: 50. |
|
Дата добавления
|
date_added | date-time |
Дата создания настраиваемого поля. |
|
Дата изменения
|
date_modified | date-time |
Дата последнего изменения настраиваемого поля. |
ConstituentApi.ActionRead
Действие
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор системной записи действия. |
|
Составной идентификатор
|
constituent_id | string |
Системный идентификатор записи компонента, связанного с действием. |
|
Категория
|
category | string |
Канал или намерение составного взаимодействия. |
|
Завершённый?
|
completed | boolean |
Завершено ли действие? Если система настроена для использования пользовательских состояний действий, это значение основано на значении состояния действия. |
|
Дата завершения
|
completed_date | date-time |
Дата завершения действия. |
|
Date
|
date | date-time |
Дата действия. |
|
Замечание
|
description | string |
Подробное объяснение, подробное описание сводки действий. |
|
Направление
|
direction | string |
Направление действия. |
|
Сбор средств
|
fundraisers | array of string |
Набор идентификаторов системных записей для сборщиков средств, связанных с действием. |
|
Местоположение
|
location | string |
Расположение действия. |
|
Идентификатор возможности
|
opportunity_id | string |
Идентификатор системной записи возможности, связанной с действием. |
|
Результат
|
outcome | string |
Результат действия. |
|
Priority
|
priority | string |
Приоритет действия. |
|
Время запуска
|
start_time | string |
Время начала действия. Используется 24-часовое время в формате HH:mm. |
|
Время окончания
|
end_time | string |
Время окончания действия. Используется 24-часовое время в формате HH:mm. |
|
Состояние
|
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
|
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 | string |
Идентификатор только что созданного действия. |
ConstituentApi.CreatedActionAttachment
Созданное вложение действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного вложения действия. |
ConstituentApi.CreatedActionCustomField
Созданное настраиваемое поле действия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор только что созданного настраиваемого поля действия. |