Получить параметры хранилища или список хранилищ entity.get

Scope: entity

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

Метод entity.get возвращает параметры указанного хранилища или список всех хранилищ приложения.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

ENTITY
string

Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища.

Если параметр передан, метод возвращает данные только этого хранилища.

Разрешены символы a-z, A-Z, 0-9, _

Примеры кода

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

Пример получения параметров конкретного хранилища, где ENTITY — идентификатор dish_v2.

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

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

HTTP-статус: 200

{
            "result": {
                "ID": "183",
                "IBLOCK_TYPE_ID": "rest_entity",
                "ENTITY": "dish_v2",
                "NAME": "Dishes v2"
            },
            "time": {
                "start": 1774270219,
                "finish": 1774270219.086362,
                "duration": 0.08636188507080078,
                "processing": 0,
                "date_start": "2026-03-23T15:50:19+03:00",
                "date_finish": "2026-03-23T15:50:19+03:00",
                "operating_reset_at": 1774270819,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
result

Корневой элемент ответа. Содержит объект хранилища или список хранилищ

time
time

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

Тип result

Название
тип

Описание

object
entity

Возвращается, если передан параметр ENTITY

entity[]

Возвращается, если параметр ENTITY не передан

Тип entity

Название
тип

Описание

ID
string

Идентификатор хранилища

IBLOCK_TYPE_ID
string

Идентификатор типа хранилища

ENTITY
string

Идентификатор хранилища, переданный приложением

NAME
string

Название хранилища

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

HTTP-статус: 400

{
            "error": "ERROR_ENTITY_NOT_FOUND",
            "error_description": "Entity not found"
        }
        
{
            "error": "ERROR_ARGUMENT",
            "error_description": "Entity code is too long. Max length is 13 characters.",
            "argument": ""
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ERROR_ARGUMENT

Argument 'ENTITY' is null or empty

Параметр ENTITY передан, но пустой после очистки

ERROR_ARGUMENT

Entity code is too long. Max length is 13 characters.

Слишком длинное значение ENTITY

ERROR_ENTITY_NOT_FOUND

Entity not found

Хранилище с переданным ENTITY не найдено

ACCESS_DENIED

Access denied! Application context required

Нет контекста приложения (clientId)

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

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

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

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

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