Свойство

Основное назначение Свойств заключается в описании сущностей, добавлении дополнительной информации и определении способов сбора данных. Назначение Свойства зависит от его типа.

Каждое свойство должно иметь уникальное имя в рамках одной сущности.

Модель свойства

Поле Тип Описание

Поле	Тип	Описание
id	String	Идентификатор свойства.
name	String	Имя свойства.
owner_id	String	Идентификатор сущности, которой принадлежит свойство.
owner_type	Integer	Тип сущности, которой принадлежит свойство. `1` - объект, `2` - связь, `3` - поток.
type_id	Integer	Идентификатор типа свойства
value	String	Значение свойства.

String

Идентификатор свойства.

name

String

Имя свойства.

owner_id

String

Идентификатор сущности, которой принадлежит свойство.

owner_type

Integer

Тип сущности, которой принадлежит свойство. 1 - объект, 2 - связь, 3 - поток.

type_id

Integer

Идентификатор типа свойства

value

String

Значение свойства.

Типы свойств

Значение Имя Описание

Значение	Имя	Описание
1	Info	Базовое свойство вида "ключ":"значение". Свойства данного типа отображаются в секции Свойства веб-интерфейса системы. Данный тип используется по умолчанию.
2	Readonly	Данный тип аналогичен типу `Info`, но свойства данного типа не могут быть изменены пользователем через веб-интерфейс системы.
3	ReadWrite	Данный тип аналогичен типу `Info`, но при изменении свойства данного типа выполняется Операция с флагом runOnReadWritePropertyModification:true.
4	-	Данный тип аналогичен типу `Info` и не имеет уникальной функциональности.
5	-	Данный тип аналогичен типу `Info` и не имеет уникальной функциональности.
6	ExternalDocument	Web-ссылки на внешние ресурсы. Свойства данного типа отображаются в секции Документы веб-интерфейса системы.
7	UploadedDocument	Загруженные в объект файлы. Свойства данного типа отображаются в секции Документы веб-интерфейса системы. Поддерживаемые форматы: PDF DOC DOCX XLS XLSX ZIP
8	Service	Одно или набор нескольких свойств, определяющих метод сбора данных в объекте. Свойства данного типа отображаются в секции Мониторинг веб-интерфейса системы.
101 и больше	User Specified	Методы REST-API позволяют добавлять свойства с любым целочисленным значением поля `type_id`. В некоторых проектах или расширениях возникает необходимость использовать свой собственный идентификатор для группировки информации или реализации специфических задач. Для избежания конфликтов при обработке данных не рекомендуется использовать идентификаторы от 1 до 100, зарезервированные под внутренние нужды системы - используйте 101 и больше.

Info

Базовое свойство вида "ключ":"значение". Свойства данного типа отображаются в секции Свойства веб-интерфейса системы. Данный тип используется по умолчанию.

Readonly

Данный тип аналогичен типу Info, но свойства данного типа не могут быть изменены пользователем через веб-интерфейс системы.

ReadWrite

Данный тип аналогичен типу Info, но при изменении свойства данного типа выполняется Операция с флагом runOnReadWritePropertyModification:true.

Данный тип аналогичен типу Info и не имеет уникальной функциональности.

ExternalDocument

Web-ссылки на внешние ресурсы. Свойства данного типа отображаются в секции Документы веб-интерфейса системы.

UploadedDocument

Загруженные в объект файлы. Свойства данного типа отображаются в секции Документы веб-интерфейса системы.

Поддерживаемые форматы:

PDF
DOC
DOCX
XLS
XLSX
ZIP

Service

Одно или набор нескольких свойств, определяющих метод сбора данных в объекте. Свойства данного типа отображаются в секции Мониторинг веб-интерфейса системы.

101 и больше

User Specified

Методы REST-API позволяют добавлять свойства с любым целочисленным значением поля type_id. В некоторых проектах или расширениях возникает необходимость использовать свой собственный идентификатор для группировки информации или реализации специфических задач. Для избежания конфликтов при обработке данных не рекомендуется использовать идентификаторы от 1 до 100, зарезервированные под внутренние нужды системы - используйте 101 и больше.