Subscription.json 4.86 KB
Newer Older
canterafonsj's avatar
canterafonsj committed
1 2 3 4 5 6
{
  "$schema": "http://json-schema.org/schema#",
  "id": "https://uri.etsi.org/ngsi-ld/schema/Subscription.json",
  "title": "NGSI-LD Subscription",
  "description": "NGSI-LD Subscription",
  "definitions": {
canterafonsj's avatar
canterafonsj committed
7
    "NotificationParams": {
canterafonsj's avatar
canterafonsj committed
8 9
      "type": "object",
      "properties": {
canterafonsj's avatar
canterafonsj committed
10 11 12 13
        "attributes": {
          "type": "array",
          "minItems": 1,
          "items": {
canterafonsj's avatar
canterafonsj committed
14 15 16 17
            "type": "string",
            "minLength": 1
          },
          "uniqueItems": true
canterafonsj's avatar
canterafonsj committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
        },
        "format": {
          "type": "string"
        },
        "endpoint": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Endpoint"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "failed"
          ]
        },
        "timesSent": {
          "type": "number",
          "minimum": 1
        },
        "lastNotification": {
          "type": "string",
          "format": "date-time"
        },
        "lastFailure": {
          "type": "string",
          "format": "date-time"
        },
        "lastSuccess": {
          "type": "string",
          "format": "date-time"
canterafonsj's avatar
canterafonsj committed
47 48
        }
      },
canterafonsj's avatar
canterafonsj committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
      "required": [
        "endpoint"
      ]
    },
    "GeoQuery": {
      "type": "object",
      "required": [
        "geometry",
        "coordinates",
        "georel"
      ],
      "properties": {
        "georel": {
          "oneOf": [
            {
              "type": "string",
              "enumeration": [
                "equals",
                "disjoint",
                "intersects",
                "within",
                "contains",
                "overlaps"
              ]
            },
            {
              "type": "string",
              "pattern": "near;(maxDistance==\\d+)|(minDistance==\\d+)$"
            }
          ]
        },
        "coordinates": {
          "oneOf": [
            {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/position"
            },
            {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/positionArray"
            },
            {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/lineString"
            },
            {
              "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/geometry-schema.json#/definitions/polygon"
            }
          ]
        },
        "geometry": {
          "type": "string",
          "enumeration": [
            "Point",
            "MultiPoint",
            "LineString",
            "MultiLineString",
            "Polygon",
            "MultiPolygon"
          ]
canterafonsj's avatar
canterafonsj committed
106 107
        }
      }
canterafonsj's avatar
canterafonsj committed
108 109 110 111 112 113 114
    }
  },
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uri"
canterafonsj's avatar
canterafonsj committed
115
    },
canterafonsj's avatar
canterafonsj committed
116 117 118 119 120 121 122 123
    "type": {
      "type": "string",
      "const": "Subscription"
    },
    "@context": {
      "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext"
    },
    "entities": {
canterafonsj's avatar
canterafonsj committed
124 125 126 127 128
      "type": "array",
      "items": {
        "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/EntityInfo"
      },
      "minItems": 1
canterafonsj's avatar
canterafonsj committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "description": {
      "type": "string",
      "minLength": 1
    },
    "notification": {
      "$ref": "#/definitions/NotificationParams"
    },
    "watchedAttributes": {
      "type": "array",
      "minItems": 1,
      "items": {
145
        "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name"
canterafonsj's avatar
canterafonsj committed
146
      },
canterafonsj's avatar
canterafonsj committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
      "uniqueItems": true
    },
    "timeInterval": {
      "type": "number",
      "minimum": 0
    },
    "expires": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "expired"
      ]
    },
    "isActive": {
      "type": "boolean"
    },
    "throttling": {
      "type": "number",
      "minimum": 1
    },
    "q": {
      "type": "string"
canterafonsj's avatar
canterafonsj committed
174
    },
canterafonsj's avatar
canterafonsj committed
175 176 177
    "geoQ": {
      "$ref": "#/definitions/GeoQuery"  
    },
canterafonsj's avatar
canterafonsj committed
178 179 180 181
    "csf": {
      "type": "string"
    }
  },
canterafonsj's avatar
canterafonsj committed
182 183 184 185 186 187
  "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"
  },
canterafonsj's avatar
canterafonsj committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
  "allOf": [
    {
      "required": [
        "id",
        "type"
      ]
    },
    {
      "anyOf": [
        {
          "required": [
            "entities"
          ]
        },
        {
          "required": [
            "watchedAttributes"
          ]
        }
      ]
    }
canterafonsj's avatar
canterafonsj committed
209
  ]
canterafonsj's avatar
canterafonsj committed
210
}