-
Notifications
You must be signed in to change notification settings - Fork 62
/
apiary.apib
2297 lines (2046 loc) · 75.6 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
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
FORMAT: 1A
HOST: http://127.0.0.1:8888/api
# Metanome
The Metanome project is a project at HPI in cooperation with the Qatar Computing Reserach Institute (QCRI).
Metanome provides a fresh view on data profiling by developing and integrating efficient algorithms into a
common tool, expanding on the functionality of data profiling, and addressing performance and scalabilities
issues for Big Data.
This documentation describes the API offered by Metanome.
## Group File Inputs
A *File Input* is one input type supported by Metanome, which can be analyzed by the algorithms.
A *File Input* can be for example a CSV- or TSV-file.
A *File Input* has the following attributes:
+ file name
+ separator char
+ quote char
+ escape char
+ null value (the string representing the null value in the file)
+ skip lines
+ strict quotes
+ ignore leading white space
+ has header
+ skip differing lines
+ comment
### List all File Inputs [GET /file-inputs]
Returns a list of all *File Inputs* currently stored in the database.
+ Response 200 (application/json)
[
{
"type": "fileInput",
"id": 1,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
},
{
"type": "fileInput",
"id": 2,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_appearances.csv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_appearances.csv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
},
{
"type": "fileInput",
"id": 3,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_planetz.csv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_planetz.csv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
},
{
"type": "fileInput",
"id": 4,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/fd_reduced_15.csv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/fd_reduced_15.csv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
},
{
"type": "fileInput",
"id": 5,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputB.csv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputB.csv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
]
### Get one File Input [GET /file-inputs/get/{file_input_id}]
Returns a specific *File Input*.
+ Parameters
+ file_input_id: 1 (required, number) - ID of the *File Input* in form of an integer
+ Response 200 (application/json)
{
"type": "fileInput",
"id": 1,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
### Store a New File Input [POST /file-inputs/store]
Stores a new *File Input*.
It takes a JSON object containing the new *File Input*.
It returns a JSON object containing the stored *File Input* with the updated ID.
+ Request (application/json)
{
"type": "fileInput",
"id": 1,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
+ Response 200 (application/json)
{
"type": "fileInput",
"id": 16,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
### Update a File Input [POST /file-inputs/update]
Updates an existing *File Input*.
It takes a JSON object containing a *File Input*, which should be updated.
The corresponding *File Input* with the same ID is then updated in the database.
The JSON object of the updated *File Input* is returned.
+ Request (application/json)
{
"type": "fileInput",
"id": 1,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
+ Response 200 (application/json)
{
"type": "fileInput",
"id": 1,
"name": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"fileName": "/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"separator": ",",
"quoteChar": "\"",
"escapeChar": "\\\\\\\\",
"skipLines": 0,
"strictQuotes": false,
"ignoreLeadingWhiteSpace": true,
"hasHeader": true,
"skipDifferingLines": false,
"comment": null,
"nullValue": ""
}
### Delete a File Input [DELETE /file-inputs/delete/{file_input_id}]
Deletes the *File Input* with the given ID.
+ Parameters
+ file_input_id: 1 (required, number) - ID of the *File Input* in form of an integer
+ Response 204
### List all Files in the Resource Folder [GET /file-inputs/available-input-files]
Lists all files, which are located in the resource folder for *File Inputs*.
+ Response 200 (application/json)
[
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/inputC.tsv",
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_appearances.csv",
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_planetz.csv",
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_kepler.csv",
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_science.csv",
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_satellites.csv"
]
### Get one File or all the Files of a Directory [GET /file-inputs/get-directory-files/{file_name}]
Lists all files in directory for *File Inputs*.
+ Parameters
+ file_name 1 (required, number) - Name of the *File Input* in form of a String
+ Response 200 (application/json)
[
"/home/tanja/Repositories/Metanome/frontend/target/frontend-0.0.2-SNAPSHOT/WEB-INF/classes/inputData/WDC_planetz.csv"
]
## Group Database Connections
A *Database Connection* is the second input type supported by Metanome.
Analyzing a *Database Connection* means, that the algorithm has full access rights and can
chose the table to analyze by itselfs.
A *Database Connection* has the following attributes:
+ url
+ username
+ password
+ system
+ comment
### List all Database Connections [GET /database-connections]
Returns a list of all *Database Connections* currently stored in the database.
+ Response 200 (application/json)
[
{
"type": "databaseConnection",
"id": 1,
"name": "jdbc:mysql://localhost:8888; user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; user; MySQL"
},
{
"type": "databaseConnection",
"id": 2,
"name": "jdbc:mysql://example.com:8080; group; MySQL",
"url": "jdbc:mysql://example.com:8080",
"username": "group",
"password": "1234",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://example.com:8080; group; MySQL"
}
]
### Get one Database Connection [GET /database-connections/get/{database_connection_id}]
Returns a specific *Database Connection*.
+ Parameters
+ database_connection_id: 1 (required, number) - ID of the *Database Connection* in form of an integer
+ Response 200 (application/json)
{
"type": "databaseConnection",
"id": 1,
"name": "jdbc:mysql://localhost:8888; user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; user; MySQL"
}
### Store a New Database Connection [POST /database-connections/store]
Stores a new *Database Connection*.
It takes a JSON object containing the new *Database Connection*.
It returns a JSON object containing the stored *Database Connection* with the updated ID.
+ Request (application/json)
{
"type": "databaseConnection",
"id": 1,
"name": "jdbc:mysql://localhost:8888; new_user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "new_user",
"password": "abcde",
"system": "MySQL",
"comment": ""
}
+ Response 200 (application/json)
{
"type": "databaseConnection",
"id": 19,
"name": "jdbc:mysql://localhost:8888; new_user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "new_user",
"password": "abcde",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; new_user; MySQL"
}
### Update a Database Connection [POST /database-connections/update]
Updates an existing *Database Connection*.
It takes a JSON object containing a *Database Connection*, which should be updated.
The corresponding *Database Connection* with the same ID is updated in the database.
The JSON object of the updated *Database Connection* is returned.
+ Request (application/json)
{
"type": "databaseConnection",
"id": 19,
"name": "jdbc:mysql://localhost:8888; new_user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "new_user",
"password": "abcde1234",
"system": "MySQL",
"comment": ""
}
+ Response 200 (application/json)
{
"type": "databaseConnection",
"id": 19,
"name": "jdbc:mysql://localhost:8888; new_user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "new_user",
"password": "abcde1234",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; new_user; MySQL"
}
### Delete a Database Connecton [DELETE /database-connections/delete/{database_connection_id}]
Deletes the *Database Connection* with the given ID.
+ Parameters
+ database_connection_id: 1 (required, number) - ID of the *Database Connection* in form of an integer
+ Response 204
## Group Table Inputs
A *Table Input* is the third and last input type supported by Metanome,
which can be analyzed by the different algorithms.
It represents a specific table in a database.
A *Table Input* has the following attributes:
+ table name
+ database connection
+ comment
### List all Table Inputs [GET /table-inputs]
Returns a list of all *Table Inputs* currently stored in the database.
+ Response 200 (application/json)
[
{
"type": "tableInput",
"id": 1,
"name": "user_names; jdbc:mysql://localhost:8888; user; MySQL",
"tableName": "user_names",
"databaseConnection": {
"type": "databaseConnection",
"id": 1,
"name": "jdbc:mysql://localhost:8888; user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; user; MySQL"
},
"comment": ""
},
{
"type": "tableInput",
"id": 2,
"name": "address; jdbc:mysql://example.com:8080; group; MySQL",
"tableName": "address",
"databaseConnection": {
"type": "databaseConnection",
"id": 2,
"name": "jdbc:mysql://example.com:8080; group; MySQL",
"url": "jdbc:mysql://example.com:8080",
"username": "group",
"password": "1234",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://example.com:8080; group; MySQL"
},
"comment": ""
}
]
### Get one Table Input [GET /table-inputs/get/{table_input_id}]
Returns a specific *Table Input*.
+ Parameters
+ table_input_id: 1 (required, number) - ID of the *Table Input* in form of an integer
+ Response 200 (application/json)
{
"type": "tableInput",
"id": 1,
"name": "user_names; jdbc:mysql://localhost:8888; user; MySQL",
"tableName": "user_names",
"databaseConnection": {
"type": "databaseConnection",
"id": 1,
"name": "jdbc:mysql://localhost:8888; user; MySQL",
"url": "jdbc:mysql://localhost:8888",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://localhost:8888; user; MySQL"
},
"comment": ""
}
### Store a New Table Input [POST /table-inputs/store]
Stores a new *Table Input*.
It takes a JSON object containing the new *Table Input*.
It returns a JSON object containing the stored *Table Input* with the updated ID.
+ Request (application/json)
{
"type": "tableInput",
"id": 20,
"name": "shippments; jdbc:mysql://example.org:3306; user; MySQL",
"tableName": "shippments",
"databaseConnection": {
"type": "databaseConnection",
"id": 17,
"name": "jdbc:mysql://example.org:3306; user; MySQL",
"url": "jdbc:mysql://example.org:3306",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": ""
},
"comment": ""
}
+ Response 200 (application/json)
{
"type": "tableInput",
"id": 20,
"name": "shippments; jdbc:mysql://example.org:3306; user; MySQL",
"tableName": "shippments",
"databaseConnection": {
"type": "databaseConnection",
"id": 17,
"name": "jdbc:mysql://example.org:3306; user; MySQL",
"url": "jdbc:mysql://example.org:3306",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://example.org:3306; user; MySQL"
},
"comment": ""
}
### Update a Table Input [POST /table-inputs/update]
Updates an existing *Table Input*.
It takes a JSON object containing a *Table Input*, which should be updated.
The corresponding *Table Input* with the same ID is updated in the database.
The JSON object of the updated *Table Input* is returned.
+ Request (application/json)
{
"type": "tableInput",
"id": 20,
"name": "shippment; jdbc:mysql://example.org:3306; user; MySQL",
"tableName": "shippment",
"databaseConnection": {
"type": "databaseConnection",
"id": 17,
"name": "jdbc:mysql://example.org:3306; user; MySQL",
"url": "jdbc:mysql://example.org:3306",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": ""
},
"comment": ""
}
+ Response 200 (application/json)
{
"type": "tableInput",
"id": 20,
"name": "shippment; jdbc:mysql://example.org:3306; user; MySQL",
"tableName": "shippment",
"databaseConnection": {
"type": "databaseConnection",
"id": 17,
"name": "jdbc:mysql://example.org:3306; user; MySQL",
"url": "jdbc:mysql://example.org:3306",
"username": "user",
"password": "password",
"system": "MySQL",
"comment": "",
"identifier": "jdbc:mysql://example.org:3306; user; MySQL"
},
"comment": ""
}
### Delete a Table Input [DELETE /table-inputs/delete/{table_input_id}]
Deletes the *Table Input* with the given ID.
+ Parameters
+ table_input_id: 1 (required, number) - ID of the *Table Input* in form of an integer
+ Response 204
## Group Algorithms
An *Algorithm* represents a data profiling algorithm.
There are serveral types of data profiling algorithms, such as
Functional Dependency Algorithms, Inclusion Dependency Algorithms or
Unique Column Combination Algorithms.
An *Algorithm* has the following attributes:
+ file name
+ name
+ author
+ description
Besides, an *Algorithm* has some boolean attributes, which indicate what kind of algorithm it is.
+ ind
+ fd
+ ucc
+ cucc
+ od
+ basic statistic
And some boolean attriutes indicating what kind of input source the algorithm accepts.
+ relational input (either file or table input)
+ file input
+ database connection
+ table input
### List all Algorithms [GET /algorithms]
Returns a list of all *Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 1,
"fileName": "example_relational_input_algorithm.jar",
"name": "example_relational_input_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": true,
"fileInput": false,
"basicStat": false
},
{
"id": 2,
"fileName": "SPIDERDatabase-0.0.2-SNAPSHOT.jar",
"name": "SPIDERDatabase-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": true,
"fd": false,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": true,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 3,
"fileName": "fdmine_algorithm-0.0.2-SNAPSHOT.jar",
"name": "fdmine_algorithm-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": false,
"fd": true,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 4,
"fileName": "ducc_for_metanome-0.0.2-SNAPSHOT.jar",
"name": "ducc_for_metanome-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
}
]
### List all Inclusion Dependency Algorithms [GET /algorithms/inclusion-dependency-algorithms/]
Retruns a list of all *Inclusion Dependency Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 2,
"fileName": "SPIDERDatabase-0.0.2-SNAPSHOT.jar",
"name": "SPIDERDatabase-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": true,
"fd": false,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": true,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 8,
"fileName": "SPIDERFile-0.0.2-SNAPSHOT.jar",
"name": "SPIDERFile-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": true,
"fd": false,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": true,
"basicStat": false
},
{
"id": 12,
"fileName": "BINDERFile-0.0.2-SNAPSHOT.jar",
"name": "BINDERFile-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": true,
"fd": false,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": true,
"basicStat": false
}
]
### List all Functional Dependency Algorithms [GET /algorithms/functional-dependency-algorithms/]
Retruns a list of all *Functional Dependency Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 3,
"fileName": "fdmine_algorithm-0.0.2-SNAPSHOT.jar",
"name": "fdmine_algorithm-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": false,
"fd": true,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 5,
"fileName": "fdep_algorithm-0.0.2-SNAPSHOT.jar",
"name": "fdep_algorithm-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": false,
"fd": true,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
}
]
### List all Unique Column Combination Algorithms [GET /algorithms/unique-column-combination-algorithms/]
Retruns a list of all *Unique Column Combination Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 4,
"fileName": "ducc_for_metanome-0.0.2-SNAPSHOT.jar",
"name": "DUCC",
"author": "Thorsten",
"description": null,
"ind": false,
"fd": false,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 14,
"fileName": "example_holistic_algorithm.jar",
"name": "example_holistic_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": true,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 15,
"fileName": "example_ucc_algorithm.jar",
"name": "example_ucc_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": true,
"basicStat": false
}
]
### List all Conditional Unique Column Combination Algorithms [GET /algorithms/conditional-unique-column-combination-algorithms/]
Retruns a list of all *Conditional Unique Column Combination Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 16,
"fileName": "example_cucc_algorithm.jar",
"name": "example_cucc_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": false,
"cucc": true,
"od": false,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": true,
"basicStat": false
}
]
### List all Order Dependency Algorithms [GET /algorithms/order-dependency-algorithms/]
Retruns a list of all *Order Dependency Algorithms* currently stored in the database.
+ Response 200 (application/json)
### List all Basic Statistics Algorithms [GET /algorithms/basic-statistics-algorithms/]
Retruns a list of all *Basic Statistics Algorithms* currently stored in the database.
+ Response 200 (application/json)
[
{
"id": 7,
"fileName": "ORDER-0.0.2-SNAPSHOT.jar",
"name": "ORDER-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": false,
"cucc": false,
"od": true,
"relationalInput": true,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
},
{
"id": 21,
"fileName": "example_od_algorithm.jar",
"name": "example_od_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": false,
"cucc": false,
"od": true,
"relationalInput": false,
"databaseConnection": false,
"tableInput": false,
"fileInput": false,
"basicStat": false
}
]
### Get one Algorithm [GET /algorithms/get/{algorithm_id}]
Returns a specific *Algorithm*.
+ Parameters
+ algorithm_id: 1 (required, number) - ID of the *Algorithm* in form of an integer
+ Response 200 (application/json)
{
"id": 1,
"fileName": "example_relational_input_algorithm.jar",
"name": "example_relational_input_algorithm",
"author": null,
"description": null,
"ind": false,
"fd": false,
"ucc": true,
"cucc": false,
"od": false,
"relationalInput": true,
"databaseConnection": false,
"tableInput": true,
"fileInput": false,
"basicStat": false
}
### Store a New Algorithm [POST /algorithms/store]
Stores a new *Algorithm*.
It takes a JSON object containing the new *Algorithm*.
It returns a JSON object containing the stored *Algorithm* with the updated ID.
+ Request (application/json)
{
"id": 1,
"fileName": "SPIDERFile-0.0.2-SNAPSHOT.jar",
"name": "SPIDERFile-0.0.2-SNAPSHOT",
"author": null,
"description": null,
"ind": true,
"fd": false,
"ucc": false,
"cucc": false,
"od": false,
"relationalInput": false,
"databaseConnection": false,