AAS SubmodelElement ASYNC API with CloudEvents 0.3-SNAPSHOT

Operations

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/valuechanged.publish

  Accepts the following message:

  SubmodelElement Value Change messagepublish.message

  Triggered when the value of an element is updated

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL the emitting Referable can be obtained from.

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.emitting.dataelelement"

  type

  required

  string

  Describes the type of the event related to the source the event originated in.

  Allowed values:
  • "io.admin-shell.events.v1.valueChanged"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  dataschema

  required

  string

  format: uri

  Identifies the schema that the event data adheres to.

  Examples values:
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property"
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/File"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  data

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  extensions

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  name

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  refersTo

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  category

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  idShort

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 128 ] characters

  And of:

  restricted any

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  And of:

  restricted any

  must match: ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$

  displayName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 128 characters

  description

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  And of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  object

  qualifiers

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  kind

  string

  Allowed values:
  • "ConceptQualifier"
  • "TemplateQualifier"
  • "ValueQualifier"

  type

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  required

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  object

  embeddedDataSpecifications

  Expand all

  array<object>

  non-empty

  object

  dataSpecification

  Expand all

  required

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  dataSpecificationContent

  Expand all

  required

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  preferredName

  Expand all

  required

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 255 characters

  shortName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 18 characters

  unit

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  unitId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  sourceOfDefinition

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  symbol

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  dataType

  string

  Allowed values:
  • "BLOB"
  • "BOOLEAN"
  • "DATE"
  • "FILE"
  • "HTML"
  • "INTEGER_COUNT"
  • "INTEGER_CURRENCY"
  • "INTEGER_MEASURE"
  • "IRDI"
  • "IRI"
  • "RATIONAL"
  • "RATIONAL_MEASURE"
  • "REAL_COUNT"
  • "REAL_CURRENCY"
  • "REAL_MEASURE"
  • "STRING"
  • "STRING_TRANSLATABLE"
  • "TIME"
  • "TIMESTAMP"

  definition

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  valueFormat

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  valueList

  Expand all

  object

  valueReferencePairs

  Expand all

  required

  array<object>

  non-empty

  object

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  levelType

  Expand all

  object

  min

  required

  boolean

  nom

  required

  boolean

  typ

  required

  boolean

  max

  required

  boolean

  Additional properties are allowed.

  modelType

  string

  Const:"DataSpecificationIec61360"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example - Property value changed

    {
      "specversion": "1.0",
      "id": "358c02f2-3a11-4836-971b-43a05550bf97",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvb3BlcmF0aW9uYWwtZGF0YQ==/submodel-elements/Sensors.TemperatureSensor01.CurrentTemperature",
      "type": "io.admin-shell.events.v1.valueChanged",
      "datacontenttype": "application/json",
      "dataschema": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property",
      "time": "2025-09-25T13:37:12.3456789+01:00",
      "semanticid": "0173-1#02-AAA119#002",
      "data": {
        "idShort": "CurrentTemperature",
        "modelType": "Property",
        "valueType": "xs:float",
        "value": "72.4",
        "semanticId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "GlobalReference",
              "value": "0173-1#02-AAA119#002"
            }
          ]
        }
      }
    }
    

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/elementcreated.publish

  Accepts the following message:

  SubmodelElement Create messagepublish.message

  Triggered when an element is created

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL the emitting Referable can be obtained from.

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.emitting.referable"

  type

  required

  string

  Describes the type of the event related to the source the event originated in.

  Allowed values:
  • "io.admin-shell.events.v1.created"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  dataschema

  required

  string

  format: uri

  Identifies the schema that the event data adheres to.

  Examples values:
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property"
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/File"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  data

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  extensions

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  name

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  refersTo

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  category

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  idShort

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 128 ] characters

  And of:

  restricted any

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  And of:

  restricted any

  must match: ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$

  displayName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 128 characters

  description

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  And of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  object

  qualifiers

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  kind

  string

  Allowed values:
  • "ConceptQualifier"
  • "TemplateQualifier"
  • "ValueQualifier"

  type

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  required

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  object

  embeddedDataSpecifications

  Expand all

  array<object>

  non-empty

  object

  dataSpecification

  Expand all

  required

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  dataSpecificationContent

  Expand all

  required

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  preferredName

  Expand all

  required

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 255 characters

  shortName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 18 characters

  unit

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  unitId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  sourceOfDefinition

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  symbol

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  dataType

  string

  Allowed values:
  • "BLOB"
  • "BOOLEAN"
  • "DATE"
  • "FILE"
  • "HTML"
  • "INTEGER_COUNT"
  • "INTEGER_CURRENCY"
  • "INTEGER_MEASURE"
  • "IRDI"
  • "IRI"
  • "RATIONAL"
  • "RATIONAL_MEASURE"
  • "REAL_COUNT"
  • "REAL_CURRENCY"
  • "REAL_MEASURE"
  • "STRING"
  • "STRING_TRANSLATABLE"
  • "TIME"
  • "TIMESTAMP"

  definition

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  valueFormat

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  valueList

  Expand all

  object

  valueReferencePairs

  Expand all

  required

  array<object>

  non-empty

  object

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  levelType

  Expand all

  object

  min

  required

  boolean

  nom

  required

  boolean

  typ

  required

  boolean

  max

  required

  boolean

  Additional properties are allowed.

  modelType

  string

  Const:"DataSpecificationIec61360"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example - SubmodelElement created

    {
      "specversion": "1.0",
      "id": "ecbd132e-d834-4528-bb30-6790104ca474",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvb3BlcmF0aW9uYWwtZGF0YQ==/submodel-elements/Sensors",
      "type": "io.admin-shell.events.v1.created",
      "datacontenttype": "application/json",
      "dataschema": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property",
      "time": "2025-09-25T13:37:12.3456789+01:00",
      "semanticid": "0173-1#02-AAA119#002",
      "data": {
        "idShort": "PressureSensor02",
        "modelType": "Property",
        "valueType": "xs:float",
        "value": "1.013",
        "semanticId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "GlobalReference",
              "value": "0173-1#02-AAZ337#001"
            }
          ]
        }
      }
    }
    

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/elementupdated.publish

  Accepts the following message:

  SubmodelElement Update messagepublish.message

  Triggered when an element is updated

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL the emitting Referable can be obtained from.

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.emitting.referable"

  type

  required

  string

  Describes the type of the event related to the source the event originated in.

  Allowed values:
  • "io.admin-shell.events.v1.updated"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  dataschema

  required

  string

  format: uri

  Identifies the schema that the event data adheres to.

  Examples values:
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property"
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/File"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  data

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  extensions

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  name

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  refersTo

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  category

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  idShort

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 128 ] characters

  And of:

  restricted any

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  And of:

  restricted any

  must match: ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$

  displayName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 128 characters

  description

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  And of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  object

  qualifiers

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  kind

  string

  Allowed values:
  • "ConceptQualifier"
  • "TemplateQualifier"
  • "ValueQualifier"

  type

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  required

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  object

  embeddedDataSpecifications

  Expand all

  array<object>

  non-empty

  object

  dataSpecification

  Expand all

  required

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  dataSpecificationContent

  Expand all

  required

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  preferredName

  Expand all

  required

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 255 characters

  shortName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 18 characters

  unit

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  unitId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  sourceOfDefinition

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  symbol

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  dataType

  string

  Allowed values:
  • "BLOB"
  • "BOOLEAN"
  • "DATE"
  • "FILE"
  • "HTML"
  • "INTEGER_COUNT"
  • "INTEGER_CURRENCY"
  • "INTEGER_MEASURE"
  • "IRDI"
  • "IRI"
  • "RATIONAL"
  • "RATIONAL_MEASURE"
  • "REAL_COUNT"
  • "REAL_CURRENCY"
  • "REAL_MEASURE"
  • "STRING"
  • "STRING_TRANSLATABLE"
  • "TIME"
  • "TIMESTAMP"

  definition

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  valueFormat

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  valueList

  Expand all

  object

  valueReferencePairs

  Expand all

  required

  array<object>

  non-empty

  object

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  levelType

  Expand all

  object

  min

  required

  boolean

  nom

  required

  boolean

  typ

  required

  boolean

  max

  required

  boolean

  Additional properties are allowed.

  modelType

  string

  Const:"DataSpecificationIec61360"

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example - SubmodelElement updated

    {
      "specversion": "1.0",
      "id": "7f3c1a2b-9e44-4c31-bc01-2890abc45678",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvbmFtZXBsYXRl/submodel-elements/ManufacturerName",
      "type": "io.admin-shell.events.v1.updated",
      "datacontenttype": "application/json",
      "dataschema": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Property",
      "time": "2025-09-25T13:37:12.3456789+01:00",
      "semanticid": "0173-1#02-AAO677#001",
      "data": {
        "idShort": "ManufacturerName",
        "modelType": "Property",
        "valueType": "xs:string",
        "value": "Example Corp GmbH (updated)"
      }
    }
    

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/elementdeleted.publish

  Accepts the following message:

  SubmodelElement Delete messagepublish.message

  Triggered when an element is deleted

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL of the referable in which the emitting referable was contained

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.containing.referable"
  • "https://providercorp.com/submodels/b64encoded-id"

  type

  required

  string

  Describes the type of the event related to the source the event originated in.

  Allowed values:
  • "io.admin-shell.events.v1.deleted"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  Examples

  Payload

  • #1 Example - SubmodelElement deleted

    {
      "specversion": "1.0",
      "id": "9a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvb3BlcmF0aW9uYWwtZGF0YQ==/submodel-elements/ManufacturerName",
      "type": "io.admin-shell.events.v1.deleted",
      "datacontenttype": "application/json",
      "time": "2025-09-25T13:37:12.3456789+01:00",
      "semanticid": "0173-1#02-AAA119#002"
    }
    

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/operationinvoked.publish

  Accepts the following message:

  Operation Invoke messagepublish.message

  Triggered when an operation is invoked

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL the operation element can be obtained from.

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.operation.element"

  type

  required

  string

  Describes the type of the event related to the source the event originated in.

  Allowed values:
  • "io.admin-shell.events.v1.invoked"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  dataschema

  required

  string

  format: uri

  Identifies the schema that the event data adheres to.

  Examples values:
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Operation"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  data

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  extensions

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  name

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  refersTo

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  category

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  idShort

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 128 ] characters

  And of:

  restricted any

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  And of:

  restricted any

  must match: ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$

  displayName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 128 characters

  description

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  And of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  object

  qualifiers

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  kind

  string

  Allowed values:
  • "ConceptQualifier"
  • "TemplateQualifier"
  • "ValueQualifier"

  type

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 128 ] characters

  valueType

  required

  string

  Allowed values:
  • "xs:anyURI"
  • "xs:base64Binary"
  • "xs:boolean"
  • "xs:byte"
  • "xs:date"
  • "xs:dateTime"
  • "xs:decimal"
  • "xs:double"
  • "xs:duration"
  • "xs:float"
  • "xs:gDay"
  • "xs:gMonth"
  • "xs:gMonthDay"
  • "xs:gYear"
  • "xs:gYearMonth"
  • "xs:hexBinary"
  • "xs:int"
  • "xs:integer"
  • "xs:long"
  • "xs:negativeInteger"
  • "xs:nonNegativeInteger"
  • "xs:nonPositiveInteger"
  • "xs:positiveInteger"
  • "xs:short"
  • "xs:string"
  • "xs:time"
  • "xs:unsignedByte"
  • "xs:unsignedInt"
  • "xs:unsignedLong"
  • "xs:unsignedShort"

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  object

  embeddedDataSpecifications

  Expand all

  array<object>

  non-empty

  object

  dataSpecification

  Expand all

  required

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  dataSpecificationContent

  Expand all

  required

  oneOf

  Adheres to:

  Expand all

  allOf

  Consists of:

  Expand all

  object

  modelType

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataSpecificationIec61360"
  • "Entity"
  • "File"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  preferredName

  Expand all

  required

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 255 characters

  shortName

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 18 characters

  unit

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  unitId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  sourceOfDefinition

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  symbol

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  dataType

  string

  Allowed values:
  • "BLOB"
  • "BOOLEAN"
  • "DATE"
  • "FILE"
  • "HTML"
  • "INTEGER_COUNT"
  • "INTEGER_CURRENCY"
  • "INTEGER_MEASURE"
  • "IRDI"
  • "IRI"
  • "RATIONAL"
  • "RATIONAL_MEASURE"
  • "REAL_COUNT"
  • "REAL_CURRENCY"
  • "REAL_MEASURE"
  • "STRING"
  • "STRING_TRANSLATABLE"
  • "TIME"
  • "TIMESTAMP"

  definition

  Expand all

  array<allOf>

  non-empty

  Items:

  allOf

  Consists of:

  Expand all

  object

  language

  required

  string

  must match: ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

  text

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  text

  restricted any

  <= 1023 characters

  valueFormat

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$non-empty

  valueList

  Expand all

  object

  valueReferencePairs

  Expand all

  required

  array<object>

  non-empty

  object

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  valueId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  any

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  keys

  Expand all

  required

  array<object>

  non-empty

  object

  type

  required

  string

  Allowed values:
  • "AnnotatedRelationshipElement"
  • "AssetAdministrationShell"
  • "BasicEventElement"
  • "Blob"
  • "Capability"
  • "ConceptDescription"
  • "DataElement"
  • "Entity"
  • "EventElement"
  • "File"
  • "FragmentReference"
  • "GlobalReference"
  • "Identifiable"
  • "MultiLanguageProperty"
  • "Operation"
  • "Property"
  • "Range"
  • "Referable"
  • "ReferenceElement"
  • "RelationshipElement"
  • "Submodel"
  • "SubmodelElement"
  • "SubmodelElementCollection"
  • "SubmodelElementList"

  value

  required

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  value

  string

  must match: ^([\x09\x0a\x0d\x20-\ud7ff\ue000-\ufffd]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$[ 1 .. 2048 ] characters

  levelType

  Expand all

  object

  min

  required

  boolean

  nom

  required

  boolean

  typ

  required

  boolean

  max

  required

  boolean

  Additional properties are allowed.

  modelType

  string

  Const:"DataSpecificationIec61360"

  Additional properties are allowed.

  Additional properties are allowed.

  And of:

  Expand all

  restricted any

  inputVariables

  Expand all

  array<any>

  non-empty

  Items:

  any

  outputVariables

  Expand all

  array<any>

  non-empty

  Items:

  any

  inoutputVariables

  Expand all

  array<any>

  non-empty

  Items:

  any

  modelType

  string

  Const:"Operation"

  Examples

  Payload

  • #1 Example - Operation invoked

    {
      "specversion": "1.0",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvY29udHJvbA==/submodel-elements/StartMotor",
      "type": "io.admin-shell.events.v1.invoked",
      "datacontenttype": "application/json",
      "dataschema": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Operation",
      "time": "2025-09-25T13:37:12.3456789+01:00",
      "semanticid": "0173-1#02-ABI006#001",
      "data": {
        "idShort": "StartMotor",
        "modelType": "Operation",
        "inputVariables": [
          {
            "value": {
              "idShort": "TargetSpeed",
              "modelType": "Property",
              "valueType": "xs:int",
              "value": "3000"
            }
          }
        ],
        "outputVariables": [
          {
            "value": {
              "idShort": "OperationHandle",
              "modelType": "Property",
              "valueType": "xs:string"
            }
          }
        ]
      }
    }
    

• SEND noauth or all or participantid

  Operation IDsubmodelelement/update/operationfinished.publish

  Accepts the following message:

  Operation Finish messagepublish.message

  Triggered when an operation is finished

  Message IDpublish.message

  Payload

  Expand all

  restricted any

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "358c02f2-3a11-4836-971b-43a05550bf97"

  source

  required

  string

  must match: ^https?:\/\/[^\s/$.?#].[^\s]*$

  The URL the operation element can be obtained from.

  Examples values:
  • "https://providercorp.com/submodels/b64encoded-id/submodel-elements/idshort.path.to.operation.element"

  type

  required

  string

  Describes the type of the event.

  Allowed values:
  • "io.admin-shell.events.v1.finished"

  datacontenttype

  required

  string

  Content type of the event data.

  Const:"application/json"

  dataschema

  required

  string

  format: uri

  Identifies the schema that the event data adheres to.

  Examples values:
  • "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/OperationVariable"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2025-09-25T13:37:12.3456789+01:00"

  semanticid

  string

  The semanticId of the SubmodelElement, if available. (This property may hold the entry in the semanticId's keys-array at index 0)

  Examples values:
  • "0173-1#02-AAA119#002"

  data

  Expand all

  object

  inoutputArguments

  Expand all

  array<object>

  The supplied inoutput variable(s) for an operation invocation.

  Examples values:
  • "[ {"idShort":"MyInoutputArgument", "value": 100} ]"

  object

  value

  required

  any

  Additional properties are allowed.

  outputArguments

  Expand all

  array<object>

  The output variable(s) as the operation result.

  Examples values:
  • "[ {"idShort":"MyOperationOutput", "value": 123456} ]"
  • {"idShort":"something3fdd3eb4","inputVariables":[{"value":{"idShort":"something_c8b0a9a0","modelType":"File"}}],"modelType":"Operation"}

  object

  value

  required

  any

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example - Operation finished successfully

    {
      "specversion": "1.0",
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "source": "https://providercorp.com/submodels/aHR0cHM6Ly9leGFtcGxlLmNvbS9zdWJtb2RlbHMvY29udHJvbA==/submodel-elements/StartMotor",
      "type": "io.admin-shell.events.v1.finished",
      "datacontenttype": "application/json",
      "dataschema": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/OperationVariable",
      "time": "2025-09-25T13:37:15.7654321+01:00",
      "semanticid": "0173-1#02-ABI006#001",
      "data": {
        "inoutputArguments": [
          {
            "value": {
              "idShort": "TargetSpeed",
              "modelType": "Property",
              "valueType": "xs:int",
              "value": "3000"
            }
          }
        ],
        "outputArguments": [
          {
            "value": {
              "idShort": "ActualSpeed",
              "modelType": "Property",
              "valueType": "xs:int",
              "value": "2998"
            }
          }
        ]
      }
    }