Adding new properties to schemas
The schema configuration steps needed for a new property depend on the datatype of the property. The following table lists different datatypes and where you can go for information on how to configure schema with properties of that type.
Type | Definition | Example property | More information |
---|---|---|---|
Scalar | A single simple value, such as a string, number, datetime, or Boolean. | Activity.LegacySystemID_Ext , which stores a string
identifying the ID for the object in a legacy system |
Configuring scalars |
Compound datatype | A set of multiple values stored as a single unit. The most common type of compound datatype is a typekey, which consists of a code and a name. | Activity.SLAPriority_Ext , which stores a value from
the Priority typelist (such as urgent ,
high , or low ) |
Configuring compound datatypes |
Foreign key | A reference to another object. Typically, the referenced object has its own set of CRUD endpoints, and other objects may also reference it. | Activity.ApprovalUser_Ext , which stores a foreign
key to the User data model entity. There are separate
CRUD endpoints for the User entity. |
Configuring foreign keys |
One-to-ones | A reference to another object. Typically, the referenced object does not have its own set of CRUD endpoints, and no other object references it. | Activity.ForeignMarketFees_Ext , which stores a
one-to-one key to the ForeignMarketFees_Ext data model
entity. The ForeignMarketFees_Ext entity does not have
its own set of CRUD endpoints. Instead, the object is inlined into the
Activity schema. |
Configuring one-to-ones |