Adding properties to Cloud API resources
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 depend 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 |
Adding scalar properties in Cloud API |
| 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) |
Adding Cloud API compound datatype properties |
| 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. |
Adding Cloud API foreign key properties |
| 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. |
Adding one-to-one properties in Cloud API |
For a detailed overview of schema architecture and extension file syntax in Cloud API, see Cloud API schema configuration file syntax
If you want to interact directly with the concepts in this topic, go to the following tutorial: Tutorial: Cloud API schema configuration with scalars
Note: Guidewire does not recommend adding inline arrays to
schemas. If a given resource has an array of related resources and you want to
expose those related resource in Cloud API, Guidewire recommends doing so by
creating a separate set of child endpoints for the related resources. For
information on how to create endpoints for a resource, see Overview of the Cloud API REST endpoint generator.