ReferenceModel

Description

An object that represents a model referenced in other models. It contains minimum data to identify a model.

Model Properties

Property Required Type Description
id True string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name False string A string containing the name of the referenced model