Документация для разработчиков
Темная тема

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

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

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

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


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

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

Параметр Описание
id*
integer
Идентификатор цифрового рабочего места

Примеры кода


  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":393}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automatedsolution.get
    
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"id":393,"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.automatedsolution.get
    
  • JS
    BX24.callMethod(
        "crm.automatedsolution.get",
        {
            "id": 393
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );
    
  • PHP
    require_once('crest.php');
    
    $result = CRest::call(
        'crm.automatedsolution.get',
        [
            'id' => 393
        ]
    );
    
    echo '
    ';
    print_r($result);
    echo '
    ';

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


Обработка ответа

HTTP-статус: 200

{
    "result": {
        "automatedSolution": {
            "id": 393,
            "title": "HR",
            "typeIds": [
                4,
                9,
                77,
                157,
                225
            ]
        }
    },
    "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
Информация о времени выполнения запроса

Объект automatedSolution:

Название Описание
id
integer
Уникальный идентификатор цифрового рабочего места
title
string
Название цифрового рабочего места
typeIds
array
Идентификаторы привязанных к рабочему месту смарт-процессов

Id цифрового рабочего места и id структур customSection из метода crm.type.get не совпадают из-за разной организации хранения

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

HTTP-статус: 400

{
    "error":"NOT_FOUND",
    "error_description":"Цифровое рабочее место с таким id не найдено"
}
Название Описание
error
string
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description
error_description
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код Описание
ACCESS_DENIED Недостаточно прав
NOT_FOUND Цифровое рабочее место с таким id не найдено


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

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

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

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

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