Бизнес-карта
Бизнес-карта — это самая гибкая платформа программного обеспечения для обеспечения гибкости предприятия на основе результатов. Несовпаденная функциональность объединяет несколько инструментов в один, что позволяет масштабировать доступное развертывание, видимость всех проектов и портфеля и выравнивание по целям, чтобы обеспечить быструю работу качества. Соединитель Businessmap можно использовать для отражения изменений во внешних инструментах (например, отслеживания проблем, электронной почты, средств отслеживания времени и т. д.) на карточках Kanban.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка бизнес-карты |
| URL | https://businessmap.io/customer-support |
| Адрес электронной почты | support@businessmap.io |
| Метаданные соединителя | |
|---|---|
| Publisher | Бизнес-карта |
| Веб-сайт | https://businessmap.io |
| Политика конфиденциальности | https://businessmap.io/privacy-policy |
| Категории | Управление бизнесом; Бизнес-аналитика |
Бизнес-карта — это самая гибкая платформа программного обеспечения для обеспечения гибкости предприятия на основе результатов. Это помогает менеджерам получать видимость во всех проектах, подключать планирование к выполнению и управлять непрерывной оптимизацией рабочих процессов доставки. Созданная с учетом масштаба бизнес-карта может легко расшириться от одной группы доставки до стратегического портфеля. Несовпаденная функциональность объединяет несколько инструментов в один, что позволяет масштабировать доступное развертывание, видимость всех проектов и портфеля и выравнивание по целям, чтобы обеспечить быструю работу качества. Бизнес-карта является ведущей платформой Kanban для эффективного управления проектами и доставки.
Это соединитель Бизнес-карты для Power Automate. Он работает непосредственно с данными из Businessmap через наш последний API версии 2. Соединитель Businessmap можно использовать для отражения изменений внешних инструментов на карточках Kanban или для чтения данных из Бизнес-карты и использования его в сторонних соединителях. Посетите раздел интеграции в нашей базе знаний , чтобы получить некоторые реальные примеры использования соединителя.
Предпосылки
- Чтобы использовать этот соединитель, требуется учетная запись Businessmap и пользователь с разрешениями на доступ к API. Sign-Up здесь и создайте и учетную запись, чтобы попробовать ее.
Получение учетных данных
Ключ API можно найти в меню "API" в профиле.
Начало работы с соединителем
Соединитель имеет один триггер, который является общим и обрабатывает все события. Задайте этот триггер в качестве первого шага в потоке, когда вы хотите получать события из Бизнес-карты. Следующее действие должно быть проверкой "Условие", где вы добавите фильтр по "событию" и продолжить, только если тип события соответствует интересующему вас типу. Здесь можно найти список со всеми событиями и возможными значениями, которые будут запускать триггер. Следующий шаг обычно будет "Получить карточку по идентификатору", он получит все сведения из карточки, и вы сможете использовать эти данные в потоке, который следует.
Известные проблемы и ограничения
Некоторые ограничения применяются, чтобы гарантировать, что продукт и наши API работают так же гладко и эффективно, как это возможно. Точные ограничения API зависят от плана обслуживания. Дополнительные сведения об этом см. здесь
Распространенные ошибки и средства устранения неполадок
Если возникла ошибка 429, это означает, что вы достигли ограничений API. Сведения об ошибке сообщают, сколько времени нужно ждать, прежде чем вы сможете отправить следующий запрос. Все остальные ошибки содержат сообщения, объясняющие точную причину ошибки.
Часто задаваемые вопросы
У нас есть обширный раздел Базы знаний , и если у вас есть какой-либо вопрос, вы не можете найти ответ, обратитесь к нам , и мы будем рады помочь.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
| Subdomain | струна | Укажите поддомен учетной записи Businessmap | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Create Subtask (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте создание подзадаки .
|
| Get Boards (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте Get Boards .
|
| Get Lanes (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте Get Lanes .
|
| Get Types (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте типы get .
|
| Архивная или неархивная карточка |
Добавьте карточку в архив или извлеките ее из архива. |
| Архивная карточка (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте архивную или неархивную карточку .
|
| Блокировать или разблокировать карточку (не рекомендуется) [DEPRECATED] |
(не рекомендуется) Блокировка, разблокировка или изменение причин блокировки карточки. |
| Блокировать карточку |
Блокировать карточку. |
| Время журнала |
Время входа в карточку. |
| Время журнала (количество секунд) (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте время журнала .
|
| Добавление комментария |
Добавьте комментарий к карточке или инициативе. |
| Добавление комментария (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте добавление примечания .
|
| Карточки ссылок |
Свяжите карточку с существующей карточкой. |
| Настройка значения настраиваемого поля |
Задайте значение настраиваемого поля. |
| Обновление карточки |
Обновите свойства карточки (заголовок, описание, приоритет и т. д.). Если достигнуто ограничение времени ожидания или ограничения API, попробуйте разбить параметры настраиваемых полей, стикеров и тегов на отдельные действия. |
| Обновление карточки (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте карточку обновления .
|
| Отмена или восстановление карточки |
Отмените карточку или восстановите ранее удаленную карточку. |
| Отмена связи карточек |
Удалите ссылку между двумя карточками. |
| Отправка вложения |
Отправьте вложение на карточку. |
| Перемещение карточки |
Переместите карточку на новый столбец, полосу, рабочий процесс или доску. |
| Перемещение карточки (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте карточку перемещения .
|
| Получение вложений карточки |
Получите список со всеми вложениями для указанной карточки. |
| Получение всех карточек |
Получите все карточки из выбранной доски. Ответ содержит до 200 карточек. Для более чем 200 карточек используйте разбиение по страницам. |
| Получение всех карточек (не рекомендуется) [DEPRECATED] |
Это действие устарело. Используйте вместо этого все карточки .
|
| Получение имени {Object} |
Получите имя объекта на основе его идентификатора. Вспомогательные функции, используемые при получении имени доски, рабочего процесса, столбца и т. д. на основе его идентификатора. |
| Получение карточки по идентификатору |
Получение сведений о карточке по внутреннему идентификатору. |
| Получение карточки по идентификатору (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте get Card by ID .
|
| Получение карточки по пользовательскому идентификатору |
Найдите карточку по идентификатору пользовательской карты. Если найдено несколько карточек, будет возвращено только первое. Используйте параметр Board для фильтрации поиска по доскам. |
| Получение рабочих процессов (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте рабочие процессы Get .
|
| Получение столбцов доски (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте метод Get Columns .
|
| Разблокировка карточки |
Разблокируйте карточку. |
| Скачивание вложения |
Скачайте вложение с карточки. Содержимое файла возвращается в виде строки в кодировке Base64. |
| Создание карточки |
Создайте карточку в выбранной доске. Чтобы задать настраиваемые поля, наклейки и теги используются в сочетании с "Обновить карточку". |
| Создание карточки (не рекомендуется) [DEPRECATED] |
Это действие устарело. Вместо этого используйте карточку создания .
|
| Создание подзадаки |
Создайте новую подзадаку карточки или инициативы. |
| Удаление карточки (не рекомендуется) [DEPRECATED] |
(не рекомендуется) Удаление карточки. |
| Установка или отмена набора тегов |
Добавление тегов в карточку или удаление назначенных тегов из карточки |
| Установка или отмена настройки стикеров |
Добавление наклейки на карточку или удаление назначенных наклейки из карточки |
Create Subtask (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте создание подзадаки .
(не рекомендуется) Создает новую подзадаку карточки или инициативы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Всегда используйте: application/json |
|
Тип контента
|
Accept | True | string |
Всегда используйте: application/json |
|
Идентификатор родительской карточки
|
taskparent | integer |
Идентификатор родительской карточки |
|
|
Название
|
title | string |
title |
|
|
Назначенное лицо
|
assignee | string |
имя пользователя назначаемого пользователя |
Get Boards (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте Get Boards .
(не рекомендуется) Получите все доски из учетной записи.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
board_id
|
data.board_id | integer |
board_id |
|
workspace_id
|
data.workspace_id | integer |
workspace_id |
|
is_archived
|
data.is_archived | integer |
is_archived |
|
имя
|
data.name | string |
имя |
Get Lanes (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте Get Lanes .
(не рекомендуется) Возвращает все полосы для указанной доски.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
board_id | True | string |
Доска, чтобы получить полосы для. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
lane_id
|
data.lane_id | integer |
lane_id |
|
workflow
|
data.workflow | integer |
workflow |
|
parent_lane_id
|
data.parent_lane_id | integer |
parent_lane_id |
|
позиция
|
data.position | integer |
позиция |
|
имя
|
data.name | string |
имя |
|
описание
|
data.description | string |
описание |
|
color
|
data.color | string |
color |
Get Types (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте типы get .
(не рекомендуется) Возвращает все типы в учетной записи.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
type_id
|
data.type_id | integer |
type_id |
|
icon_type
|
data.icon_type | integer |
icon_type |
|
icon_id
|
data.icon_id | integer |
icon_id |
|
имя
|
data.name | string |
имя |
|
описание
|
data.description | string |
описание |
|
color
|
data.color | string |
color |
|
card_color_sync
|
data.card_color_sync | integer |
card_color_sync |
|
all_properties_are_locked
|
data.all_properties_are_locked | integer |
all_properties_are_locked |
|
availability
|
data.availability | integer |
availability |
|
is_enabled
|
data.is_enabled | integer |
is_enabled |
Архивная или неархивная карточка
Добавьте карточку в архив или извлеките ее из архива.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Действие
|
is_archived | True | integer |
Выбор действия |
Архивная карточка (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте архивную или неархивную карточку .
(не рекомендуется) Переместите карточку в архив. Карточка не должна быть заблокирована, и она должна находиться в столбце "Готово" или "Архив столбца".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
cardid | True | string |
идентификатор карточки |
|
Версия
|
version | string |
version |
Блокировать или разблокировать карточку (не рекомендуется) [DEPRECATED]
(не рекомендуется) Блокировка, разблокировка или изменение причин блокировки карточки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
boardid | True | string |
Выбор доски из раскрывающегося списка |
|
Идентификатор карточки
|
taskid | True | string |
идентификатор карточки |
|
Тип события
|
event | True | string | |
|
Причина блокировки
|
blockreason | string |
причина блокировки |
Блокировать карточку
Блокировать карточку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Причина блокировки
|
reason_id | True | string |
Выбор причины блокировки |
|
Комментарий
|
comment | string |
Добавление примечания к причине блокировки |
Время журнала
Время входа в карточку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | string |
Внутренний идентификатор карточки |
|
Единица времени
|
time_unit | True | string |
Единица времени |
|
Продолжительность
|
time | True | integer |
Продолжительность |
|
Комментарий
|
comment | string |
Комментарий |
Время журнала (количество секунд) (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте время журнала .
(не рекомендуется) Время входа в карточку. Время регистрируется в секундах.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Всегда используйте: application/json |
|
Тип контента
|
Accept | True | string |
Всегда используйте: application/json |
|
Идентификатор карточки
|
card_id | string |
Внутренний идентификатор карточки |
|
|
Time
|
time | string |
Время в секундах |
|
|
Комментарий
|
comment | string |
Комментарий |
Добавление комментария
Добавьте комментарий к карточке или инициативе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Комментарий
|
text | True | string |
Комментарий |
Добавление комментария (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте добавление примечания .
(не рекомендуется) Добавляет комментарий к карточке или инициативе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Всегда используйте: application/json |
|
Тип контента
|
Accept | True | string |
Всегда используйте: application/json |
|
Идентификатор карточки
|
taskid | string |
идентификатор карточки |
|
|
Комментарий
|
comment | string |
Комментарий |
Карточки ссылок
Свяжите карточку с существующей карточкой.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Будет связан как
|
link_type | True | string |
Выбор типа ссылки |
|
Идентификатор карточки
|
linked_card_id | True | integer |
Идентификатор карточки для связи с текущей картой |
Настройка значения настраиваемого поля
Задайте значение настраиваемого поля.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Идентификатор платы
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Имя поля
|
field_id | True | integer |
Выбор настраиваемого поля |
|
Ценность
|
values | True | string |
Выберите из раскрывающегося списка или введите пользовательские значения, разделенные запятыми |
Обновление карточки
Обновите свойства карточки (заголовок, описание, приоритет и т. д.). Если достигнуто ограничение времени ожидания или ограничения API, попробуйте разбить параметры настраиваемых полей, стикеров и тегов на отдельные действия.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Рабочий процесс
|
workflow_id | integer |
Рабочий процесс должен быть выбран из раскрывающегося списка |
|
|
Template
|
template_id | integer |
Выбор шаблона |
|
|
колонна
|
column_id |
Выбор имени столбца или идентификатора столбца в качестве настраиваемого значения |
||
|
Переулок
|
lane_id |
Выберите lane или ввод имени или идентификатора в качестве настраиваемого значения |
||
|
Название
|
title | string |
Заголовок карточки |
|
|
Description
|
description | string |
Описание карточки |
|
|
Пользовательский идентификатор
|
custom_id | string |
Пользовательский идентификатор |
|
|
Владелец
|
owner_user_id | integer |
Выбор владельца карточки |
|
|
Тип
|
type_id | integer |
Выбор типа карточки |
|
|
Размер карточки
|
size | double |
Размер карточки |
|
|
Priority
|
priority | integer |
Выбор приоритета |
|
|
Цвет
|
color | string |
Цвет (шестнадцатеричный, например #0000000) |
|
|
Deadline
|
deadline | string |
Крайний срок (формат: гггг-MM-DD) |
|
|
Запланированная дата начала
|
planned_start_date | string |
Запланированная дата начала (формат: YYYY-MM-DD) (только инициативы) |
|
|
Дата запланированного окончания
|
planned_end_date | string |
Запланированная дата окончания (формат: YYYY-MM-DD) (только инициативы) |
|
|
Фактическое время начала
|
actual_start_time | string |
Фактическое время начала (формат: ггГГ-ММ-ДДTHH:мм:ssZ) (только инициативы) |
|
|
Фактическое время окончания
|
actual_end_time | string |
Фактическое время окончания (формат: YYYY-MM-DDTHH:mm:ssZ) (только инициативы) |
|
|
Наклейки
|
stickers | string |
Выберите наклейки или добавьте их в виде текста, разделенного запятыми |
|
|
Метки
|
tags | string |
Выберите теги или добавьте их в виде текста, разделенного запятыми |
|
|
Имя
|
field_id | integer |
Выбор настраиваемого поля |
|
|
Ценность
|
value | string |
Значение настраиваемого поля |
Возвращаемое значение
- Тело
- getCardResponse
Обновление карточки (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте карточку обновления .
(не рекомендуется) Обновление свойств карточки (название, описание, приоритет и т. д.)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Всегда задано значение: application/json |
|
Принять
|
Accept | True | string |
Всегда задано значение: application/json |
|
Идентификатор платы
|
boardid | integer |
Выбор доски из раскрывающегося списка |
|
|
Идентификатор карточки
|
taskid | integer |
идентификатор карточки |
|
|
Название
|
title | string |
title |
|
|
Description
|
description | string |
Сведения о карточке |
|
|
Priority
|
priority | string | ||
|
Назначенное лицо
|
assignee | string |
имя пользователя назначаемого пользователя |
|
|
Цвет
|
color | string |
Шестнадцатеричный код цвета, как это #F37325 |
|
|
Size
|
size | integer |
size |
|
|
Метки
|
tags | string |
Несколько тегов должны быть разделены пробелом |
|
|
Настраиваемые поля
|
cfields | string |
Форматированный список пользовательских полей и их значения {"field1":"value1","field2":"value2"} |
|
|
Deadline
|
deadline | string |
дата крайнего срока в этом формате гггг-MM-DD |
|
|
Внешний канал
|
extlink | string |
внешняя ссылка |
|
|
Тип
|
type | string |
имя типа, который требуется задать |
Отмена или восстановление карточки
Отмените карточку или восстановите ранее удаленную карточку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Действие
|
is_discarded | True | integer |
Выбор действия |
Отмена связи карточек
Удалите ссылку между двумя карточками.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки отмены связи
|
card_id | True | integer |
Введите идентификатор карточки |
|
Связанная как
|
link_type | True | string |
Выбор типа ссылки |
|
Идентификатор карточки
|
linked_card_id | True | integer |
Введите идентификатор связанной карточки |
Отправка вложения
Отправьте вложение на карточку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Имя файла
|
file_name | True | string |
Введите имя файла |
|
Content
|
content | True | binary |
Предоставление содержимого файла (base64) |
Возвращаемое значение
Перемещение карточки
Переместите карточку на новый столбец, полосу, рабочий процесс или доску.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Рабочий процесс
|
workflow_id | True | integer |
Рабочий процесс должен быть выбран из раскрывающегося списка |
|
колонна
|
column_id | True |
Выбор имени столбца или идентификатора столбца в качестве настраиваемого значения |
|
|
Переулок
|
lane_id | True |
Выберите lane или ввод имени или идентификатора в качестве настраиваемого значения |
Перемещение карточки (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте карточку перемещения .
(не рекомендуется) При возможности переместите карточку (задачу или инициативу) в столбец.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Всегда используйте: application/json |
|
Тип контента
|
Accept | True | string |
Всегда используйте: application/json |
|
Идентификатор карточки
|
taskid | string |
идентификатор карточки |
|
|
Идентификатор платы
|
boardid | True | string |
Идентификатор доски |
|
колонна
|
column | string |
Имя столбца |
|
|
Переулок
|
lane | string |
Имя полосы |
|
|
Position
|
position | string |
Положение карточки в столбце |
|
|
Превышение причины
|
exceedingreason | string |
превышение причины |
Получение вложений карточки
Получите список со всеми вложениями для указанной карточки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
Возвращаемое значение
Получение всех карточек
Получите все карточки из выбранной доски. Ответ содержит до 200 карточек. Для более чем 200 карточек используйте разбиение по страницам.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Board
|
board_ids | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Идентификаторы пользовательских карточек
|
custom_ids | array |
Ввод пользовательских идентификаторов |
|
|
Страница
|
page | integer |
Номер страницы |
|
|
Государство
|
state | string |
Значение состояния карточек, которые требуется получить. По умолчанию это активное состояние. |
Возвращаемое значение
- Тело
- getAllCardsResponse
Получение всех карточек (не рекомендуется) [DEPRECATED]
Это действие устарело. Используйте вместо этого все карточки .
(не рекомендуется) Получите все карточки из заданной доски.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
boardid | True | string |
Выбор доски из раскрывающегося списка |
Получение имени {Object}
Получите имя объекта на основе его идентификатора. Вспомогательные функции, используемые при получении имени доски, рабочего процесса, столбца и т. д. на основе его идентификатора.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Item
|
item | True | string |
Выбор типа объекта |
|
Идентификатор
|
id | True | integer |
Введите идентификатор объекта |
Возвращаемое значение
Получение карточки по идентификатору
Получение сведений о карточке по внутреннему идентификатору.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
Возвращаемое значение
- Тело
- getCardResponse
Получение карточки по идентификатору (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте get Card by ID .
(не рекомендуется) Получение карточки по идентификатору
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
boardid | True | string |
Выбор доски из раскрывающегося списка |
|
Идентификатор карточки
|
taskid | True | string |
идентификатор карточки |
|
Получить историю
|
history | string |
Установите значение "Да", если вы хотите получить журнал карточек |
|
|
Получение комментариев
|
comments | string |
Установите значение "да", если вы хотите получить примечания к карточкам |
|
|
Формат текста
|
textformat | string |
текстовый формат, возвращаемый для описания карточки |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
taskid
|
taskid | string |
taskid |
|
boardid
|
boardid | string |
boardid |
|
title
|
title | string |
title |
|
описание
|
description | string |
описание |
|
type
|
type | string |
type |
|
assignee
|
assignee | string |
assignee |
|
Подзадач
|
subtasks | string |
Подзадач |
|
subtaskscomplete
|
subtaskscomplete | string |
subtaskscomplete |
|
color
|
color | string |
color |
|
priority
|
priority | string |
priority |
|
size
|
size | string |
size |
|
срок
|
deadline | string |
срок |
|
deadlineoriginalformat
|
deadlineoriginalformat | string |
deadlineoriginalformat |
|
extlink
|
extlink | string |
extlink |
|
tags
|
tags | string |
tags |
|
leadtime
|
leadtime | integer |
leadtime |
|
блокированный
|
blocked | string |
блокированный |
|
blockedreason
|
blockedreason | string |
blockedreason |
|
имя столбца
|
columnname | string |
имя столбца |
|
lanename
|
lanename | string |
lanename |
|
subtaskdetails
|
subtaskdetails | array of |
subtaskdetails |
|
columnid
|
columnid | string |
columnid |
|
laneid
|
laneid | string |
laneid |
|
позиция
|
position | string |
позиция |
|
workflow
|
workflow | integer |
workflow |
|
workflow_id
|
workflow_id | integer |
workflow_id |
|
URL-адрес
|
attachments.FXPR1VE0LIC9.url | string |
URL-адрес |
|
clientName
|
attachments.FXPR1VE0LIC9.clientName | string |
clientName |
|
uniqueName
|
attachments.FXPR1VE0LIC9.uniqueName | string |
uniqueName |
|
размер файла
|
attachments.FXPR1VE0LIC9.fileSize | float |
размер файла |
|
fileType
|
attachments.FXPR1VE0LIC9.fileType | string |
fileType |
|
статус
|
attachments.FXPR1VE0LIC9.status | string |
статус |
|
URL-адрес
|
attachments.0XC7C1PRR9ZK.url | string |
URL-адрес |
|
clientName
|
attachments.0XC7C1PRR9ZK.clientName | string |
clientName |
|
uniqueName
|
attachments.0XC7C1PRR9ZK.uniqueName | string |
uniqueName |
|
размер файла
|
attachments.0XC7C1PRR9ZK.fileSize | float |
размер файла |
|
fileType
|
attachments.0XC7C1PRR9ZK.fileType | string |
fileType |
|
статус
|
attachments.0XC7C1PRR9ZK.status | string |
статус |
|
columnpath
|
columnpath | string |
columnpath |
|
докладчик
|
reporter | string |
докладчик |
|
настраиваемые поля
|
customfields | array of object |
настраиваемые поля |
|
fieldid
|
customfields.fieldid | integer |
fieldid |
|
имя
|
customfields.name | string |
имя |
|
type
|
customfields.type | string |
type |
|
value
|
customfields.value | string |
value |
|
обязательный
|
customfields.mandatory | boolean |
обязательный |
|
неизменный
|
customfields.immutable | boolean |
неизменный |
|
обновлено
|
updatedat | string |
обновлено |
|
время ведения журнала
|
loggedtime | integer |
время ведения журнала |
|
historydetails
|
historydetails | array of object |
historydetails |
|
тип события
|
historydetails.eventtype | string |
тип события |
|
historyevent
|
historydetails.historyevent | string |
historyevent |
|
taskid
|
historydetails.taskid | string |
taskid |
|
details
|
historydetails.details | string |
details |
|
автор
|
historydetails.author | string |
автор |
|
entrydate
|
historydetails.entrydate | string |
entrydate |
|
historyid
|
historydetails.historyid | string |
historyid |
|
comments
|
comments | array of |
comments |
Получение карточки по пользовательскому идентификатору
Найдите карточку по идентификатору пользовательской карты. Если найдено несколько карточек, будет возвращено только первое. Используйте параметр Board для фильтрации поиска по доскам.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Пользовательский идентификатор карточки
|
custom_ids | True | string |
Ввод пользовательских идентификаторов |
|
Board
|
board_ids | integer |
В раскрывающемся списке должна быть выбрана доска |
Возвращаемое значение
- Тело
- getCardResponse
Получение рабочих процессов (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте рабочие процессы Get .
(не рекомендуется) Получение всех рабочих процессов из заданной доски.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
board_id | True | string |
Board |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
type
|
data.type | integer |
type |
|
позиция
|
data.position | integer |
позиция |
|
is_enabled
|
data.is_enabled | integer |
is_enabled |
|
is_collapsible
|
data.is_collapsible | integer |
is_collapsible |
|
имя
|
data.name | string |
имя |
|
workflow_id
|
data.workflow_id | integer |
workflow_id |
Получение столбцов доски (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте метод Get Columns .
(не рекомендуется) Получение всех столбцов для указанной доски.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
board_id | True | string |
Доска для получения столбцов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
column_id
|
data.column_id | integer |
column_id |
|
workflow
|
data.workflow | integer |
workflow |
|
section
|
data.section | integer |
section |
|
parent_column_id
|
data.parent_column_id | integer |
parent_column_id |
|
позиция
|
data.position | integer |
позиция |
|
имя
|
data.name | string |
имя |
|
описание
|
data.description | string |
описание |
|
color
|
data.color | string |
color |
|
limit
|
data.limit | integer |
limit |
|
cards_per_row
|
data.cards_per_row | integer |
cards_per_row |
|
flow_type
|
data.flow_type | integer |
flow_type |
Разблокировка карточки
Разблокируйте карточку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
Скачивание вложения
Скачайте вложение с карточки. Содержимое файла возвращается в виде строки в кодировке Base64.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Имя файла
|
attachment_id | True | integer |
Выберите вложение или введите идентификатор вложения из "Получить вложения карточки" |
Возвращаемое значение
Создание карточки
Создайте карточку в выбранной доске. Чтобы задать настраиваемые поля, наклейки и теги используются в сочетании с "Обновить карточку".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Рабочий процесс
|
workflow_id | True | integer |
Рабочий процесс должен быть выбран из раскрывающегося списка |
|
Template
|
template_id | integer |
Выбор шаблона |
|
|
колонна
|
column_id | True |
Выбор имени столбца или идентификатора столбца в качестве настраиваемого значения |
|
|
Переулок
|
lane_id | True |
Выберите lane или ввод имени или идентификатора в качестве настраиваемого значения |
|
|
Название
|
title | True | string |
Заголовок карточки |
|
Description
|
description | string |
Описание карточки |
|
|
Пользовательский идентификатор
|
custom_id | string |
Пользовательский идентификатор карточки |
|
|
Владелец
|
owner_user_id | integer |
Выбор владельца карточки |
|
|
Пользователь репортера
|
reporter_user_id | integer |
Выбор репортера из пользователей Businessmap |
|
|
Электронная почта репортера
|
reporter_email | string |
Введите адрес электронной почты репортера, только если пользователь не выбран выше |
|
|
Тип
|
type_id | integer |
Выбор типа карточки |
|
|
Размер карточки
|
size | double |
Размер карточки |
|
|
Priority
|
priority | integer |
Выбор приоритета |
|
|
Цвет
|
color | string |
Цвет (шестнадцатеричный, например #0000000) |
|
|
Deadline
|
deadline | string |
Крайний срок (формат: гггг-MM-DD) |
|
|
Запланированная дата начала
|
planned_start_date | string |
Запланированная дата начала (формат: YYYY-MM-DD) (только инициативы) |
|
|
Дата запланированного окончания
|
planned_end_date | string |
Запланированная дата окончания (формат: YYYY-MM-DD) (только инициативы) |
|
|
Фактическое время начала
|
actual_start_time | string |
Фактическое время начала (формат: ггГГ-ММ-ДДTHH:мм:ssZ) (только инициативы) |
|
|
Фактическое время окончания
|
actual_end_time | string |
Фактическое время окончания (формат: YYYY-MM-DDTHH:mm:ssZ) (только инициативы) |
Возвращаемое значение
- Тело
- getCardResponse
Создание карточки (не рекомендуется) [DEPRECATED]
Это действие устарело. Вместо этого используйте карточку создания .
(не рекомендуется) Создайте карточку в выбранной доске.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | string |
Всегда используйте: application/json |
|
|
Тип контента
|
Accept | string |
Всегда используйте: application/json |
|
|
Идентификатор платы
|
boardid | True | string |
Выбор доски |
|
Название
|
title | string |
title |
|
|
Description
|
description | string |
Сведения о карточке |
|
|
Priority
|
priority | string |
возможные значения: низкий, средний, высокий, критически важный |
|
|
Назначенное лицо
|
assignee | string |
имя пользователя назначаемого пользователя |
|
|
Цвет
|
color | string |
Шестнадцатеричный код цвета, как это #F37325 |
|
|
Size
|
size | string |
size |
|
|
Метки
|
tags | string |
Несколько тегов должны быть разделены пробелом |
|
|
Настраиваемые поля
|
cfields | string |
Форматированный список пользовательских полей и их значения {"field1":"value1","field2":"value2"} |
|
|
Deadline
|
deadline | string |
дата крайнего срока в этом формате гггг-MM-DD |
|
|
Внешний канал
|
extlink | string |
внешняя ссылка |
|
|
Тип
|
type | string |
имя типа, который требуется задать |
|
|
Шаблон карточки
|
template | string |
Имя шаблона карточки, который вы хотите применить |
|
|
Имя столбца
|
column | string |
точное имя столбца |
|
|
Переулок
|
lane | string |
Имя полосы |
|
|
Position
|
position | string |
Положение карточки в столбце |
|
|
Превышение причины
|
exceedingreason | string |
превышение причины |
Создание подзадаки
Создайте новую подзадаку карточки или инициативы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Description
|
description | True | string |
Описание подзадаки |
|
Владелец
|
owner_user_id | string |
Выбор пользователя |
|
|
Состояние подзадаки
|
is_finished | integer |
Выберите состояние подзадаки |
Удаление карточки (не рекомендуется) [DEPRECATED]
(не рекомендуется) Удаление карточки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
boardid | True | string |
Выбор доски из раскрывающегося списка |
|
Идентификатор карточки
|
taskid | True | string |
идентификатор карточки |
Установка или отмена набора тегов
Добавление тегов в карточку или удаление назначенных тегов из карточки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Действие
|
action | True | string |
Выбор для задания или отмены набора тегов |
|
Метки
|
tags | True | string |
Выберите один тег из раскрывающегося списка или введите несколько тегов, разделенных запятыми |
|
Если тег отсутствует
|
missing_tags | integer |
Выбор требуемого поведения при отсутствии тега |
Установка или отмена настройки стикеров
Добавление наклейки на карточку или удаление назначенных наклейки из карточки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор карточки
|
card_id | True | integer |
Введите идентификатор карточки |
|
Board
|
board_id | True | integer |
В раскрывающемся списке должна быть выбрана доска |
|
Действие
|
action | True | string |
Выбор настройки или отмены настройки стикеров |
|
Наклейки
|
stickers | True | string |
Выберите одну наклейку из раскрывающегося списка или введите несколько стикеров, разделенных запятой |
|
Если наклейка отсутствует
|
missing_stickers | integer |
Выбор требуемого поведения при отсутствии наклейки |
Триггеры
| Общий триггер |
Триггеры для любого действия на доске. Используйте control/Condition или Control/Switch для управления потоком для разных триггеров. Ниже приведен частичный список поддерживаемых типов событий: "Созданная карточка", "Карточка перемещена", "Сведения об карточке изменены", "Карточка заблокирована", \n\n Следующий шаг после триггера должен быть "Получить карточку по идентификатору", чтобы можно было использовать все сведения о карточке \n\nиспользовать элемент управления или условие для идентификатора автора в двунаправленных интеграции, чтобы предотвратить циклы |
Общий триггер
Триггеры для любого действия на доске. Используйте control/Condition или Control/Switch для управления потоком для разных триггеров. Ниже приведен частичный список поддерживаемых типов событий: "Созданная карточка", "Карточка перемещена", "Сведения об карточке изменены", "Карточка заблокирована", \n\n Следующий шаг после триггера должен быть "Получить карточку по идентификатору", чтобы можно было использовать все сведения о карточке \n\nиспользовать элемент управления или условие для идентификатора автора в двунаправленных интеграции, чтобы предотвратить циклы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор платы
|
board_id | True | string |
Выбор доски |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
компания
|
company | string |
компания |
|
событие
|
event | string |
событие |
|
user_id
|
user_id | integer |
user_id |
|
board_id
|
board_id | integer |
board_id |
|
card_id
|
card_id | integer |
card_id |
Определения
downloadAttachmentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя файла
|
data.file_name | string |
Имя файла вложения |
|
Content
|
data.content | binary |
Содержимое вложения (base64) |
getAllCardsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Все страницы
|
data.pagination.all_pages | integer |
Общее количество страниц |
|
Текущая страница
|
data.pagination.current_page | integer |
Текущая страница |
|
Результаты на страницу
|
data.pagination.results_per_page | integer |
Количество результатов на странице |
|
данные
|
data.data | array of object | |
|
Идентификатор карточки
|
data.data.card_id | integer |
Внутренний идентификатор карточки |
|
Пользовательский идентификатор карточки
|
data.data.custom_id | string |
Пользовательский идентификатор карточки |
|
Идентификатор доски
|
data.data.board_id | integer |
Идентификатор карточки |
|
Идентификатор рабочего процесса
|
data.data.workflow_id | integer |
Идентификатор рабочего процесса карточки |
|
Заголовок карточки
|
data.data.title | string |
Заголовок карточки |
|
Идентификатор пользователя владельца
|
data.data.owner_user_id |
Идентификатор владельца карточки |
|
|
Идентификатор типа
|
data.data.type_id |
Идентификатор типа карточки |
|
|
Цвет
|
data.data.color | string |
Цвет карточки |
|
Секция
|
data.data.section | integer |
Идентификатор раздела карточки |
|
Идентификатор столбца
|
data.data.column_id | integer |
Идентификатор столбца карточки |
|
Идентификатор лейн
|
data.data.lane_id | integer |
Идентификатор полосы карточки |
getCardAttachmentsResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
id
|
data.id | integer |
Идентификатор вложения карточки |
|
file_name
|
data.file_name | string |
Имя файла вложения карточки |
|
link
|
data.link | string |
Ссылка на вложение карточки |
getCardResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор карточки
|
data.card_id | integer |
Внутренний идентификатор карточки |
|
Пользовательский идентификатор карточки
|
data.custom_id | string |
Пользовательский идентификатор карточки |
|
Идентификатор доски
|
data.board_id | integer |
Идентификатор карточки |
|
Идентификатор рабочего процесса
|
data.workflow_id | integer |
Идентификатор рабочего процесса карточки |
|
Заголовок карточки
|
data.title | string |
Заголовок карточки |
|
Идентификатор пользователя владельца
|
data.owner_user_id |
Идентификатор владельца карточки |
|
|
Идентификатор типа
|
data.type_id |
Идентификатор типа карточки |
|
|
Цвет
|
data.color | string |
Цвет карточки |
|
Секция
|
data.section | integer |
Идентификатор раздела карточки |
|
Идентификатор столбца
|
data.column_id | integer |
Идентификатор столбца карточки |
|
Идентификатор лейн
|
data.lane_id | integer |
Идентификатор полосы карточки |
|
Position
|
data.position | integer |
Позиция карточки |
|
Описание карточки
|
data.description | string |
Описание карточки |
|
Размер карточки
|
data.size |
Размер карточки |
|
|
Priority
|
data.priority | integer |
Идентификатор приоритета карточки |
|
Deadline
|
data.deadline | string |
Крайний срок карточки |
|
Тип
|
data.reporter.type | string |
Тип значения. Может быть внутренним или внешним |
|
Сообщивший
|
data.reporter.value |
Репортер карточки |
|
|
Создано в
|
data.created_at | string |
Метка времени создания карточки |
|
Последнее изменение
|
data.last_modified | string |
Метка времени последнего изменения карточки |
|
Заблокировано
|
data.is_blocked | integer |
Логическое значение, является ли карточка заблокированной |
|
Настраиваемые поля
|
data.custom_fields | array of object |
Массив настраиваемых полей, назначенных карточке |
|
Идентификатор поля
|
data.custom_fields.field_id | integer |
Идентификатор настраиваемого поля |
|
Имя поля
|
data.custom_fields.name | string |
Имя настраиваемого поля |
|
Значение поля
|
data.custom_fields.value |
Значение настраиваемого поля |
|
|
Отображаемое значение поля
|
data.custom_fields.display_value |
Отображение значения настраиваемого поля |
|
|
values
|
data.custom_fields.values | array of object | |
|
Идентификатор значения
|
data.custom_fields.values.value_id | integer |
Идентификатор настраиваемого поля |
|
Значение поля
|
data.custom_fields.values.value |
Значение настраиваемого поля |
getObjectNameResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
имя
|
data.name | string |
Имя |
uploadAttachmentResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of object |
данные |
|
Идентификатор карточки
|
data.card_id | integer |
Внутренний идентификатор карточки |
|
Имя файла
|
data.file_name | string |
Имя файла для отправки |