Subscription.json 4.47 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
14
15
16
17
18
19
        "type": "object",
        "required": [
          "endpoint"
        ],
        "properties": {
          "attributes": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string"
canterafonsj's avatar
canterafonsj committed
20
            }
canterafonsj's avatar
canterafonsj committed
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
47
48
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
          },
          "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"
          }
        }
      },
      "EntityInfo": {},
      "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": [
              {
84
85
86
87
88
89
90
91
92
                "$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"
              },
              {
canterafonsj's avatar
canterafonsj committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
                "$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
108
109
110
        }
      }
    },
canterafonsj's avatar
canterafonsj committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "format": "uri"
      },
      "type": {
        "type": "string",
        "const": "Subscription"
      },
      "@context": {
        "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext"
      },
      "name": {
        "type": "string",
        "minLength": 1
      },
      "description": {
        "type": "string",
        "minLength": 1
      },
      "entities": {
        "$ref": "#/definitions/EntityInfo"
      },
      "watchedAttributes": {
        "type": "array",
        "minItems": 1,
        "items": {
          "type": "string"
        },
        "uniqueItems": true
      },
      "timeInterval": {
        "type": "number",
        "minimum": 0
      },
      "geoQ": {
        "$ref": "#/definitions/GeoQuery"
      },
      "notification": {
        "$ref": "#/definitions/NotificationParams"
      },
      "expires": {
        "type": "string",
        "format": "date-time"
      },
      "status": {
        "type": "string",
        "enum": [
          "active",
          "paused",
          "expired"
        ]
      },
      "isActive": {
        "type": "boolean"
      },
      "throttling": {
        "type": "number",
        "minimum": 1
      },
      "q": {
canterafonsj's avatar
canterafonsj committed
173
174
        "type": "string"
      },
canterafonsj's avatar
canterafonsj committed
175
176
177
      "csf": {
        "type": "string"
      }
canterafonsj's avatar
canterafonsj committed
178
    },
canterafonsj's avatar
canterafonsj committed
179
180
181
182
183
    "required": [
      "id",
      "type"
    ]
  }
canterafonsj's avatar
canterafonsj committed
184
}