Get a list of additional properties of storage elements entity.item.property.get

We are still updating this page

Some data may be missing — we will fill it in shortly

Scope: entity

Who can execute the method: any user

The method entity.item.property.get retrieves a list of additional properties of storage elements.

Parameters

Parameter

Description

ENTITY*
string

Required. String identifier of the storage.

PROPERTY
string

String identifier of the required property.

Required parameters are marked with *

Examples

try
        {
        	const response = await $b24.callMethod(
        		'entity.item.property.get',
        		{
        			ENTITY: 'menu_new'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.property.get',
                    [
                        'ENTITY' => 'menu_new',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your required data processing logic
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting entity item properties: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'entity.item.property.get',
            {
                ENTITY: 'menu_new'
            },
            function(r){
                console.log(r.data());
            }
        );
        
https://my.bitrix24.com/rest/entity.item.property.get.json?ENTITY=menu_new&auth=340bf57f35ee95e0debf98399632999c

How to Use Examples in Documentation

Response in case of success

200 OK

{
            "result":
            [
                {
                    "PROPERTY":"test",
                    "NAME":"Test property",
                    "TYPE":"S"
                },
                {
                    "PROPERTY":"test1",
                    "NAME":"Second test property",
                    "TYPE":"N"
                },
                {
                    "PROPERTY":"test_file",
                    "NAME":"File",
                    "TYPE":"F"
                }
            ]
        }
Previous
Overview of Methods
Next
Add Additional Property