Skip to content

Property

Main purpose of Property is to describe an entity, attach some additional data or define Data Ingestion. The purpose of Property depends on its type - see below.

Warning

Every property of an entity must have a unique name.

Property Model

Field Type Description
id Stringrequired Property's ID.
name Stringrequired Property's name.
value Stringrequired Property's value.
type_id Integer Property's type ID. See below.
owner_id String The ID of the entity that the property is attached to.
owner_type Integer The type of the entity that the property is attached to. 1 for an object, 2 for a link, 3 for a flow.

Property's Type ID

Value Name Description
1 Info Ordinary descriptive "key":"value" property. These properties are displayed in Properties section of SAYMON UI. This is the default value.
2 Readonly Same as the Info property, but can't be modified in SAYMON UI.
3 ReadWrite Same as the Info property, but on its modification Operation with runOnReadWritePropertyModification:true flag is executed.
4 - Has no special functionality. Acts the same as Info property type.
5 - Has no special functionality. Acts the same as Info property type.
6 ExternalDocument Web links to external resources. These properties are displayed in Documents section of SAYMON UI.
7 UploadedDocument PDF-files uploaded to Object. These properties are displayed in Documents section of SAYMON UI.
8 Service One or a set of properties to define Data Ingestion. These properties are displayed in the Monitoring section of SAYMON UI.
101 and greater User Specified SAYMON API allows to add properties with any integer type_id. In some projects or extensions you may wish to use your own IDs to group information or implement specific cases. To avoid any conflicts we reserved first 100 type IDs for the future needs of SAYMON, while you can use your own IDs starting with value 101. User Specified Property is handled by SAYMON UI in the same way it handles Info Property.