Digital Twin Registry - Async API

Accepts one of the following messages:

• #0Create a single TwincreateTwinV1.message

  • application/json

  Message IDcreateTwinV1.message

  Payload

  Expand all

  object

  Create a single Twin v1

  twinType

  string

  <= 128 characters

  The type of the Twin

  Examples values:
  • "Bosch Nexo cordless Wi-Fi nutrunner"

  twinCategory

  string

  <= 128 characters

  The category of the Twin

  Examples values:
  • "Drill"

  description

  string

  <= 4000 characters

  Detailed description of the Twin

  Examples values:
  • "On Nexo the complete control unit is in the nutrunner – the first of its kind."

  manufacturer

  string

  <= 128 characters

  Manufacturer of the physical asset represented by the Twin

  Examples values:
  • "Bosch"

  localIdentifiers

  Expand all

  required

  array<object>

  [ 1 .. 10 ] unique items

  Local Identifiers of the Twin

  object

  Specific Local Identifier from the list of the Twin

  localIdentifierKeyPairs

  Expand all

  required

  array<object>

  [ 1 .. 5 ] unique items

  object

  Specify the key and values of the Local Identifier

  key

  required

  string

  [ 1 .. 64 ] characters

  Local Identifier key

  Examples values:
  • "serialNumber"

  value

  required

  string

  [ 1 .. 128 ] characters

  Local Identifier value

  Examples values:
  • "123456"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  labels

  Expand all

  array<string>

  <= 10 unique items

  Labels of the Twin

  Items:

  string

  Examples values:
  • "cordless-drills"

  groups

  Expand all

  array<integer>

  <= 50 unique items

  Twin Groups in which the Twin shall be a member.

  Items:

  read-only

  integer

  format: int64

  Internal unique id of an entity which will be set by the service. A nil ID value of '0L' is reserved for resolved virtual Aspects or HTTP endpoints.

  Examples values:
  • 5821

  twinKind

  string

  Kind of the Twin

  Allowed values:
  • "TYPE"
  • "INSTANCE"
  • "ROLE"
  • "NOT_APPLICABLE"

  Examples values:
  • "INSTANCE"

  Additional properties are NOT allowed.

  Headers

  Expand all

  object

  Kafka headers

  schema-name

  required

  string

  The name of the Schema we are using

  Const:"CreateTwin:v1"

  correlation-id

  required

  string

  must match: [0-9a-zA-Z\-_:]{1,128}[ 1 .. 128 ] characters

  A unique Id identifying the message. This will be included as-is in the corresponding response message. We recommend using a well established ID format like UUID or Snowflake ID to ensure uniqueness.

  Examples values:
  • "e44d286e-afe3-4d88-b5cd-c32ad9e95965"

  Additional properties are allowed.

  • #Command
  • #Create
  • #Twins

  Examples

  Payload

  {
    "twinType": "Bosch Nexo cordless Wi-Fi nutrunner",
    "twinCategory": "Drill",
    "description": "On Nexo the complete control unit is in the nutrunner – the first of its kind.",
    "manufacturer": "Bosch",
    "localIdentifiers": [
      {
        "localIdentifierKeyPairs": [
          {
            "key": "serialNumber",
            "value": "123456"
          }
        ]
      }
    ],
    "labels": [
      "cordless-drills"
    ],
    "groups": [
      5821
    ],
    "twinKind": "INSTANCE"
  }
  

  This example has been generated automatically.

  Headers

  {
    "schema-name": "CreateTwin:v1",
    "correlation-id": "e44d286e-afe3-4d88-b5cd-c32ad9e95965"
  }
  

  This example has been generated automatically.

