Получить поля воронки crm.category.fields

Scope: crm

Кто может выполнять метод: любой пользователь

Метод получает информацию о полях воронок (направлений) объекта CRM.

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

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

Название
тип

Описание

entityTypeId*
integer

Идентификатор системного или пользовательского типа объектов CRM, для которого нужно получить информацию о полях воронки

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.category.fields
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.category.fields
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.category.fields",
        		{
        			entityTypeId: 2,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.category.fields',
                    [
                        'entityTypeId' => 2,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling crm.category.fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.category.fields",
            {
                entityTypeId: 2,
            },
            (result) => {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.category.fields',
            [
                'entityTypeId' => 2
            ]
        );
        
        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"
                    },
                    "name": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "NAME",
                        "upperName": "NAME"
                    },
                    "sort": {
                        "type": "integer",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "SORT",
                        "upperName": "SORT"
                    },
                    "entityTypeId": {
                        "type": "integer",
                        "isRequired": true,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "ENTITY_TYPE_ID",
                        "upperName": "ENTITY_TYPE_ID"
                    },
                    "isDefault": {
                        "type": "boolean",
                        "isRequired": false,
                        "isReadOnly": true,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "IS_DEFAULT",
                        "upperName": "IS_DEFAULT"
                    },
                    "originId": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "ORIGIN_ID",
                        "upperName": "ORIGIN_ID"
                    },
                    "originatorId": {
                        "type": "string",
                        "isRequired": false,
                        "isReadOnly": false,
                        "isImmutable": false,
                        "isMultiple": false,
                        "isDynamic": false,
                        "title": "ORIGINATOR_ID",
                        "upperName": "ORIGINATOR_ID"
                    }
                }
            },
            "time": {
                "start": 1718098629.350263,
                "finish": 1718098629.800741,
                "duration": 0.45047783851623535,
                "processing": 0.02919292449951172,
                "date_start": "2024-06-11T11:37:09+02:00",
                "date_finish": "2024-06-11T11:37:09+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Объект со списком доступных полей в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field_N – идентификатор поля объекта, а value — объект типа crm_rest_field_description

time
time

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

Описание полей fields

Название
тип

Описание

id
integer

Идентификатор воронки (направления)

name
string

Название воронки

sort
integer

Индекс сортировки

entityTypeId
integer

Идентификатор системного или пользовательского типа, к которому принадлежит воронка

isDefault
boolean

Является ли воронка, воронкой по умолчанию

originId
string

Идентификатор источника данных.

Существует только в cделках

originatorId
string

Идентификатор элемента в источнике данных.

Существует только в cделках

isSystem
boolean

Является ли воронка системной.

Существует только в смарт-процессах

code
string

Псевдоним для системных воронок.

Существует только в смарт-процессах

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

NOT_FOUND

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

Возникает, при некорректных значениях entityTypeId

ENTITY_TYPE_NOT_SUPPORTED

Entity type {entityTypeName} is not supported

Возникает, если сущность 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

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

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

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

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

Предыдущая
Удалить воронку
Следующая
Импорт