Создать цифровое рабочее место crm.automatedsolution.add

Scope: crm

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

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

В облаке максимальное количество цифровых рабочих мест зависит от тарифа. В коробке максимальное количество зависит от технических ограничений.

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

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

Название
тип

Описание

fields*
object

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

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

Параметр fields

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

Название
тип

Описание

title*
string

Название цифрового рабочего места. На основании заголовка цифрового рабочего места будет строиться ссылка на соответствующий раздел на портале

typeIds
crm_dynamic_type.id[]

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

Если смарт-процесс до этого был привязан к другому рабочему месту или к CRM, то после привязки к новому рабочему месту, он оттуда пропадет.

Цифровое рабочее место без смарт-процессов не будет выводиться в левое меню. Но его можно будет найти в списке цифровых рабочих мест

Примеры кода

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

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

    curl -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.add
            
    curl -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.add
            
    BX24.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>';
            
  2. Создать цифровое рабочее место без смарт-процессов

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

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

automatedSolution
object

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

time
time

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

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

ACCESS_DENIED

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

LIMIT_EXCEEDED

Превышено количество доступных цифровых рабочих мест

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

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

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