• #1Create a single ShellcreateShellV1.message

  • application/json

  Message IDcreateShellV1.message

  Payload

  Expand all

  object

  Create a single Shell v1

  description

  Expand all

  array<object>

  <= 50 unique items

  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)))$

  Examples values:
  • "en"

  text

  required

  string

  [ 1 .. 1023 ] characters

  Additional properties are NOT allowed.

  displayName

  Expand all

  array<object>

  <= 50 unique items

  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)))$

  Examples values:
  • "en"

  text

  required

  string

  [ 1 .. 128 ] characters

  Additional properties are NOT allowed.

  assetKind

  string

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

  assetType

  string

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

  globalAssetId

  string

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

  idShort

  string

  [ 1 .. 128 ] characters

  The idShort is unique.

  id

  required

  string

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

  Examples values:
  • "https://example.org/aas/motor"

  specificAssetIds

  Expand all

  array<object>

  <= 50 unique items

  object

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  object [CIRCULAR]

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  supplementalSemanticIds

  Expand all

  array<object>

  <= 50 unique items

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  object [CIRCULAR]

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  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

  Examples values:
  • "manufacturerId"

  value

  required

  string

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

  Examples values:
  • "BOSCH"

  externalSubjectId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  object [CIRCULAR]

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  submodelDescriptors

  Expand all

  array<object>

  <= 50 unique items

  object

  endpoints

  Expand all

  required

  array<object>

  [ 1 .. 10000 ] unique items

  object

  interface

  required

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "AAS-3.0"

  protocolInformation

  Expand all

  required

  object

  href

  required

  string

  [ 1 .. 2048 ] characters

  Examples values:
  • "https://localhost:1234/api/v3.0/aas"
  • "opc.tcp://localhost:4840"
  • "https://localhost:5678"

  endpointProtocol

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "HTTP"

  endpointProtocolVersion

  Expand all

  array<string>

  Items:

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "1.1"

  subprotocol

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "OPC UA Basic SOAP"

  subprotocolBody

  string

  [ 1 .. 2048 ] characters

  Examples values:
  • "ns=2;s=MyAAS"

  subprotocolBodyEncoding

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "application/soap+xml"

  securityAttributes

  Expand all

  array<object>

  <= 100 unique items

  object

  type

  required

  string

  uid: TypeEnum

  Allowed values:
  • "NONE"
  • "RFC_TLSA"
  • "W3C_DID"

  key

  required

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "securityKey"

  value

  required

  string

  [ 1 .. 128 ] characters

  Examples values:
  • "securityValue"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  idShort

  string

  [ 1 .. 128 ] characters

  The idShort is not unique overall. All Submodel idShort in one Shell are unique.

  id

  required

  string

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

  Examples values:
  • "https://admin-shell.io/zvei/nameplate/1/0/Nameplate"

  semanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  object [CIRCULAR]

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  supplementalSemanticId

  Expand all

  array<object>

  <= 50 unique items

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  referredSemanticId

  Expand all

  object

  type

  required

  string

  Allowed values:
  • "ExternalReference"
  • "ModelReference"

  referredSemanticId

  object [CIRCULAR]

  keys

  Expand all

  required

  array<object>

  [ 1 .. 50 ] unique items

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

  Examples values:
  • "M001"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  description

  Expand all

  array<object>

  <= 50 unique items

  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)))$

  Examples values:
  • "en"

  text

  required

  string

  [ 1 .. 1023 ] characters

  Additional properties are NOT allowed.

  displayName

  Expand all

  array<object>

  <= 50 unique items

  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)))$

  Examples values:
  • "en"

  text

  required

  string

  [ 1 .. 128 ] characters

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  groups

  Expand all

  array<object>

  <= 50 unique items

  Shell Groups

  object

  Identification of an Shell Group

  id

  required

  read-only

  integer

  format: int64

  Internal unique id of an entity which will be set by the service. A nil ID value of '0L' is reserved for resolved virtual Aspects or HTTP endpoints.

  Examples values:
  • 5821

  Additional properties are NOT allowed.

  labels

  Expand all

  array<string>

  <= 10 unique items

  Labels of the Shell

  Items:

  string

  createdAt

  string

  format: date-time

  Creation date. The format of parameter is RFC3339 (https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).

  Examples values:
  • "2021-03-05T12:34:56.123Z"

  Additional properties are NOT allowed.

  Headers

  Expand all

  object

  Kafka headers

  schema-name

  required

  string

  The name of the Schema we are using

  Const:"CreateShell:v1"

  correlation-id

  required

  string

  must match: [0-9a-zA-Z\-_:]{1,128}[ 1 .. 128 ] characters

  A unique Id identifying the message. This will be included as-is in the corresponding response message. We recommend using a well established ID format like UUID or Snowflake ID to ensure uniqueness.

  Examples values:
  • "e44d286e-afe3-4d88-b5cd-c32ad9e95965"

  Additional properties are allowed.

  • #Command
  • #Create
  • #Shells

  Examples

  Payload

  {
    "description": [
      {
        "language": "en",
        "text": "string"
      }
    ],
    "displayName": [
      {
        "language": "en",
        "text": "string"
      }
    ],
    "assetKind": "Instance",
    "assetType": "string",
    "globalAssetId": "string",
    "idShort": "string",
    "id": "https://example.org/aas/motor",
    "specificAssetIds": [
      {
        "semanticId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "AnnotatedRelationshipElement",
              "value": "M001"
            }
          ],
          "referredSemanticId": {
            "type": "ExternalReference",
            "referredSemanticId": {},
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "M001"
              }
            ]
          }
        },
        "supplementalSemanticIds": [
          {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "M001"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "referredSemanticId": {},
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "M001"
                }
              ]
            }
          }
        ],
        "name": "manufacturerId",
        "value": "BOSCH",
        "externalSubjectId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "AnnotatedRelationshipElement",
              "value": "M001"
            }
          ],
          "referredSemanticId": {
            "type": "ExternalReference",
            "referredSemanticId": {},
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "M001"
              }
            ]
          }
        }
      }
    ],
    "submodelDescriptors": [
      {
        "endpoints": [
          {
            "interface": "AAS-3.0",
            "protocolInformation": {
              "href": "https://localhost:1234/api/v3.0/aas",
              "endpointProtocol": "HTTP",
              "endpointProtocolVersion": [
                "1.1"
              ],
              "subprotocol": "OPC UA Basic SOAP",
              "subprotocolBody": "ns=2;s=MyAAS",
              "subprotocolBodyEncoding": "application/soap+xml",
              "securityAttributes": [
                {
                  "type": "NONE",
                  "key": "securityKey",
                  "value": "securityValue"
                }
              ]
            }
          }
        ],
        "idShort": "string",
        "id": "https://admin-shell.io/zvei/nameplate/1/0/Nameplate",
        "semanticId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "AnnotatedRelationshipElement",
              "value": "M001"
            }
          ],
          "referredSemanticId": {
            "type": "ExternalReference",
            "referredSemanticId": {},
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "M001"
              }
            ]
          }
        },
        "supplementalSemanticId": [
          {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "M001"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "referredSemanticId": {},
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "M001"
                }
              ]
            }
          }
        ],
        "description": [
          {
            "language": "en",
            "text": "string"
          }
        ],
        "displayName": [
          {
            "language": "en",
            "text": "string"
          }
        ]
      }
    ],
    "groups": [
      {
        "id": 5821
      }
    ],
    "labels": [
      "string"
    ],
    "createdAt": "2021-03-05T12:34:56.123Z"
  }
  

  This example has been generated automatically.

  Headers

  {
    "schema-name": "CreateShell:v1",
    "correlation-id": "e44d286e-afe3-4d88-b5cd-c32ad9e95965"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Successfully created entityentityCreatedV1.message

  • application/json

  Message IDentityCreatedV1.message

  Payload

  Expand all

  object

  Created a single Entity v1

  id

  required

  read-only

  integer

  format: int64

  Internal unique id of an entity which will be set by the service. A nil ID value of '0L' is reserved for resolved virtual Aspects or HTTP endpoints.

  Examples values:
  • 5821

  Additional properties are NOT allowed.

  Headers

  Expand all

  object

  Kafka headers

  schema-name

  required

  string

  The name of the Schema we are using

  Const:"EntityCreated:v1"

  correlation-id

  required

  string

  must match: [0-9a-zA-Z\-_:]{1,128}[ 1 .. 128 ] characters

  A unique Id identifying the message. This will be included as-is in the corresponding response message. We recommend using a well established ID format like UUID or Snowflake ID to ensure uniqueness.

  Examples values:
  • "e44d286e-afe3-4d88-b5cd-c32ad9e95965"

  Additional properties are allowed.

  • #Response
  • #Success

  Examples

  Payload

  {
    "id": 5821
  }
  

  This example has been generated automatically.

  Headers

  {
    "schema-name": "EntityCreated:v1",
    "correlation-id": "e44d286e-afe3-4d88-b5cd-c32ad9e95965"
  }
  

  This example has been generated automatically.

• #1Failed operationerrorResponseV1.message

  • application/json

  Message IDerrorResponseV1.message

  Payload

  Expand all

  object

  There was an error while performing the operation

  error

  Expand all

  required

  object

  message

  required

  string

  non-empty

  The detailed error message for the exception which occurred.

  Examples values:
  • "Validation failed"

  details

  Expand all

  object

  An object with key/value pairs containing additional information about the error.

  Examples values:
  • {"name":"size must be between 1 and 128","description":"size must be between 1 and 512"}

  Additional properties are allowed.

  code

  string

  non-empty

  A machine processable, application internal error code.

  Examples values:
  • 20001

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  Expand all

  object

  Kafka headers

  schema-name

  required

  string

  The name of the Schema we are using

  Const:"ErrorResponse:v1"

  correlation-id

  required

  string

  must match: [0-9a-zA-Z\-_:]{1,128}[ 1 .. 128 ] characters

  A unique Id identifying the message. This will be included as-is in the corresponding response message. We recommend using a well established ID format like UUID or Snowflake ID to ensure uniqueness.

  Examples values:
  • "e44d286e-afe3-4d88-b5cd-c32ad9e95965"

  Additional properties are allowed.

  • #Response
  • #Failure

  Examples

  Payload

  {
    "error": {
      "message": "Validation failed",
      "details": {
        "name": "size must be between 1 and 128",
        "description": "size must be between 1 and 512"
      },
      "code": 20001
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "schema-name": "ErrorResponse:v1",
    "correlation-id": "e44d286e-afe3-4d88-b5cd-c32ad9e95965"
  }
  

  This example has been generated automatically.