-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata-mart-reports.yaml
More file actions
2153 lines (2149 loc) · 93.4 KB
/
data-mart-reports.yaml
File metadata and controls
2153 lines (2149 loc) · 93.4 KB
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
# checkov:skip=CKV_OPENAPI_4:Public API - no auth required
# checkov:skip=CKV_OPENAPI_5:Public API - no auth required
openapi: 3.0.1
info:
title: Senzing Data Mart Reports REST API
version: "2.0.0-beta.1.0"
description: >-
This is the Senzing Data Mart Reports API. This provides endpoints and
types for obtaining reports from the data mart.
servers:
- url: http://localhost:8250
- url: "{protocol}://{host}:{port}{path}"
variables:
protocol:
enum:
- http
- https
default: http
host:
default: localhost
port:
default: "8250"
path:
default: "/"
paths:
/statistics/loaded:
get:
tags:
- Statistics
summary: >-
Gets the entity and record counts in total and by data source from the
data mart.
description: >-
Gets the entity and record counts in total and by data source from the
data mart. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getLoadedStatistics
parameters:
- $ref: "#/components/parameters/onlyLoadedQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzLoadedStats"
application/json:
schema:
$ref: "#/components/schemas/SzLoadedStats"
default:
schema:
$ref: "#/components/schemas/SzLoadedStats"
"500":
description: A server-side error occurred.
/statistics/loaded/data-sources/{dataSourceCode}:
get:
tags:
- Statistics
summary: >-
Gets the entity and record counts for a specific data source from the
data mart.
description: >-
Gets the entity and record counts for a specific data source from the
data mart. If no records have been loaded for the data source then
this returns a 200 OK response with counts of zero. However, if the
data source is not recognized then a 404 Not Found response is returned.
*NOTE*: Data mart statistics may be slightly delayed from the entity
repository.
operationId: getSourceLoadedStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzSourceLoadedStats"
application/json:
schema:
$ref: "#/components/schemas/SzSourceLoadedStats"
default:
schema:
$ref: "#/components/schemas/SzSourceLoadedStats"
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/loaded/data-sources/{dataSourceCode}/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
respective data source.
description: >-
Gets the entity ID's of the entities having at least one record from the
respective data source. If no records have been loaded for that data source
then this will return a 200 OK response that will have an empty array of
entity ID's rather than giving a 404 Not Found response. However, the data
source code in the path is not configured then this will return a 404 Not Found
response. *NOTE*: Data mart statistics may be slightly delayed from the entity
repository.
operationId: getEntityIdsForDataSource
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not strictly greater-than** the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/sizes:
get:
tags:
- Statistics
summary: >-
Gets the entity counts by entity size (Entity Size Breakdown).
description: >-
Gets the number of entities in the repository for each entity size
that exists. *NOTE*: Data mart statistics may be slightly delayed
from the entity repository.
operationId: getEntitySizeBreakdown
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitySizeBreakdown"
application/json:
schema:
$ref: "#/components/schemas/SzEntitySizeBreakdown"
default:
schema:
$ref: "#/components/schemas/SzEntitySizeBreakdown"
"500":
description: A server-side error occurred.
/statistics/sizes/{entitySize}:
get:
tags:
- Statistics
summary: >-
Gets the count of entities having the specific number of records.
description: >-
Gets the count of entities having the specific number of records.
If there are NO entities having the specified number of records then
this will return a 200 OK response with the result indicating a count
of zero entities rather than giving a 404 Not Found response.
*NOTE*: Data mart statistics may be slightly delayed from the entity
repository.
operationId: getEntitySizeCount
parameters:
- $ref: "#/components/parameters/entitySizePathParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitySizeCount"
application/json:
schema:
$ref: "#/components/schemas/SzEntitySizeCount"
default:
schema:
$ref: "#/components/schemas/SzEntitySizeCount"
"500":
description: A server-side error occurred.
/statistics/sizes/{entitySize}/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having the specific number of records.
description: >-
Gets the entity ID's of the entities having the number of records for the
specified entity size. If no entities have the specified number of records
then this will return a 200 OK response that will have an empty array of
entity ID's rather than giving a 404 Not Found response. Further, if there
are no entity ID's for entities satisfying the bound conditions of the
request then similarly a 200 OK response is returned but the array of ID's
contained in the response will be empty. *NOTE*: Data mart statistics may
be slightly delayed from the entity repository.
operationId: getEntityIdsForEntitySize
parameters:
- $ref: "#/components/parameters/entitySizePathParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"500":
description: If a server-side error occurred.
/statistics/relations:
get:
tags:
- Statistics
summary: >-
Gets the entity counts by the number of entity relations (Entity
Relation Breakdown).
description: >-
Gets the number of entities in the repository for each number of entity
relations that exists for those entities. *NOTE*: Data mart statistics
may be slightly delayed from the entity repository.
operationId: getEntityRelationsBreakdown
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntityRelationsBreakdown"
application/json:
schema:
$ref: "#/components/schemas/SzEntityRelationsBreakdown"
default:
schema:
$ref: "#/components/schemas/SzEntityRelationsBreakdown"
"500":
description: A server-side error occurred.
/statistics/relations/{relationsCount}:
get:
tags:
- Statistics
summary: >-
Gets the count of entities having the specific number of entity relations.
description: >-
Gets the count of entities having the specific number of entity relations.
If there are NO entities having the specified number of entity relations
then this will return a 200 OK response with the result indicating a count
of zero entities rather than giving a 404 Not Found response. *NOTE*: Data
mart statistics may be slightly delayed from the entity repository.
operationId: getEntityRelationsCount
parameters:
- $ref: "#/components/parameters/relationsCountPathParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntityRelationsCount"
application/json:
schema:
$ref: "#/components/schemas/SzEntityRelationsCount"
default:
schema:
$ref: "#/components/schemas/SzEntityRelationsCount"
"500":
description: A server-side error occurred.
/statistics/relations/{relationsCount}/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having the specific number of entity
relationships.
description: >-
Gets the entity ID's of the entities having the respective number of entity
relations. If no entities have the respective number of entity relations
then this will return a 200 OK response that will have an empty array of
entity ID's rather than giving a 404 Not Found response. Further, if there
are no entity ID's for entities satisfying the bound conditions of the request
then similarly a 200 OK response is returned but the array of ID's contained
in the response will be empty. *NOTE*: Data mart statistics may be slightly
delayed from the entity repository.
operationId: getEntityIdsForEntityRelations
parameters:
- $ref: "#/components/parameters/relationsCountPathParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"500":
description: If a server-side error occurred.
/statistics/summary:
get:
tags:
- Statistics
summary: >-
Gets the summary statistics for each data source versus every other
data source including itself.
description: >-
Gets the summary statistics for each data source versus every other
data source including itself. *NOTE*: Data mart statistics may be
slightly delayed from the entity repository.
operationId: getSummaryStatistics
parameters:
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
- $ref: "#/components/parameters/onlyLoadedQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzSummaryStats"
application/json:
schema:
$ref: "#/components/schemas/SzSummaryStats"
default:
schema:
$ref: "#/components/schemas/SzSummaryStats"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}:
get:
tags:
- Statistics
summary: >-
Gets the summary statistics for a specific data source versus every
other data source including itself.
description: >-
Gets the summary statistics for a specific data source versus every
other data source including itself. If the specified data source code
is not configured then a 404 Not Found response is returned. *NOTE*:
Data mart statistics may be slightly delayed from the entity repository.
operationId: getSourceSummaryStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
- $ref: "#/components/parameters/onlyLoadedQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzSourceSummary"
application/json:
schema:
$ref: "#/components/schemas/SzSourceSummary"
default:
schema:
$ref: "#/components/schemas/SzSourceSummary"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for one data source versus
another data source (which may be the same).
description: >-
Gets the cross-summary statistics for a primary data source versus another
data source (which may be the same). If either of the specified data
source codes is not configured then a 404 Not Found response is returned.
*NOTE*: Data mart statistics may be slightly delayed from the entity
repository.
operationId: getCrossSourceSummaryStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzCrossSourceSummary"
application/json:
schema:
$ref: "#/components/schemas/SzCrossSourceSummary"
default:
schema:
$ref: "#/components/schemas/SzCrossSourceSummary"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/matches:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for matches for entities having at
least one record from a primary data source and at least one **other**
record from another data source (which may be the same data source),
optionally for one or more combination of match key and principle.
description: >-
Gets the cross-summary statistics for matches between a primary data
source and another data source (which may be the same), optionally for
one or more combination of match key and principle. If either of
the specified data source codes is not configured then a 404 Not Found
response is returned. *NOTE*: Data mart statistics may be slightly
delayed from the entity repository.
operationId: getCrossSourceMatchStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzCrossSourceMatchCounts"
application/json:
schema:
$ref: "#/components/schemas/SzCrossSourceMatchCounts"
default:
schema:
$ref: "#/components/schemas/SzCrossSourceMatchCounts"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/ambiguous-matches:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for ambiguous-match relations between entities
having at least one record from one data source and entities having at least
one record from another data source (which may be the same), optionally for
one or more combination of match key and principle.
description: >-
Gets the cross-summary statistics for ambiguous-match relations between entities
having at least one record from a primary data source and entities having
at least one record another data source (which may be the same), optionally
for one or more combination of match key and principle. If either of the
specified data source codes is not configured then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getCrossSourceAmbiguousMatchStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzCrossSourceRelationCounts"
application/json:
schema:
$ref: "#/components/schemas/SzCrossSourceRelationCounts"
default:
schema:
$ref: "#/components/schemas/SzCrossSourceRelationCounts"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-matches:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for possible-match relations between entities
having at least one record from one data source and entities having at least
one record from another data source (which may be the same), optionally for
one or more combination of match key and principle.
description: >-
Gets the cross-summary statistics for possible-match relations between entities
having at least one record from a primary data source and entities having
at least one record another data source (which may be the same), optionally
for one or more combination of match key and principle. If either of the
specified data source codes is not configured then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getCrossSourcePossibleMatchStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationCounts"
application/json:
schema:
$ref: "#/components/schemas/SzRelationCounts"
default:
schema:
$ref: "#/components/schemas/SzRelationCounts"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-relations:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for possible relations between entities
having at least one record from one data source and entities having at least
one record from another data source (which may be the same), optionally for
one or more combination of match key and principle.
description: >-
Gets the cross-summary statistics for possible relations between entities
having at least one record from a primary data source and entities having
at least one record another data source (which may be the same), optionally
for one or more combination of match key and principle. If either of the
specified data source codes is not configured then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getCrossSourcePossibleRelationStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationCounts"
application/json:
schema:
$ref: "#/components/schemas/SzRelationCounts"
default:
schema:
$ref: "#/components/schemas/SzRelationCounts"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/disclosed-relations:
get:
tags:
- Statistics
summary: >-
Gets the cross-summary statistics for disclosed relations between entities
having at least one record from one data source and entities having at least
one record from another data source (which may be the same), optionally for
one or more combination of match key and principle.
description: >-
Gets the cross-summary statistics for disclosed relations between entities
having at least one record from a primary data source and entities having
at least one record another data source (which may be the same), optionally
for one or more combination of match key and principle. If either of the
specified data source codes is not configured then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getCrossSourceDisclosedRelationStatistics
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyWildcardQueryParam"
- $ref: "#/components/parameters/principleWildcardQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationCounts"
application/json:
schema:
$ref: "#/components/schemas/SzRelationCounts"
default:
schema:
$ref: "#/components/schemas/SzRelationCounts"
"500":
description: A server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/matches/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
first data source and at least one other record from the versus data
source.
description: >-
Gets the entity ID's of the entities having at least one record from the
first data source and at least one record from the versus data source. If
no entities have at least one record from the first data source and at least
one other record from the versus data source then this will return a 200 OK
response that will have an empty array of entity ID's rather than giving a
404 Not Found response. Further, if there are no entity ID's for entities
satisfying the bound conditions of the request then similarly a 200 OK
response is returned but the array of ID's contained in the response will be
empty. However, if either data source code is not found in the configuration
then a 404 Not Found response is returned. *NOTE*: Data mart statistics may
be slightly delayed from the entity repository.
operationId: getEntityIdsForCrossMatches
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/ambiguous-matches/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
first data source and an ambiguous-match relationship to an entity having
at least one record from the versus data source.
description: >-
Gets the entity ID's of the entities having at least one record from the
first data source and an ambiguous-match relationship to an entity having
at least one record from the versus data source. If there are no such
entities then this will return a 200 OK response that will have an empty
array of entity ID values rather than giving a 404 Not Found response.
Further, if there are no entities satisfying the bound conditions of the
request then similarly a 200 OK response is returned but the entity ID
array contained in the response will be empty. However, if either data
source code is not found in the configuration then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getAmbiguouslyCrossMatchedEntityIds
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/ambiguous-matches/relations:
get:
tags:
- Statistics
summary: >-
Gets the `SzRelation` values describing the ambiguous-match relationships
between entities having at least one record from the first data source and
entities having at least one record from the versus data source.
description: >-
Gets the `SzRelation` values describing the ambiguous-match relationships
between entities containing at least one record from the first data source
and another entity having at least one record from the versus data source.
If there are no such relationships then this will return a 200 OK response
that will have an empty array of `SzRelation` values rather than giving a
404 Not Found response. Further, if there are no relationships for entities
satisfying the bound conditions of the request then similarly a 200 OK
response is returned but the `SzRelation` array contained in the response
will be empty. However, if either data source code is not found in the
configuration then a 404 Not Found response is returned. *NOTE*: Data mart
statistics may be slightly delayed from the entity repository.
operationId: getAmbiguouslyCrossMatchedRelations
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/relationBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationsPage"
application/json:
schema:
$ref: "#/components/schemas/SzRelationsPage"
default:
schema:
$ref: "#/components/schemas/SzRelationsPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-matches/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a possible-match relationship to an entity having
at least one record from the versus data source.
description: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a possible-match relationship to an entity having
at least one record from the versus data source. If there are no such
entities then this will return a 200 OK response that will have an empty
array of entity ID values rather than giving a 404 Not Found response.
Further, if there are no entities satisfying the bound conditions of the
request then similarly a 200 OK response is returned but the entity ID
array contained in the response will be empty. However, if either data
source code is not found in the configuration then a 404 Not Found response
is returned. *NOTE*: Data mart statistics may be slightly delayed from
the entity repository.
operationId: getPossiblyCrossMatchedEntityIds
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-matches/relations:
get:
tags:
- Statistics
summary: >-
Gets the `SzRelation` values describing the possible-match relationships
between entities having at least one record from the first data source and
entities having at least one record from the versus data source.
description: >-
Gets the `SzRelation` values describing the possible-match relationships
between entities containing at least one record from the first data source
and another entity having at least one record from the versus data source.
If there are no such relationships then this will return a 200 OK response
that will have an empty array of `SzRelation` values rather than giving a
404 Not Found response. Further, if there are no relationships for entities
satisfying the bound conditions of the request then similarly a 200 OK
response is returned but the `SzRelation` array contained in the response
will be empty. However, if either data source code is not found in the
configuration then a 404 Not Found response is returned. *NOTE*: Data mart
statistics may be slightly delayed from the entity repository.
operationId: getPossiblyCrossMatchedRelations
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/relationBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationsPage"
application/json:
schema:
$ref: "#/components/schemas/SzRelationsPage"
default:
schema:
$ref: "#/components/schemas/SzRelationsPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-relations/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a possible relationship to an entity having at least
one record from the versus data source.
description: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a possible relationship to an entity having at least
one record from the versus data source. If there are no such entities then
this will return a 200 OK response that will have an empty array of
entity ID values rather than giving a 404 Not Found response. Further, if
there are no entities satisfying the bound conditions of the request then
similarly a 200 OK response is returned but the entity ID array contained
in the response will be empty. However, if either data source code is not
found in the configuration then a 404 Not Found response is returned. *NOTE*:
Data mart statistics may be slightly delayed from the entity repository.
operationId: getPossiblyCrossRelatedEntityIds
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/entityIdBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
application/json:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
default:
schema:
$ref: "#/components/schemas/SzEntitiesPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/possible-relations/relations:
get:
tags:
- Statistics
summary: >-
Gets the `SzRelation` values describing the possible relationships between
entities having at least one record from the first data source and entities
having at least one record from the versus data source.
description: >-
Gets the `SzRelation` values describing the possible relationships between
entities containing at least one record from the first data source and another
entity having at least one record from the versus data source. If there are
no such relationships then this will return a 200 OK response that will have
an empty array of `SzRelation` values rather than giving a 404 Not Found
response. Further, if there are no relationships for entities satisfying the
bound conditions of the request then similarly a 200 OK response is returned
but the `SzRelation` array contained in the response will be empty. However,
if either data source code is not found in the configuration then a 404 Not
Found response is returned. *NOTE*: Data mart statistics may be slightly
delayed from the entity repository.
operationId: getPossiblyCrossRelatedRelations
parameters:
- $ref: "#/components/parameters/dataSourceCodePathParam"
- $ref: "#/components/parameters/vsDataSourceCodePathParam"
- $ref: "#/components/parameters/matchKeyQueryParam"
- $ref: "#/components/parameters/principleQueryParam"
- $ref: "#/components/parameters/relationBoundQueryParam"
- $ref: "#/components/parameters/boundTypeQueryParam"
- $ref: "#/components/parameters/pageSizeQueryParam"
- $ref: "#/components/parameters/sampleSizeQueryParam"
responses:
"200":
description: Successful response
content:
application/json; charset=UTF-8:
schema:
$ref: "#/components/schemas/SzRelationsPage"
application/json:
schema:
$ref: "#/components/schemas/SzRelationsPage"
default:
schema:
$ref: "#/components/schemas/SzRelationsPage"
"400":
description: >-
If the `sampleSize` and `pageSize` parameter are both specified
and the `pageSize` is **not** strictly greater-than the `sampleSize`.
"404":
description: >-
If the specified data-source in the path is not configured.
"500":
description: If a server-side error occurred.
/statistics/summary/data-sources/{dataSourceCode}/vs/{vsDataSourceCode}/disclosed-relations/entities:
get:
tags:
- Statistics
summary: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a disclosed relationship to an entity having at least
one record from the versus data source.
description: >-
Gets the entity ID's of the entities having at least one record from the
first data source and a disclosed relationship to an entity having at least
one record from the versus data source. If there are no such entities then
this will return a 200 OK response that will have an empty array of
entity ID values rather than giving a 404 Not Found response. Further, if
there are no entities satisfying the bound conditions of the request then
similarly a 200 OK response is returned but the entity ID array contained
in the response will be empty. However, if either data source code is not
found in the configuration then a 404 Not Found response is returned. *NOTE*: