AAS ASYNC API with CloudEvents 0.3-SNAPSHOT

Operations

• SEND noauth or all or participantid

  Operation IDaas/update/elementupdated.publish

  Parameters

  Expand all

  object

  aasid

  required

  string

  The Id of the asset administration shell.

  submodelid

  required

  string

  The Id of the submodel in the Asset Administration Shell with aasId.

  smec-idshort.property-idshort

  required

  string

  The Id of a property in a Submodel Element Collection.

  Accepts the following message:

  AAS Element Update messagepublish.message

  Emitted when an AAS 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 element can be obtained from. The element must be of the type indicated in the dataschema property.

  Examples values:
  • "https://providercorp.com/shells/abcd"

  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"
  • "io.admin-shell.events.v1.updated"
  • "io.admin-shell.events.v1.deleted"

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

  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://raw.githubusercontent.com/admin-shell-io/aas-specs-metamodel/refs/heads/master/schemas/json/aas.json#/definitions/AssetAdministrationShell"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2024-11-26T10:46:33.2171298+01:00"

  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

  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

  restricted any

  administration

  Expand all

  allOf

  Consists 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.

  And of:

  Expand all

  restricted any

  version

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 4 ] 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: ^(0|[1-9][0-9]*)$

  revision

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 4 ] 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: ^(0|[1-9][0-9]*)$

  creator

  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.

  templateId

  string

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

  id

  required

  string

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

  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.

  And of:

  Expand all

  restricted any

  derivedFrom

  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.

  assetInformation

  Expand all

  required

  object

  assetKind

  required

  string

  Allowed values:
  • "Instance"
  • "NotApplicable"
  • "Role"
  • "Type"

  globalAssetId

  string

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

  specificAssetIds

  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 .. 64 ] characters

  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

  externalSubjectId

  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.

  assetType

  string

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

  defaultThumbnail

  Expand all

  object

  path

  Expand all

  required

  string allOf

  Consists of:

  restricted any

  [ 1 .. 2048 ] 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]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;:&=+$,])*@)?((([a-zA-Z0-9]|[a-zA-Z0-9]([a-zA-Z0-9]|-)*[a-zA-Z0-9])\.)*([a-zA-Z]|[a-zA-Z]([a-zA-Z0-9]|-)*[a-zA-Z0-9])(\.)?|[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)(:[0-9]*)?)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[$,;:@&=+])+)(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?|/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)(\?(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;?:@&=+$,])(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)|(//((((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;:&=+$,])*@)?((([a-zA-Z0-9]|[a-zA-Z0-9]([a-zA-Z0-9]|-)*[a-zA-Z0-9])\.)*([a-zA-Z]|[a-zA-Z]([a-zA-Z0-9]|-)*[a-zA-Z0-9])(\.)?|[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)(:[0-9]*)?)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[$,;:@&=+])+)(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?|/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;@&=+$,])+(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?)(\?(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?)?(#(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?$

  contentType

  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: ^([!#$%&'*+\-.^_`|~0-9a-zA-Z])+/([!#$%&'*+\-.^_`|~0-9a-zA-Z])+([ \t]*;[ \t]*([!#$%&'*+\-.^_`|~0-9a-zA-Z])+=(([!#$%&'*+\-.^_`|~0-9a-zA-Z])+|"(([\t !#-\[\]-~]|[\x80-\xff])|\\([\t !-~]|[\x80-\xff]))*"))*$

  Additional properties are allowed.

  Additional properties are allowed.

  submodels

  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.

  modelType

  string

  Const:"AssetAdministrationShell"

  Examples

  Payload

  • #1 Example - AAS element updated

    {
      "specversion": "1.0",
      "id": "358c02f2-3a11-4836-971b-43a05550bf97",
      "source": "https://providercorp.com/shells/aHR0cHM6Ly9leGFtcGxlLmNvbS9hYXMv",
      "type": "io.admin-shell.events.v1.updated",
      "datacontenttype": "application/json",
      "dataschema": "https://raw.githubusercontent.com/admin-shell-io/aas-specs-metamodel/refs/heads/master/schemas/json/aas.json#/definitions/AssetAdministrationShell",
      "time": "2024-11-26T10:46:33.2171298+01:00",
      "data": {
        "id": "https://example.com/aas/robot-arm-001",
        "modelType": "AssetAdministrationShell",
        "idShort": "RobotArm001",
        "description": [
          {
            "language": "en",
            "text": "Asset Administration Shell for industrial robot arm"
          }
        ],
        "assetInformation": {
          "assetKind": "Instance",
          "globalAssetId": "urn:example:robot-arm:serial:12345"
        },
        "submodels": [
          {
            "type": "ModelReference",
            "keys": [
              {
                "type": "Submodel",
                "value": "https://example.com/submodels/nameplate-001"
              }
            ]
          }
        ]
      }
    }
    

• SEND noauth or all or participantid

  Operation IDaas/update/elementcreated.publish

  Accepts the following message:

  AAS Element Create messagepublish.message

  Emitted when an AAS element is created

  Message IDpublish.message

  Payload

  Expand all

  object

  specversion

  required

  string

  The version of the CloudEvents specification which the event uses.

  Const:"1.0"

  id

  required

  string

  Identifies the event.

  Examples values:
  • "ecbd132e-d834-4528-bb30-6790104ca474"

  source

  required

  string

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

  The URL the emitting element can be obtained from. The element must be of the type indicated in the dataschema property.

  Examples values:
  • "https://mycorp.com/aas-repo/shells/bXktYWFzCg=="

  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"
  • "io.admin-shell.events.v1.updated"
  • "io.admin-shell.events.v1.deleted"

  Examples 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/AssetAdministrationShell"

  time

  required

  string

  format: date-time

  Timestamp of when the occurrence happened.

  Examples values:
  • "2024-11-26T10:44:11.9367113+01:00"

  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

  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

  restricted any

  administration

  Expand all

  allOf

  Consists 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.

  And of:

  Expand all

  restricted any

  version

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 4 ] 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: ^(0|[1-9][0-9]*)$

  revision

  Expand all

  string allOf

  Consists of:

  restricted any

  [ 1 .. 4 ] 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: ^(0|[1-9][0-9]*)$

  creator

  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.

  templateId

  string

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

  id

  required

  string

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

  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.

  And of:

  Expand all

  restricted any

  derivedFrom

  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.

  assetInformation

  Expand all

  required

  object

  assetKind

  required

  string

  Allowed values:
  • "Instance"
  • "NotApplicable"
  • "Role"
  • "Type"

  globalAssetId

  string

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

  specificAssetIds

  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 .. 64 ] characters

  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

  externalSubjectId

  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.

  assetType

  string

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

  defaultThumbnail

  Expand all

  object

  path

  Expand all

  required

  string allOf

  Consists of:

  restricted any

  [ 1 .. 2048 ] 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]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;:&=+$,])*@)?((([a-zA-Z0-9]|[a-zA-Z0-9]([a-zA-Z0-9]|-)*[a-zA-Z0-9])\.)*([a-zA-Z]|[a-zA-Z]([a-zA-Z0-9]|-)*[a-zA-Z0-9])(\.)?|[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)(:[0-9]*)?)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[$,;:@&=+])+)(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?|/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)(\?(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;?:@&=+$,])(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)|(//((((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;:&=+$,])*@)?((([a-zA-Z0-9]|[a-zA-Z0-9]([a-zA-Z0-9]|-)*[a-zA-Z0-9])\.)*([a-zA-Z]|[a-zA-Z]([a-zA-Z0-9]|-)*[a-zA-Z0-9])(\.)?|[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)(:[0-9]*)?)?|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[$,;:@&=+])+)(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?|/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*|(([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[;@&=+$,])+(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*(/((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*(;((([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])|[:@&=+$,]))*)*)*)?)(\?(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?)?(#(([;/?:@&=+$,]|([a-zA-Z0-9]|[-_.!~*'()])|%([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])([0-9]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF]|[aA]|[bB]|[cC]|[dD]|[eE]|[fF])))*)?$

  contentType

  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: ^([!#$%&'*+\-.^_`|~0-9a-zA-Z])+/([!#$%&'*+\-.^_`|~0-9a-zA-Z])+([ \t]*;[ \t]*([!#$%&'*+\-.^_`|~0-9a-zA-Z])+=(([!#$%&'*+\-.^_`|~0-9a-zA-Z])+|"(([\t !#-\[\]-~]|[\x80-\xff])|\\([\t !-~]|[\x80-\xff]))*"))*$

  Additional properties are allowed.

  Additional properties are allowed.

  submodels

  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.

  modelType

  string

  Const:"AssetAdministrationShell"

  Additional properties are allowed.

  Examples

  Payload

  • #1 Example - AAS element created

    {
      "specversion": "1.0",
      "id": "ecbd132e-d834-4528-bb30-6790104ca474",
      "source": "https://mycorp.com/aas-repo/shells/aHR0cHM6Ly9leGFtcGxlLmNvbS9hYXMv",
      "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/AssetAdministrationShell",
      "time": "2024-11-26T10:44:11.9367113+01:00",
      "data": {
        "id": "https://example.com/aas/pump-unit-007",
        "modelType": "AssetAdministrationShell",
        "idShort": "PumpUnit007",
        "description": [
          {
            "language": "en",
            "text": "Asset Administration Shell for pump unit 007"
          },
          {
            "language": "de",
            "text": "Verwaltungsschale für Pumpeinheit 007"
          }
        ],
        "assetInformation": {
          "assetKind": "Instance",
          "globalAssetId": "urn:example:pump:serial:PMP-007",
          "specificAssetIds": [
            {
              "name": "serialNumber",
              "value": "PMP-007"
            }
          ]
        },
        "submodels": [
          {
            "type": "ModelReference",
            "keys": [
              {
                "type": "Submodel",
                "value": "https://example.com/submodels/technical-data-007"
              }
            ]
          }
        ]
      }
    }