{
  "$schema": "http://json-schema.org/schema#",
  "$schemaVersion": "0.0.1",
  "modelTags": "Corosect",
  "$id": "https://smart-data-models.github.io/dataModel.AAS/I4Submodel/schema.json",
  "title": "Smart Data Models - RAMI4.0 Asset Administration Shell -AAS- Generic Submodel schema",
  "description": "Based on IDTA-01001-3-0, describes a generic submodel component of the RAMI4.0 Asset Administration Shell",
  "type": "object",
  "derivedFrom": "https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2023/04/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf",
  "license": "",
  "allOf": [
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
    },
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "I4Submodel"
          ],
          "description": "Property. It has to be RAMI4.0 I4Submodel NGSI Entity type to represent a RAMI4.0 AAS Digital Twin Submodel component"
        },
        "refI4AssetId": {
          "type": "string",
          "description": "Relationship. References the root Asset which this Submodel belongs to"
        },
        "refI4AASId": {
          "type": "string",
          "description": "Relationship. References the root Asset Administration Shell which this Submodel belongs to"
        },
        "hasDataSpecification": {
          "type": "array",
          "description": "Property. Data specification defines the additional attributes a Submodel may have. RAMI4.0 specification",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "Property. Link, url or description of the specified data"
              }
            }
          }
        },
        "qualifiers": {
          "type": "array",
          "description": "Property. Qualifiers are used if the semantics of the element is the same independent of its qualifiers. It is only the quality or the meaning of the value for the element that differs",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "Property. Link, url or description of the qualifier"
              }
            }
          }
        },
        "submodelElements": {
          "type": "array",
          "description": "Property. Data element which includes the list of Elements -Operations or Commands AND Properties- I4SubmodelElementOperation for RAMI commands / I4SubmodelElementProperty for RAMI Properties",
          "items": {
            "type": "object",
            "description": "Property. Link to the RAMI40 element -I4SubmodelElementOperation or I4SubmodelElementProperty- that maps the Command/Property of the RAMI Submodel",
            "properties": {
              "refI4SubmodelElement": {
                "type": "string",
                "description": "Property. Link to the NGSI entity -I4SubmodelElementOperation or I4SubmodelElementProperty- that maps the Command/Property of the Submodel"
              },
              "idShort": {
                "type": "string",
                "description": "Property. short id is the (short) name of the Submodel within RAMI40 environment"
              },
              "category": {
                "type": "string",
                "description": "Property. The category is a value that gives further meta information w.r.t. to the class of the element"
              },
              "modelType": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Property. Property of the item. Name of the model type"
                  }
                }
              }
            }
          }
        },
        "identification": {
          "type": "object",
          "description": "Property. Identification of the Submodel within its AAS. RAMI4.0 environment",
          "properties": {
            "idType": {
              "type": "string",
              "description": "Property. Type of the Identifier, eg.IRI or IRDI"
            },
            "id": {
              "type": "string",
              "format": "uri",
              "description": "Property. Identity information that unambiguously distinguishes one Submodel from another one -NGSI Id-. RAMI4.0 environment "
            }
          }
        },
        "administration": {
          "type": "object",
          "description": "Property. AAS Submodel administration information",
          "properties": {
            "version": {
              "type": "string",
              "description": "Property. AAS Version number is the number in line with release of specification"
            },
            "revision": {
              "type": "string",
              "description": "Property. AAS Revision number is the number in line with release of specification"
            }
          }
        },
        "idShort": {
          "type": "string",
          "description": "Property. short id is the (short) name of the Submodel within RAMI40 environment"
        },
        "category": {
          "type": "string",
          "description": "Property. The category is a value that gives further meta information w.r.t. to the class of the element"
        },
        "modelType": {
          "type": "object",
          "description": "Property. For the distinction of 'type' and 'instance', the term 'kind' is used.",
          "properties": {
            "name": {
              "type": "string",
              "description": "Property. Property of the item. Usually Submodel is set for this type."
            }
          }
        },
        "descriptions": {
          "type": "array",
          "description": "Property. For adding detailed knowledge about the AAS in different languages",
          "items": {
            "type": "object",
            "properties": {
              "language": {
                "type": "string",
                "description": "Property. Substring identifying the language. Acronym according to ISO 639-1"
              },
              "text": {
                "type": "string",
                "description": "Property. The Description text is filled here"
              }
            }
          }
        },
        "semanticId": {
          "type": "object",
          "description": "Property. It refer to an external information source, which explains the formulation of the submodel",
          "properties": {
            "keys": {
              "type": "array",
              "description": "Property. Keys for the Semantic ID",
              "items": {
                "type": "string",
                "description": "Property. Every Semantic ID element"
              }
            }
          }
        },
        "kind": {
          "type": "string",
          "description": "Property. For the distinction of 'type' and 'instance', the term 'kind' is used"
        }
      }
    }
  ],
  "required": [
    "id",
    "type"
  ]
}