Структуры.GetProperty
Материал из Hivext Wiki
Метод GetProperty
Общая информация
| Параметр | Значение |
|---|---|
| Описание | Чтение из свойства объекта. |
| Адрес метода | http://api.hivext.ru/1.0/data/base/{протокол}/getproperty |
| Кодирование | urlEncoding |
| Метод сервиса | Структуры |
Параметры
| Имя параметра | Тип | Описание |
|---|---|---|
| Входящие параметры | ||
| appid | string | [*] Идентификатор приложения. |
| session | string | [*] Идентификатор пользователя. |
| type | string | [*] Имя типа данных. |
| id | int | [*] Идентификатор объекта. |
| property | string | [*] Имя свойства. |
| join | string | Названия свойств комплексных типов. По умолчанию свойства с комплексными типами используют lazy загрузку, т.е. содержат индекс (ссылку) на объект, а не сам объект. Если требуется вернуть объект полностью, в параметре join указывается имя свойства, для которого нужно вернуть полноценный объект. Для полноценной выборки нескольких свойств можно использовать перечисление через запятую (field1, field2, ...). Для полноценной выборки с глубокой иерархией используется указание дерева свойств с разделителем точка (field1.subfield1, field2.subfield1.subsubfield1, ...). |
| Возвращаемые параметры | ||
| result | int |
|
| error | string | Описание ошибки, если она произошла. |
| value | string | Значение свойства. |
