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.

Every property of an entity must have a unique name.

Property Model

Field Type Description

Field	Type	Description
id	String	Property’s ID.
name	String	Property’s name.
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.
type_id	Integer	Property’s type ID. See below.
value	String	Property’s value.

String

Property’s ID.

name

String

Property’s name.

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.

type_id

Integer

Property’s type ID. See below.

value

String

Property’s value.

Property’s Type ID

Value Name Description

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	Files uploaded to Object. These properties are displayed in Documents section of SAYMON UI. Supported formats: PDF DOC DOCX XLS XLSX ZIP
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 the first 100 type IDs are reserved 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.

Info

Ordinary descriptive "key":"value" property. These properties are displayed in Properties section of SAYMON UI. This is the default value.

Readonly

Same as the Info property, but can’t be modified in SAYMON UI.

ReadWrite

Same as the Info property, but on its modification Operation with runOnReadWritePropertyModification:true flag is executed.

Has no special functionality. Acts the same as Info property type.

ExternalDocument

Web links to external resources. These properties are displayed in Documents section of SAYMON UI.

UploadedDocument

Files uploaded to Object. These properties are displayed in Documents section of SAYMON UI.

Supported formats:

PDF
DOC
DOCX
XLS
XLSX
ZIP

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 the first 100 type IDs are reserved 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.