RelatedEntityRefOrValue

Extends

Extensible

A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

@baseType

No

No

String

When sub-classing, this defines the super-class

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

role

Yes

No

String

Role played by the related entity

entity

Yes

No

EntityRefOrValue