Data Storage Sections: Overview of Methods

Data storage sections help group items within the application and build a hierarchy.

The group of methods entity.section.* allows you to create sections, retrieve their list, modify parameters, and delete unnecessary ones.

Quick Navigation: All Methods

Getting StartedGetting Started

1. Obtain the storage identifier using the entity.get method.
2. If a hierarchy is needed in the storage, create the first section using the entity.section.add method.
3. Retrieve the list of sections and their identifiers using the entity.section.get method.
4. Modify the section parameters using the entity.section.update method.
5. Delete the unnecessary section using the entity.section.delete method.

What Can Be Set in a SectionWhat Can Be Set in a Section

Core fields. The name, symbolic code, description, activity flag, and sorting index. They are passed as separate parameters of the entity.section.add and entity.section.update methods.

Custom fields. The UF_* fields are passed as separate parameters in the format "UF_CODE": value, for example "UF_COLOR": "#ff6600".

Files. The section picture and detail picture are passed in the format described in the article How to Upload Files. In the response of the entity.section.get method, such fields contain a link to the file.

How to Retrieve Lists of SectionsHow to Retrieve Lists of Sections

The entity.section.get method returns sections page by page: the page size is fixed at 50 records, and the next page is requested using the start parameter. Selection and sorting are set by the FILTER and SORT parameters, and comparison prefixes such as >=, %, or ! are supported in the filter keys.

For more details on pagination, refer to the article Features of List Methods.

Relationship with Other ObjectsRelationship with Other Objects

Data Storage. Each method in the group works with a specific data storage of the application. For this, the ENTITY parameter is passed to the methods — the identifier of the storage. The requirements for the identifier are described in the Storage Identifier section, and the value can be obtained using the entity.get method. The permission level required to work with sections is described in the Access Permission Levels section.

Storage Items. Sections are used to group items. An item is linked to a section using the SECTION parameter. To work with items, use the entity.item.* methods.

Parent Section. In the entity.section.add and entity.section.update methods, you can specify the SECTION parameter to create a nested section or move a section inside another. A top-level section is created without this parameter.

Overview of MethodsOverview of Methods

Scope: entity

Who can execute the method: depending on the method

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