Изменить цифровое рабочее место crm.automatedsolution.update

Scope: crm

Кто может выполнять метод: пользователи с административным доступом к разделу crm

Метод обновляет существующие настройки цифрового рабочего места с идентификатором id. Если какое-то из полей не было передано, его значение останется прежним.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор цифрового рабочего места. Может быть получен из ответа метода crm.automatedsolution.add (result.automatedSolution.id), который был вызван при добавлении цифрового рабочего места, или crm.automatedsolution.list. Так же можно воспользоваться разделом «Цифровые рабочие места» на портале Битрикс24 — колонка ID в списке цифровых рабочих мест

fields*
object

Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры:

"fields": {
            "title": "значение",
            "typeIds": []
        }
        

Параметр fields

Название
тип

Описание

title
string

Название цифрового рабочего места.

Будьте внимательны с изменением поля title. Так как ссылка на цифровое рабочее место строится на основании названия, при его изменении изменится и ссылка на цифровое рабочее место

typeIds
crm_dynamic_type.id[]

Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту.

Чтобы изменить список привязанных смарт-процессов, нужно передать поле typeIds с желаемым набором смарт-процессов.

Важно

Настройки переписываются полностью. При изменении списка привязанных смарт-процессов, надо передавать набор typeIds целиком, либо опустить ключ typeIds вообще

Примеры кода

Как использовать примеры в документации

  1. Изменить название цифрового рабочего места

    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 -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
            
    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());
                    }
                }
            );
            
    require_once('crest.php');
            
            $result = CRest::call(
                'crm.automatedsolution.update',
                [
                    'id' => 238,
                    'fields' =>
                    [
                        'title' => 'HR & Customer Success'
                    ]
                ]
            );
            
            echo '<PRE>';
            print_r($result);
            echo '</PRE>';
            
  2. Изменить список привязанных смарт-процессов

    Допустим к цифровому рабочему месту с id = 267 были привязаны два смарт-процесса — один с id = 14, а другой — с id = 158. Если мы хотим, чтобы в цифровом рабочем месте остался только один смарт-процесс, то передаем поле typeIds, содержащее только нужные смарт-процессы:

    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 -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
            
    BX24.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>';
            
  3. Отвязать все смарт-процессы

    Чтобы отвязать все смарт-процессы от цифрового рабочего места, нужно передать пустой массив в качестве typeIds.

    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 -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
            
    BX24.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
object

Корневой элемент ответа

automatedSolution
object

Объект с информацией об обновленном цифровом рабочем месте

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":"BX_EMPTY_REQUIRED",
            "error_description":"Не заполнено обязательное поле"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

ACCESS_DENIED

Недостаточно прав

BX_EMPTY_REQUIRED

Не заполнено обязательное поле

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение