openapi.yaml

# OpenAPI version identifier - required for OpenAPI 3.0 domains
openapi: 3.0.3
info:
  title: DotAAS Part 2 | API | Schemas
  description: >- 
    The schemas implementing the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).  
    
    Publisher: Industrial Digital Twin Association (IDTA) 2023
  contact:
    name: Industrial Digital Twin Association (IDTA)
    email: info@idtwin.org
  license: 
    name: CC BY 4.0
    url: https://creativecommons.org/licenses/by/4.0/
  version: V3.0.3
components: 
  parameters:
    AssetAdministrationShellIdentifier:
      name: aasIdentifier
      in: path
      description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
      required: true
      style: simple
      explode: false
      schema:
        type: string
    AssetKind:
      name: assetKind
      in: query
      required: false
      description: The Asset's kind (Instance or Type)
      schema:
        $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/AssetKind"
    AssetIds:
      name: assetIds
      in: query
      description: A list of specific Asset identifiers. Every single value asset identifier is a base64-url-encoded [SpecificAssetId](https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId).
      required: false
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
        example: '?assetIds=eyAibmFtZSI6ICJzb21lLWFzc2V0LWlkIiwgInZhbHVlIjogImh0dHA6Ly9leGFtcGxlLWNvbXBhbnkuY29tL215QXNzZXQiLCAiZXh0ZXJuYWxTdWJqZWN0SWQiOiB7ICJrZXlzIjogWyB7ICJ0eXBlIjogIkdsb2JhbFJlZmVyZW5jZSIsICJ2YWx1ZSI6ICJodHRwOi8vZXhhbXBsZS1jb21wYW55LmNvbS9leGFtcGxlLWNvbXBhbnlzLWFzc2V0LWtleXMiIH0gXSwgInR5cGUiOiAiRXh0ZXJuYWxSZWZlcmVuY2UiIH0gfQ&assetIds=eyAibmFtZSI6ICJzb21lLW90aGVyLWFzc2V0LWlkIiwgInZhbHVlIjogIjEyMzQ1QUJDIiwgImV4dGVybmFsU3ViamVjdElkIjogeyAia2V5cyI6IFsgeyAidHlwZSI6ICJHbG9iYWxSZWZlcmVuY2UiLCAidmFsdWUiOiAiaHR0cDovL215LW93bi1jb21wYW55LmNvbS9rZXlzIiB9IF0sICJ0eXBlIjogIkV4dGVybmFsUmVmZXJlbmNlIiB9IH0'
    AssetType:
      name: assetType
      in: query
      description: The Asset's type (UTF8-BASE64-URL-encoded)
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 2000
        pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
    Cursor:    
      name: cursor
      in: query
      description: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
      required: false
      schema:
        type: string
    Extent:
      name: extent
      in: query
      description: Determines to which extent the resource is being serialized
      required: false
      schema:
        type: string
        default: withoutBlobValue
        enum:
          - withBlobValue
          - withoutBlobValue
    HandleId:
      name: handleId
      in: path
      description:  The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded)
      required: true
      style: simple
      explode: false
      schema:
        type: string
    IdShort:
      name: idShort
      in: query
      description: The Asset Administration Shell’s IdShort
      required: false
      style: form
      explode: true
      schema:
        type: string
    IdShortPath:
      name: idShortPath
      in: path
      description: IdShort path to the submodel element (dot-separated)
      required: true
      style: simple
      explode: false
      schema:
        type: string
    Level:
      name: level
      in: query
      description: Determines the structural depth of the respective resource content
      required: false
      schema:
        type: string
        default: deep
        enum:
          - deep
          - core
    Limit:      
      name: limit
      in: query
      description: The maximum number of elements in the response array      
      required: false
      schema:
        type: integer
        minimum: 1
    SemanticId:
      name: semanticId
      in: query
      description: The value of the semantic id reference (BASE64-URL-encoded)
      schema:
        type: string
        maxLength: 3072
        minLength: 1
    SubmodelIdentifier:
      name: submodelIdentifier
      in: path
      description: The Submodel’s unique id (UTF8-BASE64-URL-encoded)
      required: true
      style: simple
      explode: false
      schema:
        type: string
        
  schemas: 
    AnnotatedRelationshipElementMetadata: 
      $ref: "#/components/schemas/SubmodelElementAttributes"
    AnnotatedRelationshipElementValue: 
      properties: 
        first: 
          $ref: "#/components/schemas/ReferenceValue"
        second: 
          $ref: "#/components/schemas/ReferenceValue"
        annotations:
          type: array
          items:
            $ref: "#/components/schemas/ValueOnly"
      required: 
        - first
        - second
      type: object
    AssetAdministrationShellDescriptor: 
      allOf: 
        - $ref: "#/components/schemas/Descriptor"
        - properties: 
            administration: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/AdministrativeInformation"
            assetKind:
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/AssetKind"
            assetType:
              type: string
              minLength: 1
              maxLength: 2000
              pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
            endpoints: 
              items: 
                $ref: "#/components/schemas/Endpoint"
              minItems: 1
              type: array
            globalAssetId: 
              type: string
              minLength: 1
              maxLength: 2000
              pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
            idShort: 
              type: string
              maxLength: 128
            id: 
              type: string
              maxLength: 2000
              minLength: 1
              pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
            specificAssetIds: 
              type: array
              items:
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId"
            submodelDescriptors: 
              items: 
                $ref: "#/components/schemas/SubmodelDescriptor"
              type: array
      required: 
        - id
      type: object
      example: '{ "id": "https://example.org/aas/motor", "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
    AssetAdministrationShellMetadata: 
      allOf: 
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Identifiable"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/HasDataSpecification"
        - properties: 
            derivedFrom: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
    BaseOperationResult:
      allOf:
        - $ref: "#/components/schemas/Result"
        - properties:
            executionState: 
              $ref: "#/components/schemas/ExecutionState"
            success:
              type: boolean
    BasicEventElementMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
        - properties: 
            direction: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Direction"
            state: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/StateOfEvent"
            messageTopic: 
              type: string
              maxLength: 255
            messageBroker: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
            lastUpdate: 
              type: string
            minInterval: 
              type: string
            maxInterval: 
              type: string
    BasicEventElementValue:
      properties: 
        observed: 
          $ref: "#/components/schemas/ReferenceValue"
      required:
        - observed
      type: object
    BlobMetadata: 
      $ref: "#/components/schemas/SubmodelElementAttributes"
    BlobValue: 
      properties: 
        contentType: 
          type: string
          minLength: 1
          maxLength: 100
        value: 
          type: string
      required: 
        - contentType
      type: object
    BooleanValue: 
      type: boolean
    CapabilityMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    Descriptor: 
      example: '{ "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
      properties: 
        description: 
          type: array
          items:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/LangStringTextType"
        displayName: 
          type: array
          items:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/LangStringNameType"
        extensions:
          type: array
          items:
            "$ref": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Extension"
          minItems: 1
      type: object
    Endpoint: 
      properties: 
        interface: 
          type: string
          maxLength: 128
        protocolInformation: 
          $ref: "#/components/schemas/ProtocolInformation"
      required: 
        - protocolInformation
        - interface
      type: object
    EntityMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    EntityValue: 
      properties: 
        entityType: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/EntityType"
        globalAssetId: 
          type: string
          minLength: 1
          maxLength: 2000
          pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
        specificAssetIds:
          type: array
          items: 
            $ref: "#/components/schemas/SpecificAssetIdValue"
        statements:
          items: 
            $ref: "#/components/schemas/ValueOnly"
          type: array
      required:
        - entityType
      type: object
    ExecutionState:
      enum: 
        - Initiated
        - Running
        - Completed
        - Canceled
        - Failed
        - Timeout
      type: string
    FileValue: 
      properties: 
        contentType: 
          type: string
          minLength: 1
          maxLength: 100
        value: 
          type: string
          minLength: 1
          maxLength: 2000
      required: 
        - contentType
        - value
      type: object
    FileMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    GetAssetAdministrationShellDescriptorsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/AssetAdministrationShellDescriptor"
    GetAssetAdministrationShellsMetadataResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/AssetAdministrationShellMetadata"
    GetAssetAdministrationShellsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/AssetAdministrationShell"
    GetConceptDescriptionsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/ConceptDescription"
    GetPackageDescriptionsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/PackageDescription" 
    GetPathItemsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/PathItem"
    GetReferencesResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
    GetSubmodelDescriptorsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/SubmodelDescriptor"
    GetSubmodelElementsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SubmodelElement"
    GetSubmodelElementsMetadataResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/SubmodelElementMetadata"  
    GetSubmodelElementsValueResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/SubmodelElementValue"  
    GetSubmodelsMetadataResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/SubmodelMetadata"
    GetSubmodelsResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Submodel"
    GetSubmodelsValueResult:
      allOf:
        - $ref: '#/components/schemas/PagedResult'
        - type: object
          properties:
            result:
              type: array
              items: 
                $ref: "#/components/schemas/SubmodelValue"
    Message:
      properties: 
        code: 
          type: string
          maxLength: 32
          minLength: 1
        correlationId:
          type: string
          maxLength: 128
          minLength: 1
        messageType: 
          enum: 
            - Undefined
            - Info
            - Warning
            - Error
            - Exception
          type: string
        text: 
          type: string
        timestamp: 
          type: string
          pattern: "^-?(([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)$"
      type: object
    MultiLanguagePropertyMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    MultiLanguagePropertyValue: 
      type: object
      description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
    NumberValue: 
      type: number
    OperationHandle: 
      properties: 
        handleId: 
          type: string
          maxLength: 128
      type: object
    OperationMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    OperationRequest: 
      properties: 
        inoutputArguments: 
          items: 
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/OperationVariable"
          type: array
        inputArguments: 
          items: 
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/OperationVariable"
          type: array
        clientTimeoutDuration: 
          type: string
          pattern: "^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$"
      type: object
    OperationRequestValueOnly: 
      properties: 
        inoutputArguments: 
          $ref: "#/components/schemas/ValueOnly"
        inputArguments: 
          $ref: "#/components/schemas/ValueOnly"
        clientTimeoutDuration: 
          type: string
          pattern: "^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$"
      type: object
      required: 
      - clientTimeoutDuration
    OperationResult: 
      allOf:
      - $ref: '#/components/schemas/BaseOperationResult'
      - properties: 
          inoutputArguments: 
            items: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/OperationVariable"
            type: array
          outputArguments: 
            items: 
              $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/OperationVariable"
            type: array
      type: object
    OperationResultValueOnly: 
      allOf:
      - $ref: '#/components/schemas/BaseOperationResult'
      - properties: 
          inoutputArguments: 
            $ref: "#/components/schemas/ValueOnly"
          outputArguments: 
            $ref: "#/components/schemas/ValueOnly"
      type: object
    PagedResult:
      type: object
      properties:
        paging_metadata:
          type: object
          properties:
            cursor:
              type: string
              example: wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#
    PackageDescription: 
      properties: 
        aasIds: 
          items: 
            type: string
            pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
            maxLength: 2000
          type: array
        packageId: 
          type: string
          maxLength: 128
      type: object
    PathItem:
      type: string
      pattern: "^([A-Za-z][A-Za-z0-9_]+)((\\.[A-Za-z][A-Za-z0-9_]+)|(\\[(0|[1-9][0-9]*)\\])){0,}$"
    PropertyMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
      properties: 
        valueType: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/DataTypeDefXsd"
    PropertyValue: 
      oneOf: 
        - $ref: "#/components/schemas/StringValue"
        - $ref: "#/components/schemas/NumberValue"
        - $ref: "#/components/schemas/BooleanValue"
    ProtocolInformation: 
      properties:
        href: 
          type: string
          maxLength: 2048
        endpointProtocol: 
          type: string
          maxLength: 128
        endpointProtocolVersion: 
          type: array
          items:  
            type: string
            maxLength: 128
        subprotocol: 
          type: string
          maxLength: 128
        subprotocolBody: 
          type: string
          maxLength: 128
        subprotocolBodyEncoding: 
          type: string
          maxLength: 128
        securityAttributes:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - "NONE"
                - "RFC_TLSA"
                - "W3C_DID"
              key:
                type: string
              value:
                type: string
            required:
            - type
            - key
            - value
          minItems: 1
      required: 
        - href
      type: object
    RangeMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
      properties: 
        valueType: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/DataTypeDefXsd"
    RangeValue: 
      properties: 
        max: 
          $ref: "#/components/schemas/RangeValueType"
        min: 
          $ref: "#/components/schemas/RangeValueType"
      type: object
    RangeValueType:
      oneOf:
        - $ref: "#/components/schemas/StringValue"
        - $ref: "#/components/schemas/NumberValue"
        - $ref: "#/components/schemas/BooleanValue"
    ReferenceElementMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    ReferenceElementValue: 
      $ref: "#/components/schemas/ReferenceValue"
    ReferenceValue:
      type: object
      properties:
        type: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/ReferenceTypes"
        keys:
          type: array
          items:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Key"
    RelationshipElementMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    RelationshipElementValue: 
      properties: 
        first: 
          $ref: "#/components/schemas/ReferenceValue"
        second: 
          $ref: "#/components/schemas/ReferenceValue"
      required: 
        - first
        - second
      type: object
    Result: 
      properties: 
        messages: 
          items: 
            $ref: "#/components/schemas/Message"
          type: array
      type: object
    ServiceDescription: 
      description: The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
      example: >-
        {
          "profiles": [
            "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002",
            "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002"
          ]
        }
      properties: 
        profiles:
          type: array
          minItems: 1
          items:
            type: string
            example:
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003"
              - "https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003"
              - "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004"
              - "https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001"
      type: object
    SpecificAssetIdValue:
      type: object
      description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
    StringValue: 
      type: string
    SubmodelDescriptor: 
      allOf: 
        - $ref: "#/components/schemas/Descriptor"
      properties: 
        administration: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/AdministrativeInformation"
        endpoints: 
          items: 
            $ref: "#/components/schemas/Endpoint"
          minItems: 1
          type: array
        idShort: 
          type: string
          maxLength: 128
        id: 
          type: string
          minLength: 1
          maxLength: 2000
          pattern: "^([\\x09\\x0a\\x0d\\x20-\\ud7ff\\ue000-\\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
        semanticId: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
        supplementalSemanticId:
          type: array
          items:
            $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
          minItems: 1
      required: 
        - id
        - endpoints
      type: object
      example: '{ "id": "https://admin-shell.io/zvei/nameplate/1/0/Nameplate", "endpoints": [ { "href": { "href": "https://localhost:1234/api/v3.0/submodel", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
    SubmodelElementAttributes: 
      allOf: 
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Referable"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasDataSpecification"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasSemantics"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Qualifiable"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasKind"
    SubmodelElementListMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
      properties: 
        orderRelevant:
          type: boolean
        semanticIdListElement: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Reference"
        typeValueListElement: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/ModelType"
        valueTypeListElement: 
          $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/DataTypeDefXsd"
    SubmodelElementListValue:
      type: array
      items:
        $ref: "#/components/schemas/SubmodelElementValue"
    SubmodelElementCollectionMetadata: 
      allOf: 
        - $ref: "#/components/schemas/SubmodelElementAttributes"
    SubmodelElementCollectionValue: 
      type: object
      description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
    SubmodelElementMetadata: 
      oneOf: 
        - $ref: "#/components/schemas/BlobMetadata"
        - $ref: "#/components/schemas/FileMetadata"
        - $ref: "#/components/schemas/CapabilityMetadata"
        - $ref: "#/components/schemas/EntityMetadata"
        - $ref: "#/components/schemas/BasicEventElementMetadata"
        - $ref: "#/components/schemas/MultiLanguagePropertyMetadata"
        - $ref: "#/components/schemas/OperationMetadata"
        - $ref: "#/components/schemas/PropertyMetadata"
        - $ref: "#/components/schemas/RangeMetadata"
        - $ref: "#/components/schemas/ReferenceElementMetadata"
        - $ref: "#/components/schemas/AnnotatedRelationshipElementMetadata"
        - $ref: "#/components/schemas/RelationshipElementMetadata"
        - $ref: "#/components/schemas/SubmodelElementListMetadata"
        - $ref: "#/components/schemas/SubmodelElementCollectionMetadata"
    SubmodelElementValue: 
      oneOf: 
        - $ref: "#/components/schemas/BasicEventElementValue"
        - $ref: "#/components/schemas/PropertyValue"
        - $ref: "#/components/schemas/MultiLanguagePropertyValue"
        - $ref: "#/components/schemas/BlobValue"
        - $ref: "#/components/schemas/FileValue"
        - $ref: "#/components/schemas/RangeValue"
        - $ref: "#/components/schemas/ReferenceElementValue"
        - $ref: "#/components/schemas/RelationshipElementValue"
        - $ref: "#/components/schemas/AnnotatedRelationshipElementValue"
        - $ref: "#/components/schemas/EntityValue"
        - $ref: "#/components/schemas/SubmodelElementCollectionValue"
        - $ref: "#/components/schemas/SubmodelElementListValue"
    SubmodelMetadata: 
      allOf: 
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Identifiable"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/HasDataSpecification"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/Qualifiable"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/HasSemantics"
        - $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/HasKind"
    SubmodelValue:
      $ref: "#/components/schemas/ValueOnly"
    ValueOnly: 
      description: "The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'."
      type: object
    

  responses:
    'accepted':
      description: The server has accepted the request.
      headers:
        Location: 
          description: The URL where the client can find more information about the request.
          schema:
            type: string
    'no-content':
      description: No Content, request was successful but no content is returned
      content:
        application/json:
          schema:
            $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AssetAdministrationShell'
    'found':
      description: The target resource is available but at a different location.
      headers:
        Location: 
          description: The URL where the client can find the target resource.
          schema:
            type: string
    'bad-request':
      description: Bad Request, e.g. the request parameters of the format of the request body is wrong.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'unauthorized':
      description: Unauthorized, e.g. the server refused the authorization attempt.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'forbidden':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'not-found':
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'method-not-allowed':
      description: Method Not Allowed, the server does not offer this method for the client
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'conflict':
      description: Conflict, a resource which shall be created exists already. Might be thrown if a Submodel or SubmodelElement with the same ShortId is contained in a POST request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'internal-server-error':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'not-implemented':
      description: Method Not Implemented by the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'
    'default':
      description: Default error handling for unmentioned status codes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Result'