Configuring compound datatypes
You can add new properties to Cloud API resources. This can be a new property in a base configuration resource, or a new property in a custom resource. The data mapping requirements for the new property depends on the value that the property stores. The following table summarizes the different use cases.
| Value stored in property | Example Property | More information |
|---|---|---|
| Scalar | Activity.LegacySystemID_Ext, which stores a string
identifying the ID for the object in a legacy system |
Configuring scalars |
| Compound value, such as a typekey or monetary amount | Activity.SLAPriority_Ext, which stores a value from
the Priority typelist (such as urgent,
high, or low) |
This topic |
| Foreign key | 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 | 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 |
This topic describes how to extend schemas to include new compound datatype fields.
- For a detailed overview of schema architecture and extension file syntax in Cloud API, see Overview of schema configuration.
- If you want to interact directly with the concepts in this topic, go to the following tutorial: