WaterNetworkManagement-schema.json

{
    "$schema": "http://json-schema.org/schema#",
    "$id": "https://smart-data-models.github.io/dataModel.WaterNetworkManagement/WaterNetworkManagement-schema.json",
    "title": "FIWARE - 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": {
                "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": {
                    "type": "string",
                    "format": "uri",
                    "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": {
                "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": {
                    "type": "string",
                    "format": "uri",
                    "description": "Relationship. A relationship to the pattern pf the sourceCategory property"
                }
            },
            "required": [
                "sourceType",
                "sourceQuality",
                "sourcePattern"
            ]
        },
        "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"
        },
        "description": {
            "type": "string",
            "description": "Property. Model:'https://schema.org/Text'. An optional text that describes other significant information about the junction"
        },
        "status": {
            "type": "string",
            "enum": [
                "OPEN",
                "CLOSED",
                "CV"
            ],
            "description": "Property. Model:'https://schema.org/Text'. The dynamic state of the node"
        },
        "initialStatus": {
            "type": "string",
            "enum": [
                "OPEN",
                "CLOSED",
                "CV"
            ],
            "description": "Property. Model:'https://schema.org/Text'. The node status at the start of the simulation."
        }
    }
}