Properties of Data Storage Items: Overview of Methods

The properties of data storage items help store additional data within application items. They allow for the definition of custom fields.

The group of methods entity.item.property.* enables the creation of properties, retrieval of property lists, modification of parameters, and deletion of unnecessary properties.

Quick Navigation: All Methods

Getting StartedGetting Started

1. Obtain the storage identifier using the entity.get method.
2. Create a new property using the entity.item.property.add method.
3. Retrieve the list of properties and their codes using the entity.item.property.get method.
4. Modify the property parameters using the entity.item.property.update method.
5. Delete the unnecessary property using the entity.item.property.delete method.

Property TypesProperty Types

The type is set by the TYPE parameter when a property is created.

Type	What it stores	How to pass the value
S	A string	A string value in the PROPERTY_VALUES parameter of the entity.item.add method
N	A number	A numeric value in the PROPERTY_VALUES parameter
F	A file	A file in the format described in the article How to Upload Files. In the response of the entity.item.get method, the property contains a link to the file

The methods in this section do not accept other types, including the list type L — such a call returns the error Wrong entity item property type.

Specifics of Working with PropertiesSpecifics of Working with Properties

Property code. PROPERTY is the symbolic code used to pass the property to items. The characters a-z, A-Z, 0-9, and _ are allowed. The code is unique within the storage.

Renaming. The property code is changed using the PROPERTY_NEW parameter of the entity.item.property.update method. After renaming, the new code is used in the PROPERTY_VALUES parameter of the items.

Changing the type. The type of an existing property can be changed, but it cannot be set to F. To get a property of the file type, create a new property using the entity.item.property.add method.

Deletion. The entity.item.property.delete method deletes the property along with its values in all items of the storage.

Relationship with Other ObjectsRelationship with Other Objects

Data Storage. Each method in the group operates 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. Properties can be managed by a user with the X permission level — the levels are described in the Access Permission Levels section.

Storage Items. Properties define additional fields for data storage items. Property values are passed in the PROPERTY_VALUES parameter of the entity.item.* methods. Only the codes already created in the storage are processed.

Overview of MethodsOverview of Methods

Scope: entity

Who can execute the method: depends on the method

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