Получить свойства элементов хранилища entity.item.property.get

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

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

Scope: entity

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

Метод entity.item.property.get возвращает свойства элементов хранилища данных приложения.

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

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

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

Название
тип

Описание

ENTITY*
string

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

Получить идентификатор можно методом entity.get

PROPERTY
string

Код свойства.

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

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

Примеры кода

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.item.property.get
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each PropertyItem returned in result[]
type PropertyItem = {
  PROPERTY: string
  NAME: string
  TYPE: string
  SORT: string
}

try {
  const response = await $b24.actions.v2.call.make<PropertyItem[]>({
    method: 'entity.item.property.get',
    params: {
      ENTITY: 'dish',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.map(p => `${p.PROPERTY}: ${p.NAME} (${p.TYPE})`))
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getEntityItemProperties() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'entity.item.property.get',
        params: {
          ENTITY: 'dish',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.map(p => `${p.PROPERTY}: ${p.NAME} (${p.TYPE})`))
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getEntityItemProperties)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.entity.item.property.get(
        entity="dish",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
try {
    $response = $b24Service
        ->core
        ->call(
            'entity.item.property.get',
            [
                'ENTITY' => 'dish',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo '<pre>';
    print_r($result);
    echo '</pre>';

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting entity item properties: ' . $e->getMessage();
}
BX24.callMethod(
    'entity.item.property.get',
    {
        ENTITY: 'dish',
    },
    (result) => {
        result.error()
            ? console.error(result.error())
            : console.info(result.data())
        ;
    },
);
require_once('crest.php');

$result = CRest::call(
    'entity.item.property.get',
    [
        'ENTITY' => 'dish',
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "entity.item.property.get", b24.Params{
	"ENTITY": "dish",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("entity.item.property.get: %w", err)
}

var items []struct {
	Property string `json:"PROPERTY"`
	Name     string `json:"NAME"`
	Type     string `json:"TYPE"`
	Sort     string `json:"SORT"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Property, it.Name)
}

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

HTTP-статус: 200

{
    "result": [
        {
            "PROPERTY": "test",
            "NAME": "Тестовое свойство",
            "TYPE": "S",
            "SORT": "100"
        },
        {
            "PROPERTY": "test1",
            "NAME": "Второе свойство",
            "TYPE": "N",
            "SORT": "200"
        }
    ],
    "time": {
        "start": 1774439396,
        "finish": 1774439396.082458,
        "duration": 0.0824580192565918,
        "processing": 0,
        "date_start": "2026-03-25T14:49:56+03:00",
        "date_finish": "2026-03-25T14:49:56+03:00",
        "operating_reset_at": 1774439996,
        "operating": 0
    }
}

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

Название
тип

Описание

result
result

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

time
time

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

Тип result

Название
тип

Описание

object
property

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

property[]

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

Тип property

Название
тип

Описание

PROPERTY
string

Код свойства

NAME
string

Название свойства

TYPE
string

Тип свойства (S, N, F)

SORT
integer

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

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

HTTP-статус: 400

{
    "error": "ERROR_PROPERTY_NOT_FOUND",
    "error_description": "Property not found"
}
{
    "error": "ERROR_ARGUMENT",
    "error_description": "Argument 'ENTITY' is null or empty",
    "argument": "ENTITY"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

ERROR_ARGUMENT

Argument 'ENTITY' is null or empty

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

ERROR_ARGUMENT

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

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

ERROR_ENTITY_NOT_FOUND

Entity not found

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

ERROR_PROPERTY_NOT_FOUND

Property not found

Свойство с переданным PROPERTY не найдено

ACCESS_DENIED

Access denied! Application context required

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

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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