Member Definition Object
The Member Definition Object defines either a property or relation definition on an entity definition.
Property Definitions
There are eight types of property definitions: Boolean, Decimal, Integer, Long, String, DateTime, File Reference and Json. Each contains the following properties:
| Name | Type | Description |
|---|---|---|
| type | String | The type of property. Can be one of the following: "Boolean", "Decimal", "Integer", "Long", "String", "DateTime", "FileReference" or "Json". |
| name | String | The name of the property. |
| labels | Labels | The labels of this property. |
| is_indexed | Boolean | True if this property is searchable. |
| is_mandatory | Boolean | True if this property must have a value during validation. |
| is_multivalue | Boolean | True if this property has multiple values. |
| is_multilanguage | Boolean | True if this property has multiple languages. |
| is_display_property | Boolean | True if this property is used to describe the entity. Only one properties in an entity definition can be set to true. |
For property definitions of type "String", two more properties are available:
| Name | Type | Description |
|---|---|---|
| is_multiline | Boolean | True if this string property supports line breaks. |
| validation_expression | String | A string containing a regular expression that the property value must match. |
Relation Definitions
Relation definitions contain the following properties:
| Name | Type | Description |
|---|---|---|
| type | String | Contains "Relation" to define this member definition as a relation definition. |
| name | String | The name of the relation. |
| labels | Labels | The labels of the relation. |
| role | String | Contains either "Parent" or "Child" to describe if this is the parent or child side of the relation. |
| is_indexed | Boolean | True if this property supports searching. |
| cardinality | String | Contains either "OneToOne" or "OneToMany" to describe the cardinality of this relation. |
| child_is_mandatory | Boolean | True if at least one child is required for this relation to be valid. |
| parent_is_mandatory | Boolean | True if at least one parent is required for this relation to be valid. |
| associated_entitydefinition | Link | A link to the entity definition for the related entities. |
| inherits_security | Boolean | True if this relation participates in resolving permissions. |
Example
See Entity Definition Object for an example representation
Can we improve this article ? Provide feedback