Returns a specific Submodel Descriptor

Returns a specific Submodel Descriptor

Path Parameters

• aasIdentifier byte required

  The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)

• submodelIdentifier byte required

  The Submodel’s unique id (UTF8-BASE64-URL-encoded)

Responses

• 200
• 400
• 403
• 404
• 500
• default

---

Requested Submodel Descriptor

application/json

• Schema

---

Schema

• description object[]

  language string

  Possible values: Value must match regular expression ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){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 string

  Possible values: non-empty and <= 1023 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

• displayName object[]

  language string

  Possible values: Value must match regular expression ^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){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 string

  Possible values: non-empty and <= 128 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

• extensions object[]

  Possible values: >= 1

  semanticId

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  referredSemanticId

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  supplementalSemanticIds undefined[]

  Possible values: >= 1

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  referredSemanticId

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  name string

  Possible values: non-empty and <= 128 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  valueType string

  Possible 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

  refersTo undefined[]

  Possible values: >= 1

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

  referredSemanticId

  type string

  Possible values: [ExternalReference, ModelReference]

  keys object[]

  Possible values: >= 1

  type string

  Possible 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 string

  Possible values: non-empty and <= 2000 characters, Value must match regular expression ^([\t\n\r -퟿- ]|\ud800[\udc00-\udfff]|[\ud801-\udbfe][\udc00-\udfff]|\udbff[\udc00-\udfff])*$

Bad Request, e.g. the request parameters of the format of the request body is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Default error handling for unmentioned status codes

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Loading...