Изменить цифровое рабочее место
Scope: crm Права на выполнение: пользователи с административным доступом к разделу CRM
Описание и параметры
Метод обновляет существующие настройки цифрового рабочего места с идентификатором id
. Если какое-то из полей не было передано, его значение останется прежним.
Параметры метода
Обязательные параметры отмечены *
Параметр | Описание |
---|---|
id*integer |
Идентификатор цифрового рабочего места. Может быть получен из ответа метода crm.automatedsolution.add (result.automatedSolution.id ), который был вызван при добавлении цифрового рабочего места, или crm.automatedsolution.list. Так же можно воспользоваться разделом «Цифровые рабочие места» на портале Битрикс24 — колонка ID в списке цифровых рабочих мест |
fields*object |
Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:
"fields": { "title": "значение", "typeIds": [] } |
Параметр fields
Параметр | Описание |
---|---|
titlestring |
Название цифрового рабочего места. Будьте внимательны с изменением поля title . Так как ссылка на цифровое рабочее место строится на основании названия, при его изменении изменится и ссылка на цифровое рабочее место |
typeIdscrm_dynamic_type.id[] |
Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту. Чтобы изменить список привязанных смарт-процессов, нужно передать поле typeIds с желаемым набором смарт-процессов.Внимание! Настройки переписываются полностью. При изменении списка привязанных смарт-процессов, надо передавать набор |
Примеры кода
1. Изменить название цифрового рабочего места
- cURL (Webhook)
curl -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.update
- cURL (OAuth)
curl -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.update
- JS
BX24.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()); } } );
- PHP
require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'title' => 'HR & Customer Success' ] ] ); echo '
'; print_r($result); echo '
';
2. Изменить список привязанных смарт-процессов
Допустим к цифровому рабочему месту с id
=267
были привязаны два смарт-процесса — один с id
=14
, а другой — с id
=158
. Если мы хотим, чтобы в цифровом рабочем месте остался только один смарт-процесс, то передаем поле typeIds
, содержащее только нужные смарт-процессы:
- cURL (Webhook)
curl -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.update
- cURL (OAuth)
curl -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.update
- JS
BX24.callMethod( 'crm.automatedsolution.update', { "id": 238, "fields": { "typeIds": [ 14 ] } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );
- PHP
require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'typeIds' => [14] ] ] ); echo '
'; print_r($result); echo '
';
3. Отвязать все смарт-процессы
Чтобы отвязать все смарт-процессы от цифрового рабочего места, нужно передать пустой массив в качестве typeIds
.
- cURL (Webhook)
curl -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.update
- cURL (OAuth)
curl -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.update
- JS
BX24.callMethod( 'crm.automatedsolution.update', { "id": 238, "fields": { "typeIds": [] } }, function(result) { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } } );
- PHP
require_once('crest.php'); $result = CRest::call( 'crm.automatedsolution.update', [ 'id' => 238, 'fields' => [ 'typeIds' => [] ] ] ); echo '
'; print_r($result); echo '
';
Обработка ответа и ошибок
Обработка ответа
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 } }
Возвращаемые данные
Название | Описание |
---|---|
resultobject |
Корневой элемент ответа |
automatedSolutionobject |
Объект с информацией об обновленном цифровом рабочем месте |
timetime |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{ "error":"BX_EMPTY_REQUIRED", "error_description":"Не заполнено обязательное поле" }
Название | Описание |
---|---|
errorstring |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
error_descriptionerror_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
Код | Описание |
---|---|
ACCESS_DENIED | Недостаточно прав |
BX_EMPTY_REQUIRED | Не заполнено обязательное поле |