WaterNetworkManagement-schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://smart-data-models.github.io/dataModel.WaterDistributionManagementEPANET/WaterNetworkManagement-schema.json",
  "title": "Smart Data Models - Water Network Management base schema",
  "description": "Common NGSI-LD definitions for Water Network Management data models",
  "type": "object",
  "definitions": {
    "demandCategory": {
      "type": "object",
      "description": "Property. Model:'https://schema.org/Text'. Allows base demands and time patterns to be assigned to other categories of users",
      "properties": {
        "value": {
          "type": "number",
          "description": "Property. Value of the demand category"
        },
        "baseDemand": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text. Baseline or average demand for the category. A sub-property of the Property demandCategory"
        },
        "demandPattern": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ],
          "description": "Relationship. A relationship to the pattern of the 'demandCategory' property"
        }
      }
    },
    "sourceCategory": {
      "type": "object",
      "description": "Property. Model:'https://schema.org/Text'. Description of the quality of source flow entering the network at a specific node",
      "properties": {
          "value": {
            "type": "string",
             "description": "Property. Value of the source category"
          },
        "sourceType": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. A sub-property of the Property sourceCategory",
          "enum": [
            "CONCEN",
            "MASS",
            "FLOWPACED",
            "SETPOINT"
          ]
        },
        "sourceQuality": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Units: 'mg/L'. Baseline or average concentration (or mass flow rate) of source. A sub-property of the Property 'sourceCategory'. All units are accepted in [CEFACT](https://www.unece.org/cefact.html) code"
        },
        "sourcePattern": {
          "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 256,
          "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
          "description": "Property. Identifier format of any NGSI entity"
        },
        {
          "type": "string",
          "format": "uri",
          "description": "Property. Identifier format of any NGSI entity"
        }
      ],
          "description": "Relationship. A relationship to the pattern pf the sourceCategory property"
        }
      }
    },
    "tag": {
      "type": "string",
      "description": "Property. Model:'https://schema.org/Text'. An optional text string used to assign the pipe to a category, perhaps one based on age or material"
    },
    "status": {
      "type": "string",
      "enum": [
        "OPEN",
        "CLOSED",
        "CV"
      ],
      "description": "Property. Model:'https://schema.org/Text'. The dynamic state of the node. Enum:'OPEN, CLOSED, CV'"
    },
    "initialStatus": {
      "type": "string",
      "enum": [
        "OPEN",
        "CLOSED",
        "CV"
      ],
      "description": "Property. Model:'https://schema.org/Text'. The link status at the start of the simulation. Enum:'OPEN, CLOSED, CV'"
    },
    "valveType": {
      "type": "string",
      "description": "Property. Type of valve according to valve categories. Enum:'FCV, GPV, PBV, PRV, PSV, TCV'",
      "enum": [
        "FCV",
        "GPV",
        "PBV",
        "PRV",
        "PSV",
        "TCV"
      ]
    },
    "valveCurve": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 256,
          "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
          "description": "Property. Identifier format of any NGSI entity"
        },
        {
          "type": "string",
          "format": "uri",
          "description": "Property. Identifier format of any NGSI entity"
        }
      ],
      "description": "Relationship. Reference to the Curve where the valve is located"
    },
    "flow": {
      "type": "object",
      "description": "Property. Rate of flow from `startsAt` node to `endsAt` node, measured by a device at the link (pipe, valve or pump)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Value of the flow"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "velocity": {
      "type": "object",
      "description": "Property. Observed velocity in the link (pipe, valve or pump)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Value of the velocity"
        },
        "observedBy": {
          "type": "string",
          "format": "uri",
           "description": "Property. Where the velocity has been observed"
        }
      }
    },
    "quality": {
      "type": "object",
      "description": "Property. Observed quality in the network component",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the quality"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "initialQuality": {
      "type": "object",
      "description": "Property. Initial quality in the network component",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the initial quality"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "energyUse": {
      "type": "object",
      "description": "Property. Observed energy use by the element of the network",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the use of Energy"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "pressure": {
      "type": "object",
      "description": "Property. Observed pressure at the node (junction, tank or reservoir)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the pressure"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "supply": {
      "type": "object",
      "description": "Property. Observed supply at the node (junction, tank or reservoir)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the supply"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "head": {
      "type": "object",
      "description": "Property. Observed head at the node (junction, tank or reservoir)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Value of the head"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "sourceMassInflow": {
      "type": "object",
      "description": "Property. Observed source mass inflow at the node (junction, tank or reservoir)",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the source mass at the inflow"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    },
    "level": {
      "type": "object",
      "description": "Property. Observed level in the element of the network",
      "properties": {
        "value": {
          "type": "number",
           "description": "Property. Numerical value of the level"
        },
        "observedBy": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
              "description": "Property. Identifier format of any NGSI entity"
            },
            {
              "type": "string",
              "format": "uri",
              "description": "Property. Identifier format of any NGSI entity"
            }
          ]
        }
      }
    }
  }
}