-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
3245 lines (3228 loc) · 98 KB
/
index.html
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui.css" >
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body {
margin:0;
background: #fafafa;
}
</style>
</head>
<div id="_mdspcontent">
<body>
<div class="top-nav-bar" id="swagger-ui"></div>
<!-- Main app markup goes here -->
<script type="text/javascript" src="https://code.jquery.com/jquery-1.7.1.min.js"></script>
<script src="https://static.eu1.mindsphere.io/osbar/v4/js/main.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-bundle.js"> </script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.24.2/swagger-ui-standalone-preset.js"> </script>
<script language="Javascript" type="text/javascript">
_mdsp.init({
title: "MindSphere",
appId: "_mdspcontent"
});
window.onload = function() {
var tenantName = function () {
var tmp = null;
$.ajax({
'async': false,
'type': "GET",
'url': "tenantname",
'success': function (data) {
tmp = data;
}
});
return tmp;
}();
console.log(tenantName);
var randomId = Math.floor(Math.random() * 40);
var url = window.location.href
var allcookies = document.cookie;
// Get all the cookies pairs in an array
cookiearray = allcookies.split(';');
// Now take key value pair out of this array
var xsrfToken = "";
for(var i=0; i<cookiearray.length; i++) {
name = cookiearray[i].split('=')[0];
value = cookiearray[i].split('=')[1];
if(name == 'XSRF-TOKEN'){
break;
}
}
xsrfToken += value;
var spec = {
"openapi": "3.0.0",
"info": {
"title": "Welcome to Mindsphere SDK Examples",
"description": "As you have landed on this page means-\n\n* You have successfully built and run the Node SDK Example application.\n\n* As the application is up & running you can now execute below operations, provided that you have correct environment variables configured.\n\n* We would recommend to go sequentially from top to down with below operations as few operations are dependent on other operations above.\n\n eg. GET endpoints need POST/PUT endpoints to be executed before. Else they may return blank response\n\n* To create Asset Aspect and assettype must be present in the system i.e putaspect-->puAssetType-->rootAsset-->postAsset\n\n* To create timeseries we must have entityID and propertysetname, for that we crate Asset first to get those values."
},
"servers": [
{
"url": url
}
],
"paths": {
"/assets/putaspect/{id}/{ifmatch}": {
"put": {
"security": [
{
"cookieAuth": []
}
],
"tags": [
"Asset-management"
],
"summary": "Create an aspect",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"default": tenantName+".aspect"+randomId
},
"required": true
},
{
"in": "path",
"name": "ifmatch",
"schema": {
"type": "integer", "default": "0"},
"required": true,
"description": "Last known version to facilitate optimistic locking"
}
],
"operationId": "saveAspectType",
"description": "Create or Update an aspect type. Only adding variables supported.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AspectType"
}
}
}
},
"responses": {
"200": {
"description": "The aspect type has been created",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AspectTypeResource"
}
}
}
}
}
}
},
"/assets/putassettype/{id}/{ifmatch}": {
"put": {
"tags": [
"Asset-management"
],
"summary": "Create or Update an asset type",
"parameters": [
{
"in": "path",
"name": "id",
"description": "The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)",
"schema": {"default": tenantName+".assettype"+randomId, "type": "string"},
"required": true
},
{
"in": "path",
"name": "ifmatch",
"schema": {
"type": "integer",
"default": "0"
},
"required": true,
"description": "Last known version to facilitate optimistic locking"
}
],
"operationId": "saveAssetType",
"description": "Create or Update an asset type.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AssetType"
}
}
}
},
"responses": {
"200": {
"description": "The aspect type has been created",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AssetTypeResource"
}
}
}
}
}
}
},
"/assets/root": {
"get": {
"summary": "Returns the root asset of the user.",
"operationId": "getRootAsset",
"tags": [
"Asset-management"
],
"responses": {
"200": {
"description": "Read the root asset of the user, from which the whole asset hierarchy can be rebuilt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/RootAssetResource"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/assets/postasset": {
"post": {
"tags": [
"Asset-management"
],
"summary": "Create an asset",
"operationId": "addAsset",
"description": "Creates a new asset with the provided content. Only instantiable types could be used.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/Asset"
}
}
}
},
"responses": {
"201": {
"description": "The asset is created",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AssetResourceWithHierarchyPath"
}
}
}
}
}
}
},
"/assets/assets": {
"get": {
"summary": "Get List of All Assets for tenant",
"operationId": "getAllAssets",
"tags": [
"Asset-management"
],
"responses": {
"200": {
"description": "First 10 assets present in tenant",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/AssetListResource"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/timeseries/puttimeseriesdata/{entityid}/{propertysetname}": {
"put": {
"summary": "Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.",
"tags": [
"Time Series Operations"
],
"description": "Create or update time series data for one combination of an asset (entity) and an(a) aspect (property set). In case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request.\n",
"parameters": [
{
"in": "path",
"name": "entityid",
"description": "unique identifier of the asset (entity)",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "propertysetname",
"schema": {
"type": "string"
},
"required": true,
"description": "Name of the aspect (property set)."
}
],
"operationId": "createOrUpdateTimeseriesData",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TimeSeriesDataItem"
}
}
}
}
},
"responses": {
"204": {
"description": "timeseries written\n"
},
"400": {
"description": "Bad request.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/BadRequest"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/Unauthorized"
}
}
}
},
"default": {
"description": "Other error with any status code and response body format."
}
}
}
},
"/timeseries/puttimeseries": {
"put": {
"summary": "Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.",
"tags": [
"Time Series Operations"
],
"description": "Create or update time series data for multiple unique combinations of assets (entities) and aspects (property sets).\nIn case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request. All asset-aspect (entity-property set) combinations need to belong to the same tenant.\n\nRequest body limitations:\n1. A maximum of 5 asset-aspect (entity-property set) combinations can be provided\n2. The request body size must be equal or less than 100 kb\n3. A maximum of 100 time series data items can be provided overall\n",
"operationId": "createOrUpdateTimeseries",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/TimeSeries"
}
}
}
},
"responses": {
"202": {
"description": "Accepted. For each asset-aspect (entity-property set) pair a validation error can occur. In case an error is returned for an asset-aspect (entity-property set) pair, time series data for that pair is not considered. Possible validation errors are\n - 400: bad request schema for asset-aspect (entity-property set) pair\n - 404: asset (entity) and/or aspect(proprety set) not found\n - 429: asset-aspect (entity-property set) pair could not be processed due to too many requests\n - default: unexpected error while processing\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/MultiStatusError"
}
}
}
},
"400": {
"description": "Bad request, in case the resource is invalid.\nFew of the validations as below -\n- Total number of records for all assets (entites) and aspects (property sets) should not be more than 100 per PUT request.\n- Total size of the payload should not be more than 100 kb per PUT request.\n- Payload cannot have more than 5 asset (entity)/aspect (property set) combinations.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/MultiTimeseiresBadRequest"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/Unauthorized"
}
}
}
},
"default": {
"description": "Other error with any status code and response body format."
}
}
}
},
"\/timeseries\/puttimeseriesdata\/{entityid}\/{propertysetname}": {
"put": {
"summary": "Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.",
"tags": ["Time Series Operations"],
"description": "Create or update time series data for one combination of an asset (entity) and an(a) aspect (property set). In case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request.\n",
"parameters": [{
"in": "path",
"name": "entityid",
"description": "unique identifier of the asset (entity)",
"schema": {"type": "string"},
"required": true
}, {
"in": "path",
"name": "propertysetname",
"schema": {"type": "string"},
"required": true,
"description": "Name of the aspect (property set)."
}],
"operationId": "createOrUpdateTimeseriesData",
"requestBody": {
"required": true,
"content": {
"application\/json": {
"schema": {
"type": "array",
"items": {"$ref": "#\/definitions\/TimeSeriesDataItem"}
}
}
}
},
"responses": {
"204": {"description": "timeseries written\n"},
"400": {
"description": "Bad request.\n",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/BadRequest"}}}
},
"401": {
"description": "unauthorized",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/Unauthorized"}}}
},
"default": {"description": "Other error with any status code and response body format."}
}
}
},
"\/timeseries\/puttimeseries": {
"put": {
"summary": "Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.",
"tags": ["Time Series Operations"],
"description": "Create or update time series data for multiple unique combinations of assets (entities) and aspects (property sets).\nIn case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request. All asset-aspect (entity-property set) combinations need to belong to the same tenant.\n\nRequest body limitations:\n1. A maximum of 5 asset-aspect (entity-property set) combinations can be provided\n2. The request body size must be equal or less than 100 kb\n3. A maximum of 100 time series data items can be provided overall\n",
"operationId": "createOrUpdateTimeseries",
"requestBody": {
"required": true,
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/TimeSeries"}}}
},
"responses": {
"202": {
"description": "Accepted. For each asset-aspect (entity-property set) pair a validation error can occur. In case an error is returned for an asset-aspect (entity-property set) pair, time series data for that pair is not considered. Possible validation errors are\n - 400: bad request schema for asset-aspect (entity-property set) pair\n - 404: asset (entity) and\/or aspect(proprety set) not found\n - 429: asset-aspect (entity-property set) pair could not be processed due to too many requests\n - default: unexpected error while processing\n",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/MultiStatusError"}}}
},
"400": {
"description": "Bad request, in case the resource is invalid.\nFew of the validations as below -\n- Total number of records for all assets (entites) and aspects (property sets) should not be more than 100 per PUT request.\n- Total size of the payload should not be more than 100 kb per PUT request.\n- Payload cannot have more than 5 asset (entity)\/aspect (property set) combinations.\n",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/MultiTimeseiresBadRequest"}}}
},
"401": {
"description": "unauthorized",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/Unauthorized"}}}
},
"default": {"description": "Other error with any status code and response body format."}
}
}
},
"\/timeseries\/get\/{entityId}\/{propertySetName}": {
"get": {
"summary": "Retrieve time series data",
"parameters": [{
"in": "path",
"name": "entityId",
"description": "unique identifier of the asset (entity)",
"schema": {"type": "string"},
"required": true
}, {
"in": "path",
"name": "propertySetName",
"description": "Name of the aspect (property set).",
"schema": {"type": "string"},
"required": true
}, {
"in": "query",
"name": "from",
"description": "Beginning of the time range to be retrieved (exclusive).",
"required": true,
"schema": {"type": "string", "format": "date-time"}
}, {
"in": "query",
"name": "to",
"description": "End of the time range to be retrieved (inclusive).",
"required": true,
"schema": {"type": "string", "format": "date-time"}
}, {
"in": "query",
"name": "limit",
"description": "Maximum number of time series data items to be retrieved.",
"required": false,
"schema": {"type": "integer", "default": 2000, "maximum": 2000}
}, {
"in": "query",
"name": "select",
"description": "Comma-separated list of properties to be returned. By default all properties of an(a) aspect (property set) are considered.",
"required": false,
"schema": {"type": "string"}
}, {
"in": "query",
"name": "sort",
"description": "Define sorting order of returned data. Sorting can be chronologically ascending (<i>asc<\/i>) or descending (<i>desc<\/i>).",
"required": false,
"schema": {"type": "string", "enum": ["asc", "desc"], "default": "asc"}
}, {
"in": "query",
"name": "latestValue",
"description": "If true, only the latest value of each property is returned. Latest values must be at least two hours old and at maximum 30 days old, in order to be considered. The returned values might be co-located or spread over multiple timestamps. Each property appears at max once in the response. The select parameter can be used to limit the properties to be considered. Parameters from, to, and limit must not be used in conjunction with latest.",
"required": false,
"schema": {"type": "boolean", "default": false}
}],
"operationId": "retrieveTimeseries",
"tags": ["Time Series Operations"],
"description": "Retrieve time series data for one combination of an asset (entity) and an(a) aspect (property set). The maximum number of time series data items returned per request is defined by parameter <i>limit<\/i>. In case more time series data items are present in the requested time range, only a subset of data items will be returned and a header <i>link<\/i> is added to the response. The header value contains the request URL to fetch the next set of time series data items, by increasing the <i>from<\/i> parameter accordingly. Returns the latest record if no range is provided.\n",
"responses": {
"200": {
"description": "Top 10 events.",
"content": {
"application\/json": {
"schema": {
"type": "array",
"items": {"$ref": "#\/definitions\/TimeSeriesDataItem"}
}
}
}
},
"default": {
"description": "unexpected error",
"content": {"application\/json": {"schema": {"$ref": "#\/definitions\/errors"}}}
}
}
}
},
"/eventAnalytics/topevents": {
"get": {
"summary": "Get top events.",
"operationId": "getTopEvents",
"tags": [
"event-analytics"
],
"responses": {
"200": {
"description": "Top 10 events.",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/TopEventOutput"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/eventAnalytics/filterEvents": {
"get": {
"summary": "Get top events.",
"operationId": "getfilteredEvents",
"tags": [
"event-analytics"
],
"responses": {
"200": {
"description": "Get filtered events",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/EventArrayOutput"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/eventAnalytics/countEvents": {
"get": {
"summary": "Get count of events.",
"operationId": "getcountOfEvents",
"tags": [
"event-analytics"
],
"responses": {
"200": {
"description": "Get count of events",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/EventCountOutput"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/eventAnalytics/removeDuplicateEvents": {
"get": {
"summary": "Remove duplicate events.",
"operationId": "removeDuplicateEvents",
"tags": [
"event-analytics"
],
"responses": {
"200": {
"description": "Remove duplicate events.",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/DuplicateEventArrayOutput"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
},
"/eventAnalytics/matcheventpatterns": {
"get": {
"summary": "Match event pattern.",
"operationId": "matchPatternevents",
"tags": [
"event-analytics"
],
"responses": {
"200": {
"description": "Match event pattern.",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/PatternMatchingOutput"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/definitions/errors"
}
}
}
}
}
}
}
},
"x-ErrorTemplate": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "number"
},
"error": {
"type": "string"
},
"exception": {
"type": "string"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
}
}
},
"definitions": {
"TopEventsInputDataModel": {
"description": "Data model describing the input for the <b>findTopEvents</b> functionality",
"allOf": [
{
"$ref": "#/definitions/EventsInputModel"
},
{
"type": "object",
"properties": {
"numberOfTopPositionsRequired": {
"type": "integer",
"format": "int32",
"minimum": 1,
"default": 10,
"description": "How many top positions will be returned in the response. Has to be a positive integer. If not specified, the default value 10 will be used."
}
}
}
],
"example": {
"numberOfTopPositionsRequired": 5,
"eventsMetadata": {
"eventTextPropertyName": "text"
},
"events": [
{
"_time": "2017-10-01T12:00:00.001Z",
"text": "INTRODUCING FUEL",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:01.001Z",
"text": "Status@Flame On",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:02.001Z",
"text": "Status@Flame On",
"text_qc": 0
}
]
},
"required": [
"events"
]
},
"TopEventOutput": {
"type": "array",
"description": "Tuple containing frequency of event and event text",
"items": {
"type": "object",
"properties": {
"appearances": {
"type": "integer",
"format": "int64",
"example": 76
},
"text": {
"type": "string",
"example": "event text"
}
}
},
"example": [
{
"appearances": 2,
"text": "Status@Flame On"
},
{
"appearances": 1,
"text": "INTRODUCING FUEL"
}
]
},
"EventSearchInputDataModel": {
"description": "Data model describing the input for the <b>eventsSearch</b> functionality",
"allOf": [
{
"$ref": "#/definitions/EventsInputModel"
},
{
"type": "object",
"properties": {
"filterList": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of events which will be removed from the input list",
"example": [
"START",
"STOP"
]
}
}
}
],
"example": {
"eventsMetadata": {
"eventTextPropertyName": "text"
},
"filterList": [
"INTRODUCING FUEL",
"MEANINGLESS ALARM",
"Status@Flame On"
],
"events": [
{
"_time": "2017-10-01T12:00:00.001Z",
"text": "INTRODUCING FUEL",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:01.001Z",
"text": "Status@Flame On",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:02.001Z",
"text": "Status@Flame Off",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:03.001Z",
"text": "Error code: 340",
"text_qc": 0
}
]
},
"required": [
"filterList",
"events",
"eventsMetadata"
]
},
"Event": {
"type": "object",
"description": "An event object (a tuple of time and text)",
"properties": {
"_time": {
"type": "string",
"format": "dateTime",
"description": "Timestamp of the event in the ISO 8601",
"example": "2017-10-01T12:00:00.001Z"
},
"text": {
"type": "string",
"description": "The text of the event",
"example": "event text"
},
"text_qc": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 1,
"description": "Quality check flag"
}
},
"required": [
"_time",
"text"
]
},
"EventsInputModel": {
"type": "object",
"description": "Contains the events and the metadata regarding the events structure",
"properties": {
"eventsMetadata": {
"description": "Metadata for the events list",
"type": "object",
"properties": {
"eventTextPropertyName": {
"type": "string",
"description": "The property name of the events list objects that contains the text of the event",
"example": "text"
}
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/definitions/Event"
}
}
},
"example": {
"eventsMetadata": {
"eventTextPropertyName": "text"
},
"events": [
{
"_time": "2017-10-01T12:00:00.001Z",
"text": "INTRODUCING FUEL",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:01.001Z",
"text": "Status@Flame On",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:02.001Z",
"text": "Status@Flame Off",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:03.001Z",
"text": "Error code: 340",
"text_qc": 0
},
{
"_time": "2017-10-01T12:00:03.001Z",
"text": "Error code: 340",
"text_qc": 0
}
]
},
"required": [
"events",
"eventsMetadata"
]
},
"EventInput": {
"type": "object",
"description": "Contains the events and the metadata regarding the events structure",
"properties": {
"eventsMetadata": {
"description": "Metadata for the events list",
"type": "object",
"properties": {
"eventTextPropertyName": {
"type": "string",
"description": "The property name of the events list objects that contains the text of the event",
"example": "text"
},
"splitInterval": {
"type": "integer",
"format": "int32",
"description": "The window length represents the value in milliseconds of the period in which user wants to split input interval",
"example": 3
}
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/definitions/Event"
}
}
},
"example": {
"eventsMetadata": {
"eventTextPropertyName": "text",
"splitInterval": 5000
},
"events": [
{