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

Scope: crm

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

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

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

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

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

Примеры кода

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.automatedsolution.get',
        		{
        			'id': 393
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.automatedsolution.get',
                    [
                        'id' => 393,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Info: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting automated solution: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.automatedsolution.get",
            {
                "id": 393
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automatedsolution.get',
            [
                'id' => 393
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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` не найдено

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

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

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

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

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

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

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

Примеры кодаПримеры кода

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

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

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

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

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

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