SAYMON REST API
Search…
Property
The Property Model
Field
Type
Description
id
String
Property's ID.
name
String
requiredProperty's name.
type_id
Integer
requiredProperty's type ID. See below.
value
String
requiredProperty's value.
Property's Type ID
Value
Name
Description
1
Info
Ordinary descriptive "key":"value" property. These properties are displayed in Properties section of SAYMON UI.
2
Readonly
Same to Info property, but cannot be modified in SAYMON UI.
3
ReadWrite
Same to Info property, but on its modification Operation with runOnReadWritePropertyModification:true flag is executed.
6
ExternalDocument
Weblinks 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 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. So to preserve any conflicts we reserved first 100 type ids for the future needs of SAYMON, while you can use your own ids starting with 101'th value. User Specified Property is handled by SAYMON UI in the same way it handles Info Property - displays it in Properties section.
​
Last modified 1mo ago
Copy link