entity.item.property.get
Получить свойства элементов хранилища
Описание
Метод entity.item.property.get возвращает свойства элементов хранилища данных приложения.
Метод работает только в контексте приложения.
Параметры
ENTITY
string
необязательный
Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища.
Получить идентификатор можно методом entity.get
PROPERTY
string
необязательный
Код свойства.
Если параметр не передан, метод возвращает список всех свойств хранилища.
Разрешены символы a-z, A-Z, 0-9, _
Примеры запроса
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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_PROPERTY_NOT_FOUND",
"error_description": "Property not found"
}
| Код | Описание | Значение |
|---|---|---|
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) |

