Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти

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

Scope: crm Права на выполнение: пользователи с административным доступом к разделу CRM

Описание и параметры

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

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


Параметры

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

Параметр Описание
fields*
object		 Значения полей (подробное описание приведено ниже) для создания цифрового рабочего места в виде структуры: 
"fields": {
    "title": "значение",
    "typeIds": []
}

Параметр fields

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

Параметр Описание
title*
string		 Название цифрового рабочего места. На основании заголовка цифрового рабочего места будет строиться ссылка на соответствующий раздел на портале
typeIds
crm_dynamic_type.id[]		 Массив идентификаторов смарт-процессов, которые нужно привязать к этому рабочему месту.

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

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

Примеры кода


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

  • cURL (Webhook) 
    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 (OAuth) 
    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
  • JS 
    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());
        }
    }
);
  • PHP 
    require_once('crest.php');

$result = CRest::call(
    'crm.automatedsolution.add',
    [
        'fields' =>
        [
            'title' => 'HR',
            'typeIds' => [1, 2, 3]
        ]
    ]
);

echo '
    ';
print_r($result);
echo '
    ';

2. Создать цифровое рабочее место без смарт-процессов

  • cURL (Webhook) 
    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 (OAuth) 
    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
  • JS 
    BX24.callMethod(
    'crm.automatedsolution.add',
    {
        "fields": {
            "title": "HR"
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);
  • PHP 
    require_once('crest.php');

$result = CRest::call(
    'crm.automatedsolution.add',
    [
        'fields' =>
        [
            'title' => 'HR'
        ]
    ]
);

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
    }
}

Возвращаемые данные

Название Описание
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 Не заполнено обязательное поле


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024