Data Storage Items: Overview of Methods

Data storage items hold application information. They can store core fields, property values, and links to sections.

The group of methods entity.item.* allows you to create items, 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 sections are used in the storage, get the section identifier using the entity.section.get method.

3. If additional fields are needed for the items, create properties or retrieve a list of existing properties and their codes using the entity.item.property.* methods.

4. Create the first item using the entity.item.add method.

5. Retrieve the list of items and their identifiers using the entity.item.get method.

6. Modify the item parameters using the entity.item.update method.

7. Delete the unnecessary item using the entity.item.delete method.

What an Item Can StoreWhat an Item Can Store

Core fields. The item name and activity dates. They are passed as separate parameters of the entity.item.add and entity.item.update methods.

Property values. Additional data is passed in the PROPERTY_VALUES parameter in the format {"PROPERTY_CODE": value}. Only the properties already created in the storage using the entity.item.property.add method are processed.

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

Files. The preview picture, the detail picture, and the values of properties of the F (file) type are passed in the format described in the article How to Upload Files. In the response of the entity.item.get method, such fields contain a link to the file.

How to Retrieve Lists of ItemsHow to Retrieve Lists of Items

The entity.item.get method returns items 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. The ENTITY parameter, which is its identifier, is passed to the methods. 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 items is described in the Access Permission Levels section.

Storage Sections. An item can be linked to a section via the SECTION parameter. To work with sections, use the entity.section.* methods.

Item Properties. Additional fields for an item are created in advance using the entity.item.property.* methods. The list of available codes and their types is returned by the entity.item.property.get method.

Overview of MethodsOverview of Methods

Scope: entity

Who can execute the method: depending on the method

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