Получить пользовательский тип по entityTypeId crm.type.getByEntityTypeId

Scope: crm

Кто может выполнять метод: любой пользователь с административным доступом к смарт-процессу, либо пользователь с правом на чтение смарт-процесса

Метод получает информацию о смарт-процессе с идентификатором типа смарт-процесса entityTypeId.

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

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

Название
тип

Описание

entityTypeId*
integer

Идентификатор типа смарт-процесса.

Примеры кода

Получить информацию о смарт-процессе с entityTypeId = 2024.

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2024}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.getByEntityTypeId
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2024,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.type.getByEntityTypeId
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.type.getByEntityTypeId',
        		{
        			entityTypeId: 2024,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.type.getByEntityTypeId',
                    [
                        'entityTypeId' => 2024,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Success: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting entity types: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.type.getByEntityTypeId',
            {
                entityTypeId: 2024,
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
        
                    return;
                }
        
                console.info(result.data());
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.getByEntityTypeId',
            [
                'entityTypeId' => 2024
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "type": {
                    "id": 16,
                    "title": "Смарт-процесс",
                    "code": "",
                    "createdBy": 1,
                    "entityTypeId": 2024,
                    "customSectionId": null,
                    "isCategoriesEnabled": "Y",
                    "isStagesEnabled": "Y",
                    "isBeginCloseDatesEnabled": "Y",
                    "isClientEnabled": "Y",
                    "isUseInUserfieldEnabled": "Y",
                    "isLinkWithProductsEnabled": "Y",
                    "isMycompanyEnabled": "Y",
                    "isDocumentsEnabled": "Y",
                    "isSourceEnabled": "Y",
                    "isObserversEnabled": "Y",
                    "isRecyclebinEnabled": "Y",
                    "isAutomationEnabled": "Y",
                    "isBizProcEnabled": "Y",
                    "isSetOpenPermissions": "Y",
                    "isPaymentsEnabled": "N",
                    "isCountersEnabled": "N",
                    "createdTime": "2024-07-08T14:46:54+02:00",
                    "updatedTime": "2024-07-08T14:46:54+02:00",
                    "updatedBy": 1,
                    "relations": {
                        "parent": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "Y"
                            },
                            {
                                "entityTypeId": 1,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 2,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 31,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            }
                        ],
                        "child": [
                            {
                                "entityTypeId": 3,
                                "isChildrenListEnabled": "Y",
                                "isPredefined": "N"
                            },
                            {
                                "entityTypeId": 4,
                                "isChildrenListEnabled": "N",
                                "isPredefined": "N"
                            }
                        ]
                    },
                    "linkedUserFields": {
                        "CALENDAR_EVENT|UF_CRM_CAL_EVENT": "Y",
                        "TASKS_TASK|UF_CRM_TASK": "Y",
                        "TASKS_TASK_TEMPLATE|UF_CRM_TASK": "N"
                    },
                    "customSections": []
                }
            },
            "time": {
                "start": 1720442829.865672,
                "finish": 1720442830.334845,
                "duration": 0.46917295455932617,
                "processing": 0.13246917724609375,
                "date_start": "2024-07-08T14:47:09+02:00",
                "date_finish": "2024-07-08T14:47:10+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа, содержащий объект type с информацией о смарт-процессе

time
time

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

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

HTTP-статус: 400

{
            "error": 0,
            "error_description": "Смарт-процесс не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

allowed_only_intranet_user

Действие разрешено только интранет-пользователям

Возникает, если пользователь не является интранет-пользователем

400

ACCESS_DENIED

Доступ запрещен

Возникает, если у пользователя нет административных прав CRM или нет прав на чтение смарт-процесса

400

0

Смарт-процесс не найден

Смарт-процесс с переданным entityTypeId не найден

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

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
Следующая
Получить список пользовательских типов