Создать цифровое рабочее место crm.automatedsolution.add
Scope:
crmКто может выполнять метод: пользователи с административным доступом к разделу CRM
Метод создаст новое цифровое рабочее место.
В облаке максимальное количество цифровых рабочих мест зависит от тарифа. В коробке максимальное количество зависит от технических ограничений.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:
|
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
title* |
Название цифрового рабочего места. На основании заголовка цифрового рабочего места будет строиться ссылка на соответствующий раздел на портале |
|
typeIds |
Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту. Если смарт-процесс до этого был привязан к другому рабочему месту или к CRM, то после привязки к новому рабочему месту, он оттуда пропадет. Цифровое рабочее место без смарт-процессов не будет выводиться в левое меню. Но его можно будет найти в списке цифровых рабочих мест |
Примеры кода
Как использовать примеры в документации
-
Создать цифровое рабочее место и сразу привязать к нему смарт-процессы
cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"title":"HR","typeIds":[1,2,3]}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.addcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"title":"HR","typeIds":[1,2,3]},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.addBX24.callMethod( 'crm.automatedsolution.add', { "fields": { "title": "HR", "typeIds": [ 1, 2, 3 ] } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.add', [ 'fields' => [ 'title' => 'HR', 'typeIds' => [1, 2, 3] ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>'; -
Создать цифровое рабочее место без смарт-процессов
cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"title":"HR"}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.addcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"fields":{"title":"HR"},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.addBX24.callMethod( 'crm.automatedsolution.add', { "fields": { "title": "HR" } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.add', [ 'fields' => [ 'title' => 'HR' ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"automatedSolution": {
"id": 1,
"title": "HR",
"typeIds": [
1,
2,
3
]
}
},
"time": {
"start": 1715849396.642359,
"finish": 1715849396.954623,
"duration": 0.31226396560668945,
"processing": 0.0068209171295166016,
"date_start": "2024-05-16T11:49:56+03:00",
"date_finish": "2024-05-16T11:49:56+03:00",
"operating_reset_at": 1715849996,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
automatedSolution |
Объект с информацией о добавленном цифровом рабочем месте |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "BX_EMPTY_REQUIRED",
"error_description":"Не заполнено обязательное поле «Название»"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав |
|
|
Превышено количество доступных цифровых рабочих мест |
|
|
Не заполнено обязательное поле |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Цифровые рабочие места
- Изменить цифровое рабочее место crm.automatedsolution.update
- Получить данные о цифровом рабочем месте по id crm.automatedsolution.get
- Получить список цифровых рабочих мест crm.automatedsolution.list
- Удалить цифровое рабочее место crm.automatedsolution.delete
- Получить поля цифрового рабочего места crm.automatedsolution.fields