Entity.json

{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json",
  "title": "NGSI-LD Entity",
  "description": "NGSI-LD Entity",
  "definitions": {
    "EntityType": {
      "type": "string",
      "pattern": "^(\\d|[a-zA-Z]|_)+$",
      "minLength": 1,
      "description": "NGSI Entity type"
    },
    "datasetId": {
      "type": "string",
      "format": "uri"
    },
    "instanceId": {
      "type": "string",
      "format": "uri"
    },
    "Property": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "Property"
        },
        "value": {
          "type": ["string","number","boolean","array","object"]
        },
        "observedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"
        },
        "createdAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"
        },
        "modifiedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"
        },
        "datasetId": {
          "$ref": "#/definitions/datasetId"
        },
        "instanceId": {
          "$ref": "#/definitions/instanceId"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/Property"
          },
          {
            "$ref": "#/definitions/Relationship"
          }
        ]
      }
    },
    "Relationship": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "Relationship"
        },
        "object": {
          "type": "string",
          "format": "uri"
        },
        "observedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"
        },
        "createdAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"
        },
        "modifiedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"
        },
        "datasetId": {
          "$ref": "#/definitions/datasetId"
        },
        "instanceId": {
          "$ref": "#/definitions/instanceId"
        }
      },
      "required": [
        "type",
        "object"
      ],
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/Property"
          },
          {
            "$ref": "#/definitions/Relationship"
          }
        ]
      }
    },
    "GeoProperty": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "GeoProperty"
        },
        "value": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#"
        },
        "observedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"
        },
        "createdAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"
        },
        "modifiedAt": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"
        },
        "datasetId": {
          "$ref": "#/definitions/datasetId"
        },
        "instanceId": {
          "$ref": "#/definitions/instanceId"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/Property"
          },
          {
            "$ref": "#/definitions/Relationship"
          }
        ]
      }
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uri"
    },
    "type": {
      "$ref": "#/definitions/EntityType"
    },
    "@context": {
      "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext"
    },
    "location": {
      "$ref": "#/definitions/GeoProperty"
    },
    "observationSpace": {
      "$ref": "#/definitions/GeoProperty"
    },
    "operationSpace": {
      "$ref": "#/definitions/GeoProperty"
    },
    "createdAt": {
      "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"
    },
    "modifiedAt": {
      "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"
    }
  },
  "required": [
    "id",
    "type"
  ],
  "additionalProperties": {
    "anyOf": [
      {
        "$ref": "#/definitions/Property"
      },
      {
        "$ref": "#/definitions/Relationship"
      },
      {
        "$ref": "#/definitions/GeoProperty"
      }
    ]
  },
  "propertyNames": {
    "type": "string",
    "pattern": "^((\\d|[a-zA-Z]|_)+(#\\d+)?)$"
  }
}