Data Storage: Overview of Methods

Data storages allow developers to create applications that extend the capabilities of Bitrix24. They can store a variety of information: client records, inventory details, product information, and other data.

Each storage represents an information block and is available after registering the application in Bitrix24. There is no visual interface for the storage.

Quick navigation: all methods

Data StructureData Structure

Storages. Containers for application data. Each storage has a symbolic identifier, a name, and access permissions. Storages can be managed using the methods entity.*.

Sections. Designed for grouping data and building a convenient hierarchy. Sections can be managed using the methods entity.section.*.

Items. Store application data. Items can be created, modified, and deleted using the methods entity.item.*.

Item Properties. Define additional fields for items. Any storage allows you to configure such properties using the methods entity.item.property.*.

Getting StartedGetting Started

1. Create a storage using the entity.add method — specify the ENTITY identifier, a name, and access permissions

2. Define additional fields for items using the entity.item.property.add method

3. If the data needs to be grouped, create sections using the entity.section.add method

4. Add items using the entity.item.add method

5. Retrieve the data using the entity.item.get and entity.section.get methods

Storage IdentifierStorage Identifier

ENTITY is the symbolic identifier of the storage. It is set at creation and passed to every method in this section.

Requirements for the identifier:

• the characters a-z, A-Z, 0-9, and _ are allowed, for example dish
• the maximum length is calculated dynamically using the formula 50 - strlen("APP_<clientId>_") — in most cases for Bitrix24 this is 13 characters
• the identifier is unique within the application

To retrieve the list of application storages and their identifiers, use the entity.get method. To rename a storage, use the ENTITY_NEW parameter of the entity.update method.

Access Permission LevelsAccess Permission Levels

Access permissions are set in the format {"access_code":"permission_level"}, for example {"U1":"W","AU":"R"}. Standard Bitrix24 access codes are used:

• U<id> — a user, for example U1
• G<id> — a user group, for example G2
• AU — all authorized users

To check the name of an access code, use the access.name method.

Level	What it allows
R	Read the sections and items of the storage
W	Read the data, as well as create, modify, and delete sections and items
X	All actions of the W level, as well as modifying and deleting the storage itself, managing its access permissions and item properties

The methods do not accept other levels — such permission records are not added. The user who creates a storage or changes its permissions is always granted the X level.

Permissions are managed through the ACCESS parameter of the entity.add and entity.update methods, or through the separate entity.rights method.

Overview of MethodsOverview of Methods

Scope: entity

Who can execute the method: depending on the method

StoragesStorages

Method	Description
entity.add	Adds a data storage
entity.update	Updates the parameters of the data storage
entity.get	Retrieves the parameters of the data storage or the list of application storages
entity.delete	Deletes the data storage
entity.rights	Retrieves or changes access permissions for the data storage

SectionsSections

Method	Description
entity.section.add	Adds a data storage section
entity.section.update	Updates a data storage section
entity.section.get	Retrieves the list of data storage sections
entity.section.delete	Deletes a data storage section

ItemsItems

Method	Description
entity.item.add	Adds a data storage item
entity.item.update	Updates a data storage item
entity.item.get	Retrieves the list of data storage items
entity.item.delete	Deletes a data storage item

Item PropertiesItem Properties

Method	Description
entity.item.property.add	Adds a property for data storage items
entity.item.property.update	Updates a property for data storage items
entity.item.property.get	Retrieves the list of properties for data storage items
entity.item.property.delete	Deletes a property for data storage items

An information block is a special object for storing news, services, articles, product catalogs, and other data that has a clear structure.