forked from telefonicaid/fiware-sth-comet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
396 lines (336 loc) · 19 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
FORMAT: 1A
HOST: http://localhost:8666
# Short Time Historic (STH) (aka. Comet)
[The Short Time Historic (STH, aka. Comet)](https://github.com/telefonicaid/fiware-sth-comet) is a component of the
[FIWARE](https://www.fiware.org/) ecosystem in charge of providing aggregated time series information about the
evolution in time of entity attribute values registered using the
[Orion Context Broker](http://catalogue.fiware.org/enablers/publishsubscribe-context-broker-orion-context-broker),
an implementation of the publish/subscribe context management system exposing NGSI9 and
[NGSI10](https://openmobilealliance.org/release/NGSI/V1_0-20120529-A/OMA-TS-NGSI_Context_Management-V1_0-20120529-A.pdf)
interfaces.
# Group Raw data consumption
The raw data stored in the STH can be consumed in the following ways:
## Filtering by offset and limit [/STH/v2/entities/{entityId}/attrs/{attrName}?type={entityType}&hLimit=3&hOffset=0&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the raw data stored by the STH from certain date onwards (or the origin of time if no starting date is provided) applying certain offset and a limit to the number of entries to be retrieved. Makes it possible to paginate over the stored raw data.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ hLimit (required, number) - Maximum number of raw data entries to retrieve.
+ hOffset (required, number) - Offset to be applied to the raw data to be retrieved.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get raw data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"type": "StructuredValue",
"values": [
{
"recvTime": "2014-02-14T13:43:33.306Z",
"attrValue": "21.28"
},
{
"recvTime": "2014-02-14T13:43:34.636Z",
"attrValue": "23.42"
},
{
"recvTime": "2014-02-14T13:43:35.424Z",
"attrValue": "22.12"
}
]
}
## Filtering by number of last entries [/STH/v2/entities/{entityId}/attrs/{attrName}?entityType={entityType}&lastN=5&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the raw data stored by the STH since certain date backwards (or the current time if no final date is provided) limiting the number of results to be retrieved.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ lastN (required, number) - Number of raw data entries to retrieve since the final date backwards.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get raw data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"type": "StructuredValue",
"values": [
{
"recvTime": "2014-02-14T13:43:33.306Z",
"attrValue": "21.28"
},
{
"recvTime": "2014-02-14T13:43:34.636Z",
"attrValue": "23.42"
},
{
"recvTime": "2014-02-14T13:43:35.424Z",
"attrValue": "22.12"
}
]
}
# Group Aggregated data consumption
The aggregated data stored by the STH can be consumed in the following ways:
## Filtering by aggregation method and resolution [/STH/v2/entities/{entityId}/attrs/{attrName}?type={entityType}&aggrMethod=sum&aggrPeriod=second&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the aggregated data stored by the STH for certain aggregation method and using certain resolution. Combining the information provided by these aggregated methods with the number of samples, it is possible to calculate probabilistic values such as the average value, the variance as well as the standard deviation.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ aggrMethod (required, number) - The aggregation method. In case of numeric attribute values, the STH supports the following aggregation methods: *max* - maximum value, *min* - minimum value, *sum* - sum of all the samples, and *sum2* - sum of the square value of all the samples. On the other hand and in case of textual attribute values, the STH supports the *occur* aggregation method to count the occurrences of each string value.
+ aggrPeriod (required, number) - The aggregation period or resolution of the aggregated data to be retrieved.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get aggregated data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"type": "StructuredValue",
"values": [
{
"_id": {
"origin": "2015-02-18T02:46:00.000Z",
"resolution": "second"
},
"points": [
{
"offset": 13,
"samples": 1,
"sum": 34.59
}
]
}
]
}
+ Response 200 (application/json)
+ body
{
"type": "StructuredValue",
"values": [
{
"_id": {
"origin": "2015-02-18T02:46:00.000Z",
"resolution": "second"
},
"points": [
{
"offset": 35,
"samples": 34,
"occur": {
"string01": 7,
"string02": 4,
"string03": 5,
"string04": 6,
"string05": 12
}
}
]
}
]
}
# Group Deprecated operations
Deprecated operations using the old V1 API. You are recommeneded not using them, as they will be removed in a next version of STH.
## Filtering by offset and limit using V1 API (deprecated) [/STH/v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}?hLimit=3&hOffset=0&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the raw data stored by the STH from certain date onwards (or the origin of time if no starting date is provided) applying certain offset and a limit to the number of entries to be retrieved. Makes it possible to paginate over the stored raw data.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ hLimit (required, number) - Maximum number of raw data entries to retrieve.
+ hOffset (required, number) - Offset to be applied to the raw data to be retrieved.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get raw data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"contextResponses": [
{
"contextElement": {
"attributes": [
{
"name": "attrName",
"values": [
{
"recvTime": "2014-02-14T13:43:33.306Z",
"attrValue": "21.28"
},
{
"recvTime": "2014-02-14T13:43:34.636Z",
"attrValue": "23.42"
},
{
"recvTime": "2014-02-14T13:43:35.424Z",
"attrValue": "22.12"
}
]
}
],
"id": "entityId",
"isPattern": false
},
"statusCode": {
"code": "200",
"reasonPhrase": "OK"
}
}
]
}
## Filtering by number of last entries using V1 API (deprecated) [/STH/v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}?lastN=5&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the raw data stored by the STH since certain date backwards (or the current time if no final date is provided) limiting the number of results to be retrieved.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ lastN (required, number) - Number of raw data entries to retrieve since the final date backwards.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get raw data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"contextResponses": [
{
"contextElement": {
"attributes": [
{
"name": "attrName",
"values": [
{
"recvTime": "2014-02-14T13:43:33.306Z",
"attrValue": "21.28"
},
{
"recvTime": "2014-02-14T13:43:34.636Z",
"attrValue": "23.42"
},
{
"recvTime": "2014-02-14T13:43:35.424Z",
"attrValue": "22.12"
}
]
}
],
"id": "entityId",
"isPattern": false
},
"statusCode": {
"code": "200",
"reasonPhrase": "OK"
}
}
]
}
## Filtering by aggregation method and resolution using V1 API (deprecated) [/STH/v1/contextEntities/type/{entityType}/id/{entityId}/attributes/{attrName}?aggrMethod=sum&aggrPeriod=second&dateFrom=2015-01-01T00:00:00.000Z&dateTo=2015-12-31T23:59:59.999Z]
Gets the aggregated data stored by the STH for certain aggregation method and using certain resolution. Combining the information provided by these aggregated methods with the number of samples, it is possible to calculate probabilistic values such as the average value, the variance as well as the standard deviation.
+ Parameters
+ entityType (required, string) - Type of the entity whose associated raw data wants to be retrieved.
+ entityId (required, string) - Identifier of the entity whose associated raw data wants to be retrieved.
+ attrName (required, string) - Name of the attribute whose associated raw data wants to be retrieved.
+ aggrMethod (required, number) - The aggregation method. In case of numeric attribute values, the STH supports the following aggregation methods: *max* - maximum value, *min* - minimum value, *sum* - sum of all the samples, and *sum2* - sum of the square value of all the samples. On the other hand and in case of textual attribute values, the STH supports the *occur* aggregation method to count the occurrences of each string value.
+ aggrPeriod (required, number) - The aggregation period or resolution of the aggregated data to be retrieved.
+ dateFrom (optional, date) - The starting date from which the raw data should be retrieved. If not provided, the origin of time is used.
+ dateTo (optional, date) - The final date until which the raw data should be retrieved. If not provided, the current date is used.
### Get aggregated data [GET]
+ Request (application/json)
+ header
Fiware-Service: the-service
Fiware-ServicePath: /the-service-path
+ Response 200 (application/json)
+ body
{
"contextResponses": [
{
"contextElement": {
"attributes": [
{
"name": "attrName",
"values": [
{
"_id": {
"origin": "2015-02-18T02:46:00.000Z",
"resolution": "second"
},
"points": [
{
"offset": 13,
"samples": 1,
"sum": 34.59
}
]
}
]
}
],
"id": "entityId",
"isPattern": false
},
"statusCode": {
"code": "200",
"reasonPhrase": "OK"
}
}
]
}
+ Response 200 (application/json)
+ body
{
"contextResponses": [
{
"contextElement": {
"attributes": [
{
"name": "attrName",
"values": [
{
"_id": {
"origin": "2015-02-18T02:46:00.000Z",
"resolution": "second"
},
"points": [
{
"offset": 35,
"samples": 34,
"occur": {
"string01": 7,
"string02": 4,
"string03": 5,
"string04": 6,
"string05": 12
}
}
]
}
]
}
],
"id": "entityId",
"isPattern": false
},
"statusCode": {
"code": "200",
"reasonPhrase": "OK"
}
}
]
}