Skip to content

EntitySpecification

EntitySpecification

Data type: Entity

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
@baseType string When sub-classing, this defines the super-class
@schemaLocation string A URI to a JSON-Schema file that defines additional attributes and relationships
id string Unique identifier 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
href URI Hyperlink reference https://api.example.org/resource/id
name string Name given to the specification EntityName
description string Description of the specification Lorem ipsum dolor
lastUpdate DateTime Date and time of the last update of the specification 2023-01-01T08:00:00+01:00
lifecycleStatus string Used to indicate the current lifecycle status of this catalog item active
isBundle boolean Determines whether specification represents a single specification (false), or a bundle of specifications (true). example: true null
validFor TimePeriod
version string Specification version 1.0
attachment AttachmentRefOrValue [n..m] Attachments that may be of relevance to this specification, such as picture, document, media []
targetEntitySchema TargetEntitySchema
specCharacteristic CharacteristicSpecification [n..m] List of characteristics that the entity can take []
relatedParty RelatedPartyOrPartyRole [n..m] Parties who manage or otherwise have an interest in this specification []