Изменить цифровое рабочее место crm.automatedsolution.update
Scope:
crmКто может выполнять метод: пользователи с административным доступом к разделу crm
Метод обновляет существующие настройки цифрового рабочего места с идентификатором id. Если какое-то из полей не было передано, его значение останется прежним.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор цифрового рабочего места. Может быть получен из ответа метода crm.automatedsolution.add (result.automatedSolution.id), который был вызван при добавлении цифрового рабочего места, или crm.automatedsolution.list. Так же можно воспользоваться разделом «Цифровые рабочие места» на портале Битрикс24 — колонка |
|
fields* |
Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:
|
Параметр fields
|
Название |
Описание |
|
title |
Название цифрового рабочего места. Будьте внимательны с изменением поля |
|
typeIds |
Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту. Чтобы изменить список привязанных смарт-процессов, нужно передать поле Важно Настройки переписываются полностью. При изменении списка привязанных смарт-процессов, надо передавать набор |
Примеры кода
Как использовать примеры в документации
-
Изменить название цифрового рабочего места
cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"title":"HR & Customer Success"}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.updatecurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"title":"HR & Customer Success"},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.updateBX24.callMethod( 'crm.automatedsolution.update', { "id": 238, "fields": { "title": "HR & Customer Success" } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'title' => 'HR & Customer Success' ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>'; -
Изменить список привязанных смарт-процессов
Допустим к цифровому рабочему месту с
id=267были привязаны два смарт-процесса — один сid=14, а другой — сid=158. Если мы хотим, чтобы в цифровом рабочем месте остался только один смарт-процесс, то передаем полеtypeIds, содержащее только нужные смарт-процессы:cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"typeIds":[14]}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.updatecurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"typeIds":[14]},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.updateBX24.callMethod( 'crm.automatedsolution.update', { "id": 238, "fields": { "typeIds": [ 14 ] } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'typeIds' => [14] ] ] ); echo '<PRE>'; print_r($result); echo '</PRE>'; -
Отвязать все смарт-процессы
Чтобы отвязать все смарт-процессы от цифрового рабочего места, нужно передать пустой массив в качестве
typeIds.cURL (Webhook)cURL (OAuth)JSPHPcurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"typeIds":[]}}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.updatecurl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"id":238,"fields":{"typeIds":[]},"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.automatedsolution.updateBX24.callMethod( 'crm.automatedsolution.update', { "id": 238, "fields": { "typeIds": [] } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'typeIds' => [] ] ] ); 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.add
- Получить данные о цифровом рабочем месте по id crm.automatedsolution.get
- Получить список цифровых рабочих мест crm.automatedsolution.list
- Удалить цифровое рабочее место crm.automatedsolution.delete
- Получить поля цифрового рабочего места crm.automatedsolution.fields