Запрос Blackbaud RENXT (предварительная версия)
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 | Блэкбауд. Inc |
| Веб-сайт | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Политика конфиденциальности | https://www.blackbaud.com/privacy-shield |
| Категории | Продажи и CRM; Продуктивность |
Edge NXT Raiser — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.
Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления запросами и связанными сущностями, найденными в Пограничном NXT The Raiser.
Дополнительные сведения см. в документации.
Предпосылки
Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.
Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .
Как получить учетные данные?
Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.
Известные проблемы и ограничения
Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Запуск задания запроса |
Запускает фоновое задание для выполнения указанного запроса. |
| Запуск задания нерегламентированного запроса |
Запускает фоновое задание для выполнения указанного определения нерегламентированного запроса. |
| Запуск задания статического запроса обновления |
Запускает фоновое задание для обновления сохраненных ключей для указанного статического запроса. |
| Перечисление запросов |
Возвращает список запросов. |
| Получение состояния задания запроса |
Возвращает сведения о задании выполнения фонового запроса. |
Запуск задания запроса
Запускает фоновое задание для выполнения указанного запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип
|
v_query_type_id | True | integer |
Отфильтруйте набор запросов для тех, кто имеет определенный тип запроса. |
|
Query
|
id | True | integer |
Выполняемый запрос. |
|
Формат вывода
|
output_format | string |
Указывает выходной формат для файла результатов запроса. |
|
|
Режим форматирования
|
formatting_mode | string |
Указывает, следует ли применять форматирование к результатам запроса. |
|
|
Режим создания SQL
|
sql_generation_mode | string |
Указывает, как следует обрабатывать поля выбора запроса. При выборе параметра "Запрос" выходные данные будут содержать поля выбора, определенные для запроса плюс QRECID. При выборе параметра "Экспорт" выходные данные будут содержать поля выбора, определенные только для запроса. При выборе параметра Report выходные данные будут включать только QRECID. |
|
|
Используйте статический запрос?
|
use_static_query_id_set | boolean |
Используйте статический запрос в качестве источника записей (если нет, запрос будет выполняться динамически)? |
|
|
Filename
|
results_file_name | string |
Имя скачиваемого файла без расширения файла. |
Возвращаемое значение
Запущено задание запроса
Запуск задания нерегламентированного запроса
Запускает фоновое задание для выполнения указанного определения нерегламентированного запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Определение запроса
|
query | True | object |
Представление JSON определения запроса. |
|
Формат вывода
|
output_format | string |
Указывает выходной формат для файла результатов запроса. |
|
|
Режим форматирования
|
formatting_mode | string |
Указывает, следует ли применять форматирование к результатам запроса. |
|
|
Filename
|
results_file_name | string |
Имя скачиваемого файла без расширения файла. |
Возвращаемое значение
Запущено задание запроса
Запуск задания статического запроса обновления
Запускает фоновое задание для обновления сохраненных ключей для указанного статического запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип
|
v_query_type_id | True | integer |
Отфильтруйте набор запросов для тех, кто имеет определенный тип запроса. |
|
Query
|
id | True | integer |
Выполняемый запрос. |
Возвращаемое значение
Запущено задание запроса
Перечисление запросов
Возвращает список запросов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип
|
query_type_id | integer |
Отфильтруйте набор запросов для тех, кто имеет определенный тип запроса. |
|
|
Категория
|
category | integer |
Отфильтруйте набор запросов для тех, кто имеет определенную категорию. |
|
|
Формат
|
query_format | string |
Отфильтруйте набор запросов для тех, кто имеет определенный формат. |
|
|
Поиск текста
|
search_text | string |
Текст поиска по полю имени для фильтрации результатов. |
|
|
Избранное только?
|
my_fav_queries_only | boolean |
Включить только избранные запросы? |
|
|
Только мои запросы?
|
my_queries_only | boolean |
Включить только созданные запросы? |
|
|
Только объединенные запросы?
|
merged_queries_only | boolean |
Включить только объединенные запросы? |
|
|
Исключите запросы списка?
|
list_queries | string |
Исключите запросы списка запросов? |
|
|
Сортировка столбца
|
sort_column | string |
Сортируйте результаты по указанному столбцу. |
|
|
Сортировка по убыванию?
|
sort_descending | boolean |
Сортируйте результаты в порядке убывания? |
|
|
Добавлен или после
|
date_added | date-time |
Отфильтруйте результаты по запросам, созданным по указанной дате (например, "2020-09-18T04:13:56Z"). |
|
|
Добавлен по идентификатору
|
added_by | string |
Отфильтруйте результаты по запросам, добавленным указанным идентификатором пользователя. |
|
|
Лимит
|
limit | integer |
Представляет количество возвращаемых записей. Значение по умолчанию равно 50. Максимальное значение — 200. |
|
|
Смещение
|
offset | integer |
Представляет количество пропускаемых записей. Для использования с разбивкой на страницы. |
Возвращаемое значение
Запросы
Получение состояния задания запроса
Возвращает сведения о задании выполнения фонового запроса.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
job_id | True | string |
Идентификатор системной записи задания выполнения запроса. |
|
Включите URL-адрес результатов?
|
include_read_url | string |
Включите URL-адрес в файл результатов запроса? |
|
|
Ликвидация содержимого
|
content_disposition | string |
Указывает, как будут просматриваться результаты запроса. |
Возвращаемое значение
Задание выполнения запроса
Определения
QueryApi.ExecuteQueryResponse
Запущено задание запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор задания
|
id | string |
Идентификатор задания запроса. |
|
Состояние
|
status | string |
Состояние результирующего задания запроса. "Ожидание" — задание было в очереди, но еще не запущено. "Выполняется" — задание выполняется. "Завершено" — задание успешно завершено. "Сбой" — задание завершилось ошибкой. "Отмена" — запрос на отмену задания (но может завершиться успешно). "Отменено" - задание было отменено. "Регулирование" — задание было регулированием и будет выполняться, когда пространство доступно. |
|
Message
|
message | string |
Сообщение, связанное с ответом. |
QueryApi.QueryExecutionJob
Задание выполнения запроса
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор задания
|
id | string |
Идентификатор задания запроса. |
|
Состояние
|
status | string |
Состояние результирующего задания запроса. "Ожидание" — задание было в очереди, но еще не запущено. "Выполняется" — задание выполняется. "Завершено" — задание успешно завершено. "Сбой" — задание завершилось ошибкой. "Отмена" — запрос на отмену задания (но может завершиться успешно). "Отменено" - задание было отменено. "Регулирование" — задание было регулированием и будет выполняться, когда пространство доступно. |
|
Количество строк
|
row_count | integer |
Количество записей в запросе. |
|
Универсальный код ресурса (URI) результатов запроса
|
sas_uri | string |
Универсальный код ресурса (URI) для доступа к результатам запроса. Этот универсальный код ресурса (URI) следует рассматривать как безопасные учетные данные для доступа к результатам запроса. Значение считается конфиденциальным, а URI истекает через 15 минут. |
QueryApi.QuerySummary
Query
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | integer |
Идентификатор системной записи запроса. |
|
Имя
|
name | string |
Уникальное имя запроса. |
|
Description
|
description | string |
Описание запроса. |
|
Тип
|
type | string |
Тип запроса. |
|
Идентификатор типа
|
type_id | integer |
Идентификатор системной записи типа запроса. |
|
Категория
|
category | string |
Категория запроса. |
|
Идентификатор категории
|
category_id | integer |
Идентификатор системной записи категории запроса. |
|
Формат
|
format | string |
Формат запроса. |
|
Просмотр поддерживаемых?
|
view_supported | boolean |
Можно ли просматривать запрос? |
|
Поддерживается изменение?
|
edit_supported | boolean |
Редактируется ли запрос? |
|
Избранное?
|
favorite | boolean |
Является ли запрос избранным? |
|
Есть ли поля с запросом?
|
has_ask_fields | boolean |
Включает ли запрос поля фильтра с оператором ask? |
|
Создано по запросу?
|
created_by_query | boolean |
Был ли запрос создан в модуле запроса? |
|
Поддерживаемые режимы выполнения
|
supported_execution_modes | string |
Поддерживаемые режимы выполнения. |
|
Может ли измениться?
|
can_modify | boolean |
Может ли пользователь изменить запрос? |
|
Может ли выполняться?
|
can_execute | boolean |
Может ли пользователь выполнить запрос? |
|
Другие могут изменить?
|
others_can_modify | boolean |
Могут ли другие пользователи изменить запрос? |
|
Другие могут выполнять?
|
others_can_execute | boolean |
Могут ли другие пользователи выполнить запрос? |
|
Является ли список запросов?
|
query_list | boolean |
Запрос списка запросов? |
|
Подавление дубликатов?
|
suppress_duplicates | boolean |
Дубликаты подавляются в результатах запроса? |
|
Выбор из имени запроса
|
select_from_query_name | string |
Имя запроса, используемого в качестве базового выбора для запроса. |
|
Выбор из идентификатора запроса
|
select_from_query_id | integer |
Идентификатор системной записи запроса, используемого в качестве базового выбора для запроса. |
|
Последнее выполнение
|
date_last_run | date-time |
Дата последнего выполнения запроса. |
|
Количество записей
|
num_records | integer |
Количество записей, найденных при последнем запуске запроса. |
|
Астрономическое время счета
|
elapsed_ms | integer |
Время последнего выполнения запроса (в миллисекундах). |
|
Дата создания
|
date_added | date-time |
Дата создания запроса. |
|
Кем создано:
|
added_by | string |
Имя пользователя, создавшего запрос. |
|
Изменение даты
|
date_changed | date-time |
Дата последнего изменения запроса. |
|
Изменено
|
last_changed_by | string |
Имя пользователя, который последний раз изменил запрос. |
QueryApi.QuerySummaryCollection
Запросы
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
queries
|
queries | array of QueryApi.QuerySummary |
Набор элементов, включенных в ответ. |