Получить поля пользовательского типа crm.type.fields

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

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

Метод получает информацию о собственных полях настроек смарт-процесса.

Без параметров.

Примеры

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

Получить информацию о полях смарт-процесса

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.type.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{}' \
        https://**put_your_bitrix24_address**/rest/crm.type.fields?auth=**put_access_token_here**
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.type.fields',
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.type.fields',
                    []
                );
        
            $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 fetching CRM type fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.type.fields',
            {},
            (result) => {
                if (result.error()) 
                {
                    console.error(result.error());
        
                    return;
                } 
        
                console.info(result.data());
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.type.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "fields": {
                    "id": {
                        "type": "integer",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "ID",
                        "upperName": "ID"
                    },
                    "title": {
                        "type": "string",
                        "isRequired": true,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Название",
                        "upperName": "TITLE"
                    },
                    "code": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Символьный код",
                        "upperName": "CODE"
                    },
                    "createdBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем создан",
                        "upperName": "CREATED_BY"
                    },
                    "entityTypeId": {
                        "type": "integer",
                        "isRequired": true,
                        "isReadOnly": false,
                        "isImmutable": true,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Идентификатор типа",
                        "upperName": "ENTITY_TYPE_ID"
                    },
                    "customSectionId": {
                        "type": "integer",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": true,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Цифровое рабочее место",
                        "upperName": "CUSTOM_SECTION_ID"
                    },
                    "isCategoriesEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать в смарт-процессе свои воронки и туннели продаж",
                        "upperName": "IS_CATEGORIES_ENABLED"
                    },
                    "isStagesEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать в смарт-процессе свои стадии и канбан",
                        "upperName": "IS_STAGES_ENABLED"
                    },
                    "isBeginCloseDatesEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Поля \"Дата начала\" и \"Дата завершения\"",
                        "upperName": "IS_BEGIN_CLOSE_DATES_ENABLED"
                    },
                    "isClientEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Поле \"Клиент\"",
                        "upperName": "IS_CLIENT_ENABLED"
                    },
                    "isUseInUserfieldEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать в пользовательском поле",
                        "upperName": "IS_USE_IN_USERFIELD_ENABLED"
                    },
                    "isLinkWithProductsEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Привязка товаров каталога",
                        "upperName": "IS_LINK_WITH_PRODUCTS_ENABLED"
                    },
                    "isMycompanyEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Поле \"Реквизиты вашей компании\"",
                        "upperName": "IS_MYCOMPANY_ENABLED"
                    },
                    "isDocumentsEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Печать документов",
                        "upperName": "IS_DOCUMENTS_ENABLED"
                    },
                    "isSourceEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Поля \"Источник\" и \"Дополнительно об источнике\"",
                        "upperName": "IS_SOURCE_ENABLED"
                    },
                    "isObserversEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Поле \"Наблюдатели\"",
                        "upperName": "IS_OBSERVERS_ENABLED"
                    },
                    "isRecyclebinEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать корзину",
                        "upperName": "IS_RECYCLEBIN_ENABLED"
                    },
                    "isAutomationEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать в смарт-процессе роботы и триггеры",
                        "upperName": "IS_AUTOMATION_ENABLED"
                    },
                    "isBizProcEnabled": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Использовать в смарт-процессе дизайнер бизнес-процессов",
                        "upperName": "IS_BIZ_PROC_ENABLED"
                    },
                    "isSetOpenPermissions": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Делать новые воронки доступными для всех",
                        "upperName": "IS_SET_OPEN_PERMISSIONS"
                    },
                    "createdTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Дата создания",
                        "upperName": "CREATED_TIME"
                    },
                    "updatedTime": {
                        "type": "datetime",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Дата изменения",
                        "upperName": "UPDATED_TIME"
                    },
                    "updatedBy": {
                        "type": "user",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "Кем изменён",
                        "upperName": "UPDATED_BY"
                    }
                }
            },
            "time": {
                "start": 1720436891.554676,
                "finish": 1720436894.393655,
                "duration": 2.8389790058135986,
                "processing": 0.20139384269714355,
                "date_start": "2024-07-08T13:08:11+02:00",
                "date_finish": "2024-07-08T13:08:14+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит объект с единственным ключом fields

fields
object

Объект в формате: { field_1: value_1, field_2: value_2, ... , field_n: value_n }, где field_n — поля настроек смарт-процесса, а value_n — объект типа crm_rest_field_description

time
time

Объект, содержащий в себе информацию о времени выполнения запроса

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

HTTP-статус: 400, 403

{
            "error": "ACCESS_DENIED",
            "error_description": "Доступ запрещен"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

allowed_only_intranet_user

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

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

400

ACCESS_DENIED

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

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

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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

Предыдущая
Удалить пользовательский тип
Следующая
Создать новый элемент CRM