From bf257747a448531c9712070f6eb9e64d68a23794 Mon Sep 17 00:00:00 2001 From: Ara Winters Date: Wed, 2 Oct 2024 11:24:38 -0700 Subject: [PATCH] docs updated for 6.1.0 (#326) * docs updated for 6.1.0 * updated for 6.1.0 --- CHANGELOG.md | 5 +- docs/changelog.html | 167 +- docs/classes/Configuration.html | 724 +- docs/classes/CustomHttpUrlEncodingCodec.html | 274 +- docs/contributing.html | 110 +- docs/dependencies.html | 76 +- docs/index.html | 99 +- docs/injectables/AdminService.html | 3932 +-- docs/injectables/BulkDataService.html | 4792 +-- docs/injectables/ConfigService.html | 5422 ++-- docs/injectables/EntityDataService.html | 20844 +++++++------ docs/injectables/EntityGraphService.html | 3738 +-- docs/injectables/StatisticsService.html | 25290 ++++++++++++++++ docs/interfaces/BulkdataAnalyzeBody.html | 102 +- docs/interfaces/BulkdataLoadBody.html | 102 +- docs/interfaces/BulkdataRecordsBody.html | 104 +- docs/interfaces/ConfigurationParameters.html | 98 +- .../interfaces/SzAttributeSearchResponse.html | 102 +- .../SzAttributeSearchResponseData.html | 100 +- docs/interfaces/SzAttributeSearchResult.html | 106 +- docs/interfaces/SzAttributeType.html | 100 +- docs/interfaces/SzAttributeTypeResponse.html | 102 +- .../SzAttributeTypeResponseData.html | 100 +- docs/interfaces/SzAttributeTypesResponse.html | 102 +- .../SzAttributeTypesResponseData.html | 100 +- docs/interfaces/SzBaseBulkLoadResult.html | 100 +- docs/interfaces/SzBaseRelatedEntity.html | 102 +- docs/interfaces/SzBaseResponse.html | 100 +- docs/interfaces/SzBulkDataAnalysis.html | 100 +- .../SzBulkDataAnalysisResponse.html | 102 +- docs/interfaces/SzBulkLoadError.html | 100 +- docs/interfaces/SzBulkLoadResponse.html | 102 +- docs/interfaces/SzBulkLoadResult.html | 102 +- docs/interfaces/SzCandidateKey.html | 100 +- docs/interfaces/SzConfigResponse.html | 98 +- docs/interfaces/SzCrossSourceSummary.html | 598 + .../SzCrossSourceSummaryResponse.html | 309 + docs/interfaces/SzDataSource.html | 100 +- .../SzDataSourceBulkLoadResult.html | 102 +- .../SzDataSourceRecordAnalysis.html | 100 +- .../interfaces/SzDataSourceRecordSummary.html | 100 +- docs/interfaces/SzDataSourceResponse.html | 102 +- docs/interfaces/SzDataSourceResponseData.html | 100 +- docs/interfaces/SzDataSourcesResponse.html | 102 +- .../interfaces/SzDataSourcesResponseData.html | 100 +- docs/interfaces/SzDeleteRecordResponse.html | 102 +- .../SzDeleteRecordResponseData.html | 100 +- docs/interfaces/SzDisclosedRelation.html | 100 +- docs/interfaces/SzEntitiesPage.html | 864 + docs/interfaces/SzEntity.html | 523 + docs/interfaces/SzEntityData.html | 100 +- docs/interfaces/SzEntityFeature.html | 100 +- docs/interfaces/SzEntityFeatureDetail.html | 100 +- .../interfaces/SzEntityFeatureStatistics.html | 100 +- docs/interfaces/SzEntityNetworkData.html | 108 +- docs/interfaces/SzEntityNetworkResponse.html | 102 +- docs/interfaces/SzEntityPath.html | 100 +- docs/interfaces/SzEntityPathData.html | 104 +- docs/interfaces/SzEntityPathResponse.html | 102 +- docs/interfaces/SzEntityRecord.html | 102 +- .../SzEntityRelationsBreakdown.html | 303 + .../SzEntityRelationsBreakdownResponse.html | 309 + docs/interfaces/SzEntityRelationsCount.html | 347 + .../SzEntityRelationsCountResponse.html | 309 + docs/interfaces/SzEntityResponse.html | 102 +- docs/interfaces/SzEntitySizeBreakdown.html | 303 + .../SzEntitySizeBreakdownResponse.html | 309 + docs/interfaces/SzEntitySizeCount.html | 347 + .../interfaces/SzEntitySizeCountResponse.html | 309 + docs/interfaces/SzError.html | 100 +- docs/interfaces/SzErrorResponse.html | 102 +- docs/interfaces/SzFeatureReference.html | 100 +- docs/interfaces/SzFeatureScore.html | 100 +- docs/interfaces/SzFlaggedEntity.html | 100 +- docs/interfaces/SzFlaggedRecord.html | 100 +- docs/interfaces/SzFocusRecordId.html | 100 +- docs/interfaces/SzHowEntityResponse.html | 102 +- docs/interfaces/SzHowEntityResult.html | 104 +- docs/interfaces/SzHowMatchInfo.html | 100 +- docs/interfaces/SzLicenseInfo.html | 100 +- docs/interfaces/SzLicenseResponse.html | 102 +- docs/interfaces/SzLicenseResponseData.html | 100 +- docs/interfaces/SzLinks.html | 100 +- docs/interfaces/SzLoadRecordResponse.html | 102 +- docs/interfaces/SzLoadRecordResponseData.html | 100 +- docs/interfaces/SzLoadedStats.html | 450 + docs/interfaces/SzLoadedStatsResponse.html | 309 + docs/interfaces/SzMatchCounts.html | 469 + docs/interfaces/SzMatchCountsResponse.html | 309 + .../interfaces/SzMatchCountsResponseData.html | 401 + docs/interfaces/SzMatchedRecord.html | 102 +- docs/interfaces/SzMeta.html | 100 +- docs/interfaces/SzNameScoring.html | 100 +- docs/interfaces/SzOpenApiSpecResponse.html | 102 +- docs/interfaces/SzPagedEntitiesResponse.html | 309 + docs/interfaces/SzPagedRelationsResponse.html | 309 + docs/interfaces/SzQueueInfo.html | 100 +- docs/interfaces/SzQueueInfoResponse.html | 102 +- docs/interfaces/SzRecord.html | 445 + docs/interfaces/SzRecordId.html | 100 +- docs/interfaces/SzRecordResponse.html | 102 +- docs/interfaces/SzRecordResponseData.html | 100 +- docs/interfaces/SzReevaluateResponse.html | 102 +- docs/interfaces/SzReevaluateResponseData.html | 100 +- docs/interfaces/SzRelatedEntity.html | 102 +- docs/interfaces/SzRelatedFeatures.html | 100 +- docs/interfaces/SzRelation.html | 491 + docs/interfaces/SzRelationCounts.html | 524 + docs/interfaces/SzRelationCountsResponse.html | 309 + .../SzRelationCountsResponseData.html | 442 + docs/interfaces/SzRelationsPage.html | 864 + docs/interfaces/SzResolutionInfo.html | 100 +- docs/interfaces/SzResolutionStep.html | 100 +- docs/interfaces/SzResolvedEntity.html | 102 +- docs/interfaces/SzResponseWithRawData.html | 102 +- docs/interfaces/SzScoredFeature.html | 100 +- docs/interfaces/SzScoringBehavior.html | 100 +- docs/interfaces/SzSearchFeatureScore.html | 100 +- docs/interfaces/SzServerInfo.html | 161 +- docs/interfaces/SzServerInfoResponse.html | 102 +- docs/interfaces/SzSourceLoadedStats.html | 451 + .../SzSourceLoadedStatsResponse.html | 309 + docs/interfaces/SzSourceSummary.html | 529 + docs/interfaces/SzSourceSummaryResponse.html | 309 + docs/interfaces/SzSummaryStats.html | 309 + docs/interfaces/SzSummaryStatsResponse.html | 309 + docs/interfaces/SzVersionInfo.html | 210 +- docs/interfaces/SzVersionResponse.html | 102 +- docs/interfaces/SzVirtualEntity.html | 100 +- docs/interfaces/SzVirtualEntityData.html | 100 +- docs/interfaces/SzVirtualEntityRecord.html | 100 +- docs/interfaces/SzVirtualEntityResponse.html | 102 +- docs/interfaces/SzWhyEntitiesResponse.html | 102 +- .../interfaces/SzWhyEntitiesResponseData.html | 104 +- docs/interfaces/SzWhyEntitiesResult.html | 100 +- docs/interfaces/SzWhyEntityResponse.html | 102 +- docs/interfaces/SzWhyEntityResponseData.html | 104 +- docs/interfaces/SzWhyEntityResult.html | 100 +- docs/interfaces/SzWhyMatchInfo.html | 100 +- docs/interfaces/SzWhyPerspective.html | 100 +- docs/interfaces/SzWhyRecordsResponse.html | 102 +- docs/interfaces/SzWhyRecordsResponseData.html | 104 +- docs/interfaces/SzWhyRecordsResult.html | 100 +- docs/js/libs/bootstrap-native.js | 4 +- docs/js/libs/es6-shim.min.js | 21 +- docs/js/libs/prism.js | 86 +- docs/js/libs/svg-pan-zoom.min.js | 4 +- docs/js/libs/tablesort.min.js | 6 +- docs/js/libs/tablesort.number.min.js | 4 +- docs/js/libs/vis.min.js | 13 +- docs/js/menu-wc.js | 122 +- docs/js/menu-wc_es5.js | 44 +- docs/js/menu.js | 63 +- docs/js/routes.js | 355 +- docs/js/search/search.js | 127 +- docs/js/search/search_index.js | 4 +- docs/license.html | 80 +- docs/miscellaneous/typealiases.html | 220 +- docs/miscellaneous/variables.html | 186 +- docs/modules.html | 76 +- docs/modules/ApiModule.html | 193 +- docs/overview.html | 80 +- docs/properties.html | 295 +- docs/styles/bootstrap.min.css | 12 +- docs/styles/compodoc.css | 60 +- docs/styles/dark.css | 4 + 166 files changed, 68142 insertions(+), 22242 deletions(-) create mode 100644 docs/injectables/StatisticsService.html create mode 100644 docs/interfaces/SzCrossSourceSummary.html create mode 100644 docs/interfaces/SzCrossSourceSummaryResponse.html create mode 100644 docs/interfaces/SzEntitiesPage.html create mode 100644 docs/interfaces/SzEntity.html create mode 100644 docs/interfaces/SzEntityRelationsBreakdown.html create mode 100644 docs/interfaces/SzEntityRelationsBreakdownResponse.html create mode 100644 docs/interfaces/SzEntityRelationsCount.html create mode 100644 docs/interfaces/SzEntityRelationsCountResponse.html create mode 100644 docs/interfaces/SzEntitySizeBreakdown.html create mode 100644 docs/interfaces/SzEntitySizeBreakdownResponse.html create mode 100644 docs/interfaces/SzEntitySizeCount.html create mode 100644 docs/interfaces/SzEntitySizeCountResponse.html create mode 100644 docs/interfaces/SzLoadedStats.html create mode 100644 docs/interfaces/SzLoadedStatsResponse.html create mode 100644 docs/interfaces/SzMatchCounts.html create mode 100644 docs/interfaces/SzMatchCountsResponse.html create mode 100644 docs/interfaces/SzMatchCountsResponseData.html create mode 100644 docs/interfaces/SzPagedEntitiesResponse.html create mode 100644 docs/interfaces/SzPagedRelationsResponse.html create mode 100644 docs/interfaces/SzRecord.html create mode 100644 docs/interfaces/SzRelation.html create mode 100644 docs/interfaces/SzRelationCounts.html create mode 100644 docs/interfaces/SzRelationCountsResponse.html create mode 100644 docs/interfaces/SzRelationCountsResponseData.html create mode 100644 docs/interfaces/SzRelationsPage.html create mode 100644 docs/interfaces/SzSourceLoadedStats.html create mode 100644 docs/interfaces/SzSourceLoadedStatsResponse.html create mode 100644 docs/interfaces/SzSourceSummary.html create mode 100644 docs/interfaces/SzSourceSummaryResponse.html create mode 100644 docs/interfaces/SzSummaryStats.html create mode 100644 docs/interfaces/SzSummaryStatsResponse.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 8676d71..5f8078c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), [markdownlint](https://dlaa.me/markdownlint/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [6.1.0] - 2024-03-13 +## [6.1.0] - 2024-10-02 The majority of the new additions to models and api services only match up to the POC server implementation of the Senzing API Spec and facilitate access to statistics provided through the *Data Mart* interface(s). As Such these are provided as *optional* models that are not present in all api products. @@ -34,6 +34,9 @@ The majority of the new additions to models and api services only match up to th - `SzSummaryStats` model. Encapsulates the statistics for the source summaries for every data source. - `SzSummaryStatsResponse` model. Extends the BaseResponse to add the fields for statistics representing summary statistics for every configured data source. +### Modified +- dependency versions updated for security patches + ## [6.0.1] - 2023-05-11 ### Modified diff --git a/docs/changelog.html b/docs/changelog.html index dfb7905..5b66ba8 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -12,10 +12,61 @@ - - +
+ +
@@ -11249,7 +11188,7 @@

- Public + Public whyEntities @@ -11257,219 +11196,217 @@

- + whyEntities(entity1: string, entity2: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe: any, reportProgress: boolean, additionalHeaders: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDefault value
entity1 - string - - No - -
entity2 - string - - No - -
withRelationships - boolean - - Yes - -
withFeatureStats - boolean - - Yes - -
withInternalFeatures - boolean - - Yes -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
entity1 + string + + No + +
entity2 + string + + No + +
withRelationships + boolean + + Yes + +
withFeatureStats + boolean + + Yes + +
withInternalFeatures + boolean + + Yes + +
detailLevel + SzDetailLevel + + Yes + +
featureMode + SzFeatureMode + + Yes + +
forceMinimal + boolean + + Yes + +
withRaw + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
additionalHeaders + literal type + + No + + {} +
+
+
+ Returns : Observable<any> - - - - - - detailLevel - - SzDetailLevel - - - - Yes - - - - - - - - featureMode - - SzFeatureMode - - - - Yes - - - - - - - - forceMinimal - - boolean - - - - Yes - - - - - - - - withRaw - - boolean - - - - Yes - - - - - - - - observe - - any - - - - No - - - - 'body' - - - - - reportProgress - - boolean - - - - No - - - - false - - - - - additionalHeaders - - literal type - - - - No - - - - {} - - - - - -
-
-
-
- Returns : Observable<any> - -
-
- -
+ +
+ +
@@ -11480,7 +11417,7 @@

- Public + Public whyEntityByEntityID @@ -11488,224 +11425,222 @@

- + whyEntityByEntityID(entityId: number, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -

Returns an analysis of why the entity for the respective entity ID resolved. +

Returns an analysis of why the entity for the respective entity ID resolved. This operation provides an anlysis of why the records in an entity resolved. The subject entity is identified by the entity ID in the request path. NOTE: Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why`.

-
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDescription
entityId - number - - No - -

The unique numeric ID that identifies that entity being requested.

- -
withRelationships - boolean - - Yes - -

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

- -
withFeatureStats - boolean - - Yes - -

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

- -
withInternalFeatures - boolean - - Yes - -

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

- -
detailLevel - SzDetailLevel - - Yes - -

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

- -
featureMode - SzFeatureMode - - Yes - -

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

- -
forceMinimal - boolean -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - + + + + + - + - - - - - + + + + + - + - - - - - + + + + + - + - - - - - + + + + + - + - - - -
NameTypeOptionalDescription
entityId + number + + No + +

The unique numeric ID that identifies that entity being requested.

+ +
withRelationships + boolean + + Yes + +

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

+ +
withFeatureStats + boolean + + Yes + +

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

+ +
withInternalFeatures + boolean + + Yes + +

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

+ +
detailLevel + SzDetailLevel + + Yes + +

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

+ +
featureMode + SzFeatureMode + + Yes + +

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

+ +
forceMinimal + boolean + - Yes - + Yes + -

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

+
+

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

-
withRaw - boolean -
withRaw + boolean + - Yes - + Yes + -

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

+
+

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

-
observe -
observe + - Yes - + Yes + -

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+
+

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

-
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes + -

flag to report request and response progress.

+
+

flag to report request and response progress.

-
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes + -
-
-
-
-
- Returns : Observable<SzWhyEntityResponse> + + + + + +
+ -
- -
+
+
+ +
@@ -11716,7 +11651,7 @@

- Public + Public whyEntityByEntityID @@ -11724,178 +11659,176 @@

- + whyEntityByEntityID(entityId: number, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
entityId - number -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
entityId + number + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel -
detailLevel + SzDetailLevel + - Yes - + Yes +
featureMode - SzFeatureMode -
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean -
forceMinimal + boolean + - Yes - + Yes +
withRaw - boolean - - Yes -
observe -
withRaw + boolean + + Yes +
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -11906,7 +11839,7 @@

- Public + Public whyEntityByEntityID @@ -11914,178 +11847,176 @@

- + whyEntityByEntityID(entityId: number, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
entityId - number -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
entityId + number + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel -
detailLevel + SzDetailLevel + - Yes - + Yes +
featureMode - SzFeatureMode -
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean -
forceMinimal + boolean + - Yes - + Yes +
withRaw - boolean - - Yes -
observe -
withRaw + boolean + + Yes +
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -12096,7 +12027,7 @@

- Public + Public whyEntityByEntityID @@ -12104,205 +12035,203 @@

- + whyEntityByEntityID(entityId: number, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe: any, reportProgress: boolean, additionalHeaders: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDefault value
entityId - number - - No - -
withRelationships - boolean - - Yes - -
withFeatureStats - boolean - - Yes - -
withInternalFeatures - boolean - - Yes - -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
entityId + number + + No + +
withRelationships + boolean + + Yes + +
withFeatureStats + boolean + + Yes + +
withInternalFeatures + boolean + + Yes + +
detailLevel + SzDetailLevel + + Yes + +
featureMode + SzFeatureMode + + Yes + +
forceMinimal + boolean + + Yes + +
withRaw + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
additionalHeaders + literal type + + No + + {} +
+
+
+ Returns : Observable<any> - - - detailLevel - - SzDetailLevel - - - - Yes - - - - - - - - featureMode - - SzFeatureMode - - - - Yes - - - - - - - - forceMinimal - - boolean - - - - Yes - - - - - - - - withRaw - - boolean - - - - Yes - - - - - - - - observe - - any - - - - No - - - - 'body' - - - - - reportProgress - - boolean - - - - No - - - - false - - - - - additionalHeaders - - literal type - - - - No - - - - {} - - - - - -
-
-
-
- Returns : Observable<any> - -
-
- -
+ +
+ +
@@ -12313,7 +12242,7 @@

- Public + Public whyEntityByRecordID @@ -12321,240 +12250,238 @@

- + whyEntityByRecordID(dataSourceCode: string, recordId: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -

Returns an analysis of why the entity for the record with the respective data source code and record ID resolved. +

Returns an analysis of why the entity for the record with the respective data source code and record ID resolved. This operation provides an anlysis of why the records in an entity resolved. The subject entity is the one containing the record identified by the data source code and record ID in the request path.

-
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDescription
dataSourceCode - string - - No - -

The data source code identifying the data source.

- -
recordId - string - - No - -

The identifier that uniquely identifies the requested record within a given data source. This may have been specified when the record was loaded or generated automatically.

- -
withRelationships - boolean - - Yes - -

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

- -
withFeatureStats - boolean - - Yes - -

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

- -
withInternalFeatures - boolean - - Yes - -

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

- -
detailLevel - SzDetailLevel - - Yes - -

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

- -
featureMode - SzFeatureMode - - Yes -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - -
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
recordId + string + + No + +

The identifier that uniquely identifies the requested record within a given data source. This may have been specified when the record was loaded or generated automatically.

+ +
withRelationships + boolean + + Yes + +

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

+ +
withFeatureStats + boolean + + Yes + +

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

+ +
withInternalFeatures + boolean + + Yes + +

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

+ +
detailLevel + SzDetailLevel + + Yes + +

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

+ +
featureMode + SzFeatureMode + + Yes + -

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

-
forceMinimal - boolean - +

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

-
- Yes -
forceMinimal + boolean + + Yes + -

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

-
withRaw - boolean - +

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

-
- Yes -
withRaw + boolean + + Yes + -

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

-
observe - +

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

-
- Yes -
observe + + Yes + -

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

-
reportProgress - boolean - +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

-
- Yes -
reportProgress + boolean + + Yes + -

flag to report request and response progress.

-
additionalHeaders - literal type - +

flag to report request and response progress.

-
- Yes -
additionalHeaders + literal type + + Yes + -
-
-
-
- -
- -
+ + + + + +
+ +
+ +
@@ -12565,7 +12492,7 @@

- Public + Public whyEntityByRecordID @@ -12573,190 +12500,188 @@

- + whyEntityByRecordID(dataSourceCode: string, recordId: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
dataSourceCode - string -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
dataSourceCode + string + - No - + No +
recordId - string -
recordId + string + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel -
detailLevel + SzDetailLevel + - Yes - + Yes +
featureMode - SzFeatureMode -
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean - - Yes -
withRaw - boolean -
forceMinimal + boolean + + Yes +
withRaw + boolean + - Yes - + Yes +
observe -
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -12767,7 +12692,7 @@

- Public + Public whyEntityByRecordID @@ -12775,190 +12700,188 @@

- + whyEntityByRecordID(dataSourceCode: string, recordId: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
dataSourceCode - string -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
dataSourceCode + string + - No - + No +
recordId - string -
recordId + string + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel -
detailLevel + SzDetailLevel + - Yes - + Yes +
featureMode - SzFeatureMode -
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean - - Yes -
withRaw - boolean -
forceMinimal + boolean + + Yes +
withRaw + boolean + - Yes - + Yes +
observe -
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -12969,7 +12892,7 @@

- Public + Public whyEntityByRecordID @@ -12977,219 +12900,217 @@

- + whyEntityByRecordID(dataSourceCode: string, recordId: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe: any, reportProgress: boolean, additionalHeaders: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDefault value
dataSourceCode - string - - No - -
recordId - string - - No - -
withRelationships - boolean - - Yes - -
withFeatureStats - boolean - - Yes - -
withInternalFeatures - boolean - - Yes -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
recordId + string + + No + +
withRelationships + boolean + + Yes + +
withFeatureStats + boolean + + Yes + +
withInternalFeatures + boolean + + Yes + +
detailLevel + SzDetailLevel + + Yes + +
featureMode + SzFeatureMode + + Yes + +
forceMinimal + boolean + + Yes + +
withRaw + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
additionalHeaders + literal type + + No + + {} +
+
+
+ Returns : Observable<any> - - - - - - detailLevel - - SzDetailLevel - - - - Yes - - - - - - - - featureMode - - SzFeatureMode - - - - Yes - - - - - - - - forceMinimal - - boolean - - - - Yes - - - - - - - - withRaw - - boolean - - - - Yes - - - - - - - - observe - - any - - - - No - - - - 'body' - - - - - reportProgress - - boolean - - - - No - - - - false - - - - - additionalHeaders - - literal type - - - - No - - - - {} - - - - - -
-
-
-
- Returns : Observable<any> - -
-
- -
+ +
+ +
@@ -13200,7 +13121,7 @@

- Public + Public whyRecords @@ -13208,272 +13129,270 @@

- + whyRecords(dataSource1: string, recordId1: string, dataSource2: string, recordId2: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -

Returns an analysis of why the records identified by the data source and record ID's in the query parameters resolved or did not resolve. +

Returns an analysis of why the records identified by the data source and record ID's in the query parameters resolved or did not resolve. This operation provides an anlysis of two records identified by data source code and record ID in respective qeury parameters resolved or did not resolve.

-
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDescription
dataSource1 - string - - No - -

The data source for the first record.

- -
recordId1 - string - - No - -

The record ID for the first record.

- -
dataSource2 - string - - No - -

The data source for the second record.

- -
recordId2 - string - - No - -

The data source for the second record.

- -
withRelationships - boolean - - Yes - -

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

- -
withFeatureStats - boolean - - Yes - -

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

- -
withInternalFeatures - boolean -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - + + + + + - + - - - - - - - + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - - - + + + + + + + - - - -
NameTypeOptionalDescription
dataSource1 + string + + No + +

The data source for the first record.

+ +
recordId1 + string + + No + +

The record ID for the first record.

+ +
dataSource2 + string + + No + +

The data source for the second record.

+ +
recordId2 + string + + No + +

The data source for the second record.

+ +
withRelationships + boolean + + Yes + +

Set to `true` to include partial information of related entities for the returned entities. This defaults to `false`.

+ +
withFeatureStats + boolean + + Yes + +

Set to `false` to suppress resolution statistics for features. This defaults to `true` for why operations.

+ +
withInternalFeatures + boolean + - Yes - + Yes + -

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

+
+

Set to `false` to suppress &quot;expressed&quot; features that are derived composite keys such as `FULL_NAME` + `DATE_OF_BIRTH`. This defaults to `true` for why operations.

-
detailLevel - SzDetailLevel -
detailLevel + SzDetailLevel + - Yes - + Yes + -

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

+
+

Specifies the level of detail desired for the entity data. Details for features of entities as well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`, and `withFeatureStats`. If not specified the value defaults to `VERBOSE`. Possible values are: * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via &quot;how&quot; and &quot;why&quot; is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user).

-
featureMode - SzFeatureMode - - Yes -
featureMode + SzFeatureMode + + Yes + -

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

-
forceMinimal - boolean - +

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `REPRESENTATIVE` - Include only a single representative value per &quot;unique&quot; value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level.

-
- Yes -
forceMinimal + boolean + + Yes + -

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

-
withRaw - boolean - +

Whether (or not) to force the minimum entity detail in the response which will consist of nothing more than an entity ID and record identifying information (i.e.: data source code and record ID) for each constituent record of an entity. Unlike `detailLevel=MINIMAL` setting this to `true` precludes the addition of feature information via other parameters. Setting this to `true` provides the fastest response to an entity query operation because no additional data needs to be retrieved other than what is directly accessible. Setting this parameter to `true` overrules other parameters governing the retrieval of features or related entities.

-
- Yes -
withRaw + boolean + + Yes + -

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

-
observe - +

Whether or not to include the raw JSON response from the underlying native API. This raw response may include additional details but lack some of the abstraction the standard response provides. If true, then the 'rawData' field in the response will be a non-null value and contain the additional details.

-
- Yes -
observe + + Yes + -

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

-
reportProgress - boolean - +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

-
- Yes -
reportProgress + boolean + + Yes + -

flag to report request and response progress.

-
additionalHeaders - literal type - +

flag to report request and response progress.

-
- Yes -
additionalHeaders + literal type + + Yes + -
-
-
-
- -
- -
+ + + + + +
+ +
+ +
@@ -13484,7 +13403,7 @@

- Public + Public whyRecords @@ -13492,214 +13411,212 @@

- + whyRecords(dataSource1: string, recordId1: string, dataSource2: string, recordId2: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
dataSource1 - string -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
dataSource1 + string + - No - + No +
recordId1 - string -
recordId1 + string + - No - + No +
dataSource2 - string -
dataSource2 + string + - No - + No +
recordId2 - string -
recordId2 + string + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel - - Yes -
featureMode - SzFeatureMode -
detailLevel + SzDetailLevel + + Yes +
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean -
forceMinimal + boolean + - Yes - + Yes +
withRaw - boolean -
withRaw + boolean + - Yes - + Yes +
observe -
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -13710,7 +13627,7 @@

- Public + Public whyRecords @@ -13718,214 +13635,212 @@

- + whyRecords(dataSource1: string, recordId1: string, dataSource2: string, recordId2: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe?, reportProgress?: boolean, additionalHeaders?: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptional
dataSource1 - string -
+ + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - - - - - - - - - + + + + + + + + + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - - - + + + + - + - - -
NameTypeOptional
dataSource1 + string + - No - + No +
recordId1 - string -
recordId1 + string + - No - + No +
dataSource2 - string -
dataSource2 + string + - No - + No +
recordId2 - string -
recordId2 + string + - No - + No +
withRelationships - boolean -
withRelationships + boolean + - Yes - + Yes +
withFeatureStats - boolean -
withFeatureStats + boolean + - Yes - + Yes +
withInternalFeatures - boolean -
withInternalFeatures + boolean + - Yes - + Yes +
detailLevel - SzDetailLevel - - Yes -
featureMode - SzFeatureMode -
detailLevel + SzDetailLevel + + Yes +
featureMode + SzFeatureMode + - Yes - + Yes +
forceMinimal - boolean -
forceMinimal + boolean + - Yes - + Yes +
withRaw - boolean -
withRaw + boolean + - Yes - + Yes +
observe -
observe + - Yes - + Yes +
reportProgress - boolean -
reportProgress + boolean + - Yes - + Yes +
additionalHeaders - literal type -
additionalHeaders + literal type + - Yes - + Yes +
-
-
-
- + -
- -
+ +
+ +
@@ -13936,7 +13851,7 @@

- Public + Public whyRecords @@ -13944,253 +13859,251 @@

- + whyRecords(dataSource1: string, recordId1: string, dataSource2: string, recordId2: string, withRelationships?: boolean, withFeatureStats?: boolean, withInternalFeatures?: boolean, detailLevel?: SzDetailLevel, featureMode?: SzFeatureMode, forceMinimal?: boolean, withRaw?: boolean, observe: any, reportProgress: boolean, additionalHeaders: literal type) - - - - - + + + + + -
- Parameters : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Parameters : + +
NameTypeOptionalDefault value
dataSource1 - string - - No - -
recordId1 - string - - No - -
dataSource2 - string - - No - -
recordId2 - string - - No - -
withRelationships - boolean - - Yes - -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSource1 + string + + No + +
recordId1 + string + + No + +
dataSource2 + string + + No + +
recordId2 + string + + No + +
withRelationships + boolean + + Yes + +
withFeatureStats + boolean + + Yes + +
withInternalFeatures + boolean + + Yes + +
detailLevel + SzDetailLevel + + Yes + +
featureMode + SzFeatureMode + + Yes + +
forceMinimal + boolean + + Yes + +
withRaw + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
additionalHeaders + literal type + + No + + {} +
+
+
+ Returns : Observable<any> - - - withFeatureStats - - boolean - - - - Yes - - - - - - - - withInternalFeatures - - boolean - - - - Yes - - - - - - - - detailLevel - - SzDetailLevel - - - - Yes - - - - - - - - featureMode - - SzFeatureMode - - - - Yes - - - - - - - - forceMinimal - - boolean - - - - Yes - - - - - - - - withRaw - - boolean - - - - Yes - - - - - - - - observe - - any - - - - No - - - - 'body' - - - - - reportProgress - - boolean - - - - No - - - - false - - - - - additionalHeaders - - literal type - - - - No - - - - {} - - - - - -
-
-
-
- Returns : Observable<any> - -
-
- -
+ +
+ +
-
+

Properties @@ -14255,7 +14168,7 @@

-
+

Accessors

@@ -14376,7 +14289,7 @@

-
+
import { Inject, Injectable, Optional }                      from '@angular/core';
 import { HttpClient, HttpHeaders, HttpParams,
          HttpResponse, HttpEvent }                           from '@angular/common/http';
@@ -15907,6 +15820,19 @@ 

No results matching " + + diff --git a/docs/injectables/EntityGraphService.html b/docs/injectables/EntityGraphService.html index 4b1bd29..e55ec84 100644 --- a/docs/injectables/EntityGraphService.html +++ b/docs/injectables/EntityGraphService.html @@ -12,10 +12,61 @@ - -

-
+

Properties @@ -2400,7 +2441,7 @@

-
+

Accessors

@@ -2521,7 +2562,7 @@

-
+
import { Inject, Injectable, Optional }                      from '@angular/core';
 import { HttpClient, HttpHeaders, HttpParams,
          HttpResponse, HttpEvent }                           from '@angular/common/http';
@@ -2865,6 +2906,19 @@ 

No results matching " + + diff --git a/docs/injectables/StatisticsService.html b/docs/injectables/StatisticsService.html new file mode 100644 index 0000000..40efc68 --- /dev/null +++ b/docs/injectables/StatisticsService.html @@ -0,0 +1,25290 @@ + + + + + + @senzing/rest-api-client-ng documentation + + + + + + + + + + + + + + +
+
+ + +
+
+ + + + + + + + + + + + +
+
+

+

File

+

+

+ projects/rest-api-client-ng/src/lib/api/statistics.service.ts +

+ + + + + +
+

Index

+ + + + + + + + + + + + + + + + + + + + + +
+
Properties
+
+ +
+
Methods
+
+ +
+
+ +
+

Constructor

+ + + + + + + + + + + + + +
+constructor(httpClient: HttpClient, basePath: string, configuration: Configuration) +
+ +
+
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
httpClient + HttpClient + + No +
basePath + string + + No +
configuration + Configuration + + No +
+
+
+
+ +
+ +

+ Methods +

+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedEntityIds + + +
+ + getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedEntityIds + + +
+ + getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedEntityIds + + +
+ + getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedEntityIds + + +
+ + getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedRelations + + +
+ + getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedRelations + + +
+ + getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedRelations + + +
+ + getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyCrossMatchedRelations + + +
+ + getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedEntityIds + + +
+ + getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having ambiguous-match relationships to other entities where each entity contains a record from the respective data source. +Gets the entity ID's of the entities having ambiguous-match relationships to other entities where each entity contains a record fron the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedEntityIds + + +
+ + getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedEntityIds + + +
+ + getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedEntityIds + + +
+ + getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedRelations + + +
+ + getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the `SzRelation` values describing the ambiguous-match relationships between entities where each entity contains a record from the respective data source. +Gets the `SzRelation` values describing the ambiguous-match relationships between entities containing a record from the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedRelations + + +
+ + getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedRelations + + +
+ + getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getAmbiguouslyMatchedRelations + + +
+ + getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceAmbiguousMatchStatistics + + +
+ + getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

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. +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzRelationCountsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceAmbiguousMatchStatistics + + +
+ + getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceAmbiguousMatchStatistics + + +
+ + getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceAmbiguousMatchStatistics + + +
+ + getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceDisclosedRelationStatistics + + +
+ + getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

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. +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzRelationCountsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceDisclosedRelationStatistics + + +
+ + getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceDisclosedRelationStatistics + + +
+ + getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceDisclosedRelationStatistics + + +
+ + getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceMatchStatistics + + +
+ + getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

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. +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzMatchCountsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceMatchStatistics + + +
+ + getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzMatchCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceMatchStatistics + + +
+ + getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzMatchCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceMatchStatistics + + +
+ + getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleMatchStatistics + + +
+ + getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

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. +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzRelationCountsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleMatchStatistics + + +
+ + getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleMatchStatistics + + +
+ + getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleMatchStatistics + + +
+ + getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleRelationStatistics + + +
+ + getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

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. +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzRelationCountsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleRelationStatistics + + +
+ + getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleRelationStatistics + + +
+ + getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzRelationCountsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourcePossibleRelationStatistics + + +
+ + getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceSummaryStatistics + + +
+ + getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+

Gets the cross-summary statistics for one data source versus another data source (which may be the same). +Gets the cross-summary statisitcs 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzCrossSourceSummaryResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceSummaryStatistics + + +
+ + getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzCrossSourceSummaryResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceSummaryStatistics + + +
+ + getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzCrossSourceSummaryResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getCrossSourceSummaryStatistics + + +
+ + getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedEntityIds + + +
+ + getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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: Data mart statistics may be slightly delayed from the entity repository.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedEntityIds + + +
+ + getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedEntityIds + + +
+ + getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedEntityIds + + +
+ + getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedRelations + + +
+ + getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the `SzRelation` values describing the disclosed 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. +Gets the `SzRelation` values describing the disclosed 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedRelations + + +
+ + getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedRelations + + +
+ + getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedCrossRelatedRelations + + +
+ + getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedEntityIds + + +
+ + getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having disclosed relationships to other entities where each entity contains a record from the respective data source. +Gets the entity ID's of the entities having disclosed relationships to other entities where each entity contains a record fron the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedEntityIds + + +
+ + getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedEntityIds + + +
+ + getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedEntityIds + + +
+ + getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedRelations + + +
+ + getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the `SzRelation` values describing the disclosed relationships between entities where each entity contains a record from the respective data source. +Gets the `SzRelation` values describing the disclosed relationships between entities containing a record from the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedRelations + + +
+ + getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedRelations + + +
+ + getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getDisclosedRelatedRelations + + +
+ + getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForCrossMatches + + +
+ + getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForCrossMatches + + +
+ + getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForCrossMatches + + +
+ + getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForCrossMatches + + +
+ + getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForDataSource + + +
+ + getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having at least one record from the respective data source. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForDataSource + + +
+ + getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForDataSource + + +
+ + getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForDataSource + + +
+ + getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntityRelations + + +
+ + getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having the specific number of entity relationships. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
relationsCount + number + + No + +

The number of relationships for the entities of interest.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntityRelations + + +
+ + getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
relationsCount + number + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntityRelations + + +
+ + getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
relationsCount + number + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntityRelations + + +
+ + getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
relationsCount + number + + No + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntitySize + + +
+ + getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having the specific number of records. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
entitySize + number + + No + +

The number of records for the entities of interest.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntitySize + + +
+ + getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
entitySize + number + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntitySize + + +
+ + getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
entitySize + number + + No +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForEntitySize + + +
+ + getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
entitySize + number + + No + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForSourceMatches + + +
+ + getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities containing two or more matched records from the respective data source. +Gets the entity ID's of the entities having at two or more matched records from the respective data source. If no entities have at least two matched records from the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForSourceMatches + + +
+ + getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForSourceMatches + + +
+ + getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityIdsForSourceMatches + + +
+ + getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsBreakdown + + +
+ + getEntityRelationsBreakdown(observe?, reportProgress?: boolean) +
+ +
+

Gets the entity counts by the number of entity relations (Entity Relation Breakdown). +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzEntityRelationsBreakdownResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsBreakdown + + +
+ + getEntityRelationsBreakdown(observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzEntityRelationsBreakdownResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsBreakdown + + +
+ + getEntityRelationsBreakdown(observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzEntityRelationsBreakdownResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsBreakdown + + +
+ + getEntityRelationsBreakdown(observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsCount + + +
+ + getEntityRelationsCount(relationsCount: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the count of entities having the specific number of entity relations. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
relationsCount + number + + No + +

The number of relationships for the entities of interest.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzEntityRelationsCountResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsCount + + +
+ + getEntityRelationsCount(relationsCount: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
relationsCount + number + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzEntityRelationsCountResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsCount + + +
+ + getEntityRelationsCount(relationsCount: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
relationsCount + number + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzEntityRelationsCountResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntityRelationsCount + + +
+ + getEntityRelationsCount(relationsCount: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
relationsCount + number + + No + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeBreakdown + + +
+ + getEntitySizeBreakdown(observe?, reportProgress?: boolean) +
+ +
+

Gets the entity counts by entity size (Entity Size Breakdown). +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzEntitySizeBreakdownResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeBreakdown + + +
+ + getEntitySizeBreakdown(observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzEntitySizeBreakdownResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeBreakdown + + +
+ + getEntitySizeBreakdown(observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzEntitySizeBreakdownResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeBreakdown + + +
+ + getEntitySizeBreakdown(observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeCount + + +
+ + getEntitySizeCount(entitySize: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the count of entities having the specific number of records. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
entitySize + number + + No + +

The number of records for the entities of interest.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzEntitySizeCountResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeCount + + +
+ + getEntitySizeCount(entitySize: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
entitySize + number + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzEntitySizeCountResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeCount + + +
+ + getEntitySizeCount(entitySize: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
entitySize + number + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzEntitySizeCountResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getEntitySizeCount + + +
+ + getEntitySizeCount(entitySize: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
entitySize + number + + No + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getLoadedStatistics + + +
+ + getLoadedStatistics(onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity and record counts in total and by data source from the data mart. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
onlyLoadedSources + boolean + + Yes + +

The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to `true`. Set this explicitly to `false` to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the &quot;zeroes&quot;).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzLoadedStatsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getLoadedStatistics + + +
+ + getLoadedStatistics(onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzLoadedStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getLoadedStatistics + + +
+ + getLoadedStatistics(onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzLoadedStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getLoadedStatistics + + +
+ + getLoadedStatistics(onlyLoadedSources?: boolean, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
onlyLoadedSources + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedEntityIds + + +
+ + getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedEntityIds + + +
+ + getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedEntityIds + + +
+ + getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedEntityIds + + +
+ + getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedRelations + + +
+ + getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedRelations + + +
+ + getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedRelations + + +
+ + getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossMatchedRelations + + +
+ + getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedEntityIds + + +
+ + getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedEntityIds + + +
+ + getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedEntityIds + + +
+ + getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedEntityIds + + +
+ + getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedRelations + + +
+ + getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

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. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
vsDataSourceCode + string + + No + +

The data source code identifying the data source to which the first data source is compared for the statistics.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedRelations + + +
+ + getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedRelations + + +
+ + getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
vsDataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyCrossRelatedRelations + + +
+ + getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
vsDataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedEntityIds + + +
+ + getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having possible-match relationships to other entities where each entity contains a record from the respective data source. +Gets the entity ID's of the entities having possible-match relationships to other entities where each entity contains a record fron the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedEntityIds + + +
+ + getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedEntityIds + + +
+ + getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedEntityIds + + +
+ + getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedRelations + + +
+ + getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the `SzRelation` values describing the possible-match relationships between entities where each entity contains a record from the respective data source. +Gets the `SzRelation` values describing the possible-match relationships between entities containing a record from the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedRelations + + +
+ + getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedRelations + + +
+ + getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyMatchedRelations + + +
+ + getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedEntityIds + + +
+ + getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity ID's of the entities having possible relationships to other entities where each entity contains a record from the respective data source. +Gets the entity ID's of the entities having possible relationships to other entities where each entity contains a record fron the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + number + + Yes + +

The optional parameter to provide for &quot;paging&quot; through entity ID's associated with a statistic. The value is specified as bound on the entity ID values returned. The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the &quot;next page&quot; of entity ID's specify the greatest entity ID value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of entity ID's specify the least entity ID value on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least entity ID value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedEntityIds + + +
+ + getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedEntityIds + + +
+ + getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + number + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedEntityIds + + +
+ + getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + number + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedRelations + + +
+ + getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+

Gets the `SzRelation` values describing the possible relationships between entities where each entity contains a record from the respective data source. +Gets the `SzRelation` values describing the possible relationships between entities containing a record from the respective 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 the 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify the match key for which the results are being requested.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the results are being requested.

+ +
bound + string + + Yes + +

The optional parameter to provide for &quot;paging&quot; through relationships associated with a statistic. The value is specified as bound on the entity ID's in the `SzRelation` values returned and contains two entity ID values separated by a colon (e.g.: `1000:5500`). The type of bound is given by the `boundType` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned `SzRelation` values must be canonically greater than the relationship described by the entity ID values encoded in the bound. `SzRelation` values are ordered on the first entity ID value and then on the second related entity ID value. To move to the &quot;next page&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and use `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) `SzRelation` on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value.

+ +
boundType + SzBoundType + + Yes + +

The optional parameter to provide for &quot;paging&quot; through results associated with a statistic. The value is specified as an `SzBoundType` and the bound value is given by the `bound` parameter. For example, by default the `boundType` is `EXCLUSIVE_LOWER` so the returned values must satisfy the condition that they are strictly greater than the bound value. To move to the &quot;next page&quot; of results specify the greatest result value from the current page and use `boundType` of `EXCLUSIVE_LOWER`. To move to the &quot;previous page&quot; of results specify the least result value on the current page and use a `boundType` of `EXCLUSIVE_UPPER`. To change the number of results shown on the current page specify the least result value on the current page and specify a `boundType` of `INCLUSIVE_LOWER` with a new `pageSize` value. Possible values are: * `INCLUSIVE_LOWER` - The bound represents an inclusive lower bound whereby values satisifying the bound will be greater-than or equal to the value associated with the bound. * `EXCLUSIVE_LOWER` - The bound represents an exclusive lower bound whereby values satisfying the bound will be strictly greater-than the value associated with the bound. * `INCLUSIVE_UPPER` - The bound represents an inclusive upper bound whereby values satisifying the bound will be less-than or equal to the value associated with the bound. * `EXCLUSIVE_UPPER` - The bound represents an exclusive upper bound whereby values satisfying the bound will be strictly less-than the value associated with the bound.

+ +
pageSize + number + + Yes + +

The optional parameter to limit the number of returned results per page. If not specified then a default value is determined. If the `sampleSize` parameter is provided, then this defaults to 20 times the value of the `sampleSize` parameter. If the `sampleSize` parameter is not provided then this simply defaults to `100`. If using the `sampleSize` query parameter and specifying a value for the `pageSize` then the `pageSize` should be greater than the `sampleSize` by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample. For example, a `pageSize` of `1000` would be appropriate for a `sampleSize` of `50` or `100`.

+ +
sampleSize + number + + Yes + +

The optional parameter to extract a sample of this size from the page of results being returned. When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a random sample (e.g.: 50 to 100). To obtain another sample with no overlap with the previous sample(s), simply change the `bound` and `boundType` parameter so the eligible results for the page are outside the range of the previous sample(s). The value of this parameter should be less-than the specified `pageSize` query parameter (typically by at least an order of magnitude).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedRelations + + +
+ + getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedRelations + + +
+ + getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
bound + string + + Yes +
boundType + SzBoundType + + Yes +
pageSize + number + + Yes +
sampleSize + number + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getPossiblyRelatedRelations + + +
+ + getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
bound + string + + Yes + +
boundType + SzBoundType + + Yes + +
pageSize + number + + Yes + +
sampleSize + number + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceLoadedStatistics + + +
+ + getSourceLoadedStatistics(dataSourceCode: string, observe?, reportProgress?: boolean) +
+ +
+

Gets the entity and record counts for a specific data source from the data mart. +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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzSourceLoadedStatsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceLoadedStatistics + + +
+ + getSourceLoadedStatistics(dataSourceCode: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzSourceLoadedStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceLoadedStatistics + + +
+ + getSourceLoadedStatistics(dataSourceCode: string, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzSourceLoadedStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceLoadedStatistics + + +
+ + getSourceLoadedStatistics(dataSourceCode: string, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceSummaryStatistics + + +
+ + getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+

Gets the summary statistics for a specific data source versus every other data source including itself. +Gets the summary statisitcs for a specific data source versus every other data source including itsef. 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.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
dataSourceCode + string + + No + +

The data source code identifying the data source.

+ +
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
onlyLoadedSources + boolean + + Yes + +

The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to `true`. Set this explicitly to `false` to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the &quot;zeroes&quot;).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzSourceSummaryResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceSummaryStatistics + + +
+ + getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzSourceSummaryResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceSummaryStatistics + + +
+ + getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
dataSourceCode + string + + No +
matchKey + string + + Yes +
principle + string + + Yes +
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzSourceSummaryResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSourceSummaryStatistics + + +
+ + getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
dataSourceCode + string + + No + +
matchKey + string + + Yes + +
principle + string + + Yes + +
onlyLoadedSources + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSummaryStatistics + + +
+ + getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+

Gets the summary statistics for each data source versus every other data source including itself. +Gets the summary statisitcs for each data source versus every other data source including itsef. NOTE: Data mart statistics may be slightly delayed from the entity repository.

+
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
matchKey + string + + Yes + +

The optional parameter to specify a match key for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all match keys should be returned.

+ +
principle + string + + Yes + +

The optional parameter to specify a principle for which the statistics are being requested. Specify an asterisk (`*`) if the statistics for all principles should be returned.

+ +
onlyLoadedSources + boolean + + Yes + +

The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to `true`. Set this explicitly to `false` to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the &quot;zeroes&quot;).

+ +
observe + + Yes + +

set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

+ +
reportProgress + boolean + + Yes + +

flag to report request and response progress.

+ +
+
+
+ Returns : Observable<SzSummaryStatsResponse> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSummaryStatistics + + +
+ + getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
matchKey + string + + Yes +
principle + string + + Yes +
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpResponse<SzSummaryStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSummaryStatistics + + +
+ + getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?, reportProgress?: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptional
matchKey + string + + Yes +
principle + string + + Yes +
onlyLoadedSources + boolean + + Yes +
observe + + Yes +
reportProgress + boolean + + Yes +
+
+
+ Returns : Observable<HttpEvent<SzSummaryStatsResponse>> + +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ + + Public + getSummaryStatistics + + +
+ + getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe: any, reportProgress: boolean) +
+ +
+ +
+ Parameters : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDefault value
matchKey + string + + Yes + +
principle + string + + Yes + +
onlyLoadedSources + boolean + + Yes + +
observe + any + + No + + 'body' +
reportProgress + boolean + + No + + false +
+
+
+ Returns : Observable<any> + +
+
+ +
+
+
+
+ +

+ Properties +

+ + + + + + + + + + + + + + + + + +
+ + + Protected + basePath + + +
+ Type : string + +
+ Default value : 'http://localhost:8250' +
+ +
+ + + + + + + + + + + + + + +
+ + + Public + configuration + + +
+ Default value : new Configuration() +
+ +
+ + + + + + + + + + + + + + +
+ + + Public + defaultHeaders + + +
+ Default value : new HttpHeaders() +
+ +
+
+ +
+ + +
+
import { Inject, Injectable, Optional }                      from '@angular/core';
+ import { HttpClient, HttpHeaders, HttpParams,
+          HttpResponse, HttpEvent }                           from '@angular/common/http';
+ import { CustomHttpUrlEncodingCodec }                        from '../encoder';
+ 
+ import { Observable }                                        from 'rxjs';
+ 
+ import { SzBoundType } from '../model/szBoundType';
+ import { SzCrossSourceSummaryResponse } from '../model/szCrossSourceSummaryResponse';
+ import { SzEntityRelationsBreakdownResponse } from '../model/szEntityRelationsBreakdownResponse';
+ import { SzEntityRelationsCountResponse } from '../model/szEntityRelationsCountResponse';
+ import { SzEntitySizeBreakdownResponse } from '../model/szEntitySizeBreakdownResponse';
+ import { SzEntitySizeCountResponse } from '../model/szEntitySizeCountResponse';
+ import { SzErrorResponse } from '../model/szErrorResponse';
+ import { SzLoadedStatsResponse } from '../model/szLoadedStatsResponse';
+ import { SzMatchCountsResponse } from '../model/szMatchCountsResponse';
+ import { SzPagedEntitiesResponse } from '../model/szPagedEntitiesResponse';
+ import { SzPagedRelationsResponse } from '../model/szPagedRelationsResponse';
+ import { SzRelationCountsResponse } from '../model/szRelationCountsResponse';
+ import { SzSourceLoadedStatsResponse } from '../model/szSourceLoadedStatsResponse';
+ import { SzSourceSummaryResponse } from '../model/szSourceSummaryResponse';
+ import { SzSummaryStatsResponse } from '../model/szSummaryStatsResponse';
+ 
+ import { BASE_PATH, COLLECTION_FORMATS }                     from '../variables';
+ import { Configuration }                                     from '../configuration';
+ 
+ 
+ @Injectable()
+ export class StatisticsService {
+ 
+     protected basePath = 'http://localhost:8250';
+     public defaultHeaders = new HttpHeaders();
+     public configuration = new Configuration();
+ 
+     constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: Configuration) {
+         if (basePath) {
+             this.basePath = basePath;
+         }
+         if (configuration) {
+             this.configuration = configuration;
+             this.basePath = basePath || configuration.basePath || this.basePath;
+         }
+     }
+ 
+     /**
+      * @param consumes string[] mime-types
+      * @return true: consumes contains 'multipart/form-data', false: otherwise
+      */
+     private canConsumeForm(consumes: string[]): boolean {
+         const form = 'multipart/form-data';
+         for (const consume of consumes) {
+             if (form === consume) {
+                 return true;
+             }
+         }
+         return false;
+     }
+ 
+ 
+     /**
+      * Gets the entity ID&#x27;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.
+      * Gets the entity ID&#x27;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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getAmbiguouslyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getAmbiguouslyCrossMatchedEntityIds.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getAmbiguouslyCrossMatchedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/ambiguous-matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; 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.
+      * Gets the &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getAmbiguouslyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getAmbiguouslyCrossMatchedRelations.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getAmbiguouslyCrossMatchedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/ambiguous-matches/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having ambiguous-match relationships to other entities where each entity contains a record from the respective data source.
+      * Gets the entity ID&#x27;s of the entities having ambiguous-match relationships to other entities where each entity contains a record fron the respective  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 the 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getAmbiguouslyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getAmbiguouslyMatchedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/ambiguous-matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; values describing the ambiguous-match relationships between entities where each entity contains a record from the respective data source.
+      * Gets the &#x60;SzRelation&#x60; values describing the ambiguous-match relationships between entities containing a record from the respective data source.  If there are no such relationships then this will return a 200 OK response that will have an empty array of &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; array contained in the response will be empty.  However, if the 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getAmbiguouslyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getAmbiguouslyMatchedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/ambiguous-matches/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * 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.
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzRelationCountsResponse>;
+     public getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzRelationCountsResponse>>;
+     public getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzRelationCountsResponse>>;
+     public getCrossSourceAmbiguousMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourceAmbiguousMatchStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourceAmbiguousMatchStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzRelationCountsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/ambiguous-matches`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * 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.
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzRelationCountsResponse>;
+     public getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzRelationCountsResponse>>;
+     public getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzRelationCountsResponse>>;
+     public getCrossSourceDisclosedRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourceDisclosedRelationStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourceDisclosedRelationStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzRelationCountsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/disclosed-relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * 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.
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzMatchCountsResponse>;
+     public getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzMatchCountsResponse>>;
+     public getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzMatchCountsResponse>>;
+     public getCrossSourceMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourceMatchStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourceMatchStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzMatchCountsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/matches`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * 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.
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzRelationCountsResponse>;
+     public getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzRelationCountsResponse>>;
+     public getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzRelationCountsResponse>>;
+     public getCrossSourcePossibleMatchStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourcePossibleMatchStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourcePossibleMatchStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzRelationCountsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-matches`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * 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.
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzRelationCountsResponse>;
+     public getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzRelationCountsResponse>>;
+     public getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzRelationCountsResponse>>;
+     public getCrossSourcePossibleRelationStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourcePossibleRelationStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourcePossibleRelationStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzRelationCountsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the cross-summary statistics for one data source versus another data source (which may be the same).
+      * Gets the cross-summary statisitcs 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'body', reportProgress?: boolean): Observable<SzCrossSourceSummaryResponse>;
+     public getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzCrossSourceSummaryResponse>>;
+     public getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzCrossSourceSummaryResponse>>;
+     public getCrossSourceSummaryStatistics(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getCrossSourceSummaryStatistics.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getCrossSourceSummaryStatistics.');
+         }
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzCrossSourceSummaryResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;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.
+      * Gets the entity ID&#x27;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*: Data mart statistics may be slightly delayed from the entity repository.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getDisclosedCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getDisclosedCrossRelatedEntityIds.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getDisclosedCrossRelatedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/disclosed-relations/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; values describing the disclosed 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.
+      * Gets the &#x60;SzRelation&#x60; values describing the disclosed 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 &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getDisclosedCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getDisclosedCrossRelatedRelations.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getDisclosedCrossRelatedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/disclosed-relations/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having disclosed relationships to other entities where each entity contains a record from the respective data source.
+      * Gets the entity ID&#x27;s of the entities having disclosed relationships to other entities where each entity contains a record fron the respective 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 the 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getDisclosedRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getDisclosedRelatedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/disclosed-relations/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; values describing the disclosed relationships between entities where each entity contains a record from the respective data source.
+      * Gets the &#x60;SzRelation&#x60; values describing the disclosed relationships between entities containing a record from the respective data source.  If there are no such relationships then this will return a 200 OK response that will have an empty array of &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; array contained in the response will be empty. However, if the 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getDisclosedRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getDisclosedRelatedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/disclosed-relations/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;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.
+      * Gets the entity ID&#x27;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&#x27;s rather than giving a 404 Not Found response.  Further, if there are no entity ID&#x27;s for entities satisfying the bound conditions of the request then similarly a 200 OK response is returned but the array of ID&#x27;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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getEntityIdsForCrossMatches(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getEntityIdsForCrossMatches.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getEntityIdsForCrossMatches.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having at least one record from the respective data source.
+      * Gets the entity ID&#x27;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&#x27;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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getEntityIdsForDataSource(dataSourceCode: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getEntityIdsForDataSource.');
+         }
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/loaded/data-sources/${encodeURIComponent(String(dataSourceCode))}/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having the specific number of entity relationships.
+      * Gets the entity ID&#x27;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&#x27;s rather than giving a 404 Not Found response.  Further, if there are no entity ID&#x27;s for entities satisfying the bound conditions of the request then similarly a 200 OK response is returned but the array of ID&#x27;s contained in the response will be empty.  *NOTE*: Data mart statistics may be slightly delayed from the entity repository.        
+      * @param relationsCount The number of relationships for the entities of interest.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getEntityIdsForEntityRelations(relationsCount: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (relationsCount === null || relationsCount === undefined) {
+             throw new Error('Required parameter relationsCount was null or undefined when calling getEntityIdsForEntityRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/relations/${encodeURIComponent(String(relationsCount))}/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having the specific number of records.
+      * Gets the entity ID&#x27;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&#x27;s rather than giving a 404 Not Found response.  Further, if there are no entity ID&#x27;s for entities satisfying the bound conditions of the request then similarly a 200 OK response is returned but the array of ID&#x27;s contained in the response will be empty.  *NOTE*: Data mart statistics may be slightly delayed from the entity repository.        
+      * @param entitySize The number of records for the entities of interest.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getEntityIdsForEntitySize(entitySize: number, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (entitySize === null || entitySize === undefined) {
+             throw new Error('Required parameter entitySize was null or undefined when calling getEntityIdsForEntitySize.');
+         }
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/sizes/${encodeURIComponent(String(entitySize))}/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities containing two or more matched records from the respective data source.
+      * Gets the entity ID&#x27;s of the entities having at two or more matched records  from the respective data source.  If no entities have at least two matched records from the respective data source then this will return a 200 OK  response that will have an empty array of entity ID&#x27;s rather than giving a 404 Not Found response.  Further, if there are no entity ID&#x27;s for entities satisfying the bound conditions of the request then similarly a 200 OK response is returned but the array of ID&#x27;s contained in the response will be empty.  However, if the 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getEntityIdsForSourceMatches(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getEntityIdsForSourceMatches.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity counts by the number of entity relations (Entity  Relation Breakdown).
+      * 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.
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityRelationsBreakdown(observe?: 'body', reportProgress?: boolean): Observable<SzEntityRelationsBreakdownResponse>;
+     public getEntityRelationsBreakdown(observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzEntityRelationsBreakdownResponse>>;
+     public getEntityRelationsBreakdown(observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzEntityRelationsBreakdownResponse>>;
+     public getEntityRelationsBreakdown(observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzEntityRelationsBreakdownResponse>('get',`${this.basePath}/statistics/relations`,
+             {
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the count of entities having the specific number of entity relations.
+      * 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.
+      * @param relationsCount The number of relationships for the entities of interest.
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntityRelationsCount(relationsCount: number, observe?: 'body', reportProgress?: boolean): Observable<SzEntityRelationsCountResponse>;
+     public getEntityRelationsCount(relationsCount: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzEntityRelationsCountResponse>>;
+     public getEntityRelationsCount(relationsCount: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzEntityRelationsCountResponse>>;
+     public getEntityRelationsCount(relationsCount: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (relationsCount === null || relationsCount === undefined) {
+             throw new Error('Required parameter relationsCount was null or undefined when calling getEntityRelationsCount.');
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzEntityRelationsCountResponse>('get',`${this.basePath}/statistics/relations/${encodeURIComponent(String(relationsCount))}`,
+             {
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity counts by entity size (Entity Size Breakdown).
+      * 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.
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntitySizeBreakdown(observe?: 'body', reportProgress?: boolean): Observable<SzEntitySizeBreakdownResponse>;
+     public getEntitySizeBreakdown(observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzEntitySizeBreakdownResponse>>;
+     public getEntitySizeBreakdown(observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzEntitySizeBreakdownResponse>>;
+     public getEntitySizeBreakdown(observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzEntitySizeBreakdownResponse>('get',`${this.basePath}/statistics/sizes`,
+             {
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the count of entities having the specific number of records.
+      * 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.
+      * @param entitySize The number of records for the entities of interest.
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getEntitySizeCount(entitySize: number, observe?: 'body', reportProgress?: boolean): Observable<SzEntitySizeCountResponse>;
+     public getEntitySizeCount(entitySize: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzEntitySizeCountResponse>>;
+     public getEntitySizeCount(entitySize: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzEntitySizeCountResponse>>;
+     public getEntitySizeCount(entitySize: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (entitySize === null || entitySize === undefined) {
+             throw new Error('Required parameter entitySize was null or undefined when calling getEntitySizeCount.');
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzEntitySizeCountResponse>('get',`${this.basePath}/statistics/sizes/${encodeURIComponent(String(entitySize))}`,
+             {
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity and record counts in total and by data source from the data mart.
+      * 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.
+      * @param onlyLoadedSources The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to &#x60;true&#x60;.  Set this explicitly to &#x60;false&#x60; to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the \&quot;zeroes\&quot;).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getLoadedStatistics(onlyLoadedSources?: boolean, observe?: 'body', reportProgress?: boolean): Observable<SzLoadedStatsResponse>;
+     public getLoadedStatistics(onlyLoadedSources?: boolean, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzLoadedStatsResponse>>;
+     public getLoadedStatistics(onlyLoadedSources?: boolean, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzLoadedStatsResponse>>;
+     public getLoadedStatistics(onlyLoadedSources?: boolean, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (onlyLoadedSources !== undefined && onlyLoadedSources !== null) {
+             queryParameters = queryParameters.set('onlyLoadedSources', <any>onlyLoadedSources);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzLoadedStatsResponse>('get',`${this.basePath}/statistics/loaded`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;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.
+      * Gets the entity ID&#x27;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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getPossiblyCrossMatchedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyCrossMatchedEntityIds.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getPossiblyCrossMatchedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; 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.
+      * Gets the &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getPossiblyCrossMatchedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyCrossMatchedRelations.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getPossiblyCrossMatchedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-matches/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;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.
+      * Gets the entity ID&#x27;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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getPossiblyCrossRelatedEntityIds(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyCrossRelatedEntityIds.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getPossiblyCrossRelatedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-relations/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; 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.
+      * Gets the &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param vsDataSourceCode The data source code identifying the data source to which the first data source is compared for the statistics.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getPossiblyCrossRelatedRelations(dataSourceCode: string, vsDataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyCrossRelatedRelations.');
+         }
+ 
+         if (vsDataSourceCode === null || vsDataSourceCode === undefined) {
+             throw new Error('Required parameter vsDataSourceCode was null or undefined when calling getPossiblyCrossRelatedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/vs/${encodeURIComponent(String(vsDataSourceCode))}/possible-relations/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having possible-match relationships to other entities where each entity contains a record from the respective data source.
+      * Gets the entity ID&#x27;s of the entities having possible-match relationships to other entities where each entity contains a record fron the respective  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 the 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getPossiblyMatchedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyMatchedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/possible-matches/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; values describing the possible-match relationships between entities where each entity contains a record from the respective data source.
+      * Gets the &#x60;SzRelation&#x60; values describing the possible-match relationships between entities containing a record from the respective data source.  If there are no such relationships then this will return a 200 OK response that will have an empty array of &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; array contained in the response will be empty.  However, if the 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.        
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getPossiblyMatchedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyMatchedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/possible-matches/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity ID&#x27;s of the entities having possible relationships to other entities where each entity contains a record from the respective data source.
+      * Gets the entity ID&#x27;s of the entities having possible relationships to other entities where each entity contains a record fron the respective 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 the 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through entity ID&#x27;s associated with a statistic.  The value is specified as bound on the entity ID values returned.  The type of bound is given by the  &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned entity ID values must satisfy the condition that they are strictly greater than the entity ID bound value. To move to the \&quot;next page\&quot; of entity ID&#x27;s specify the greatest entity ID value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;. To move to the \&quot;previous page\&quot; of entity ID&#x27;s specify the least entity ID value on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least entity ID value on the current page and specify a &#x60;boundType&#x60; of  &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedEntitiesResponse>;
+     public getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedEntitiesResponse>>;
+     public getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedEntitiesResponse>>;
+     public getPossiblyRelatedEntityIds(dataSourceCode: string, matchKey?: string, principle?: string, bound?: number, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyRelatedEntityIds.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedEntitiesResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/possible-relations/entities`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the &#x60;SzRelation&#x60; values describing the possible relationships between entities where each entity contains a record from the respective data source.
+      * Gets the &#x60;SzRelation&#x60; values describing the possible relationships between entities containing a record from the respective data source.  If there are no such relationships then this will return a 200 OK response that will have an empty array of &#x60;SzRelation&#x60; 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 &#x60;SzRelation&#x60; array contained in the response will be empty. However, if the 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify the match key for which the results are being requested.
+      * @param principle The optional parameter to specify a principle for which the results are being requested.
+      * @param bound The optional parameter to provide for \&quot;paging\&quot; through relationships associated with a statistic.  The value is specified as bound on the entity ID&#x27;s in the &#x60;SzRelation&#x60; values returned and contains two  entity ID values separated by a colon (e.g.: &#x60;1000:5500&#x60;).  The type of bound is given by the &#x60;boundType&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned &#x60;SzRelation&#x60; values must be canonically greater than the relationship described by the  entity ID values encoded in the bound.  &#x60;SzRelation&#x60; values are ordered  on the first entity ID value and then on the second related entity ID value.  To move to the \&quot;next page\&quot; of relationships specify the encoded value of the entity ID and related ID of the greatest (last) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the \&quot;previous page\&quot; of relationships specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the encoded value of the entity ID and related ID of the least (first) &#x60;SzRelation&#x60; on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.
+      * @param boundType The optional parameter to provide for \&quot;paging\&quot; through results associated with a statistic.  The value is specified as an &#x60;SzBoundType&#x60; and the  bound value is given by the &#x60;bound&#x60; parameter.  For example, by default the &#x60;boundType&#x60; is &#x60;EXCLUSIVE_LOWER&#x60; so the returned values must satisfy the condition that they are strictly greater than the bound value.  To move to the \&quot;next page\&quot; of results specify the greatest result value from the current page and use &#x60;boundType&#x60; of &#x60;EXCLUSIVE_LOWER&#x60;.  To move to the  \&quot;previous page\&quot; of results specify the least result value on the current page and use a &#x60;boundType&#x60; of &#x60;EXCLUSIVE_UPPER&#x60;.  To change the number of results shown on the current page specify the least result value on the current page and specify a &#x60;boundType&#x60; of &#x60;INCLUSIVE_LOWER&#x60; with a new &#x60;pageSize&#x60; value.  Possible values are:   * &#x60;INCLUSIVE_LOWER&#x60; - The bound represents an inclusive lower bound whereby                         values satisifying the bound will be greater-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_LOWER&#x60; - The bound represents an exclusive lower bound whereby                          values satisfying the bound will be strictly greater-than                          the value associated with the bound.   * &#x60;INCLUSIVE_UPPER&#x60; - The bound represents an inclusive upper bound whereby                         values satisifying the bound will be less-than or equal                         to the value associated with the bound.   * &#x60;EXCLUSIVE_UPPER&#x60; - The bound represents an exclusive upper bound whereby                          values satisfying the bound will be strictly less-than                          the value associated with the bound.
+      * @param pageSize The optional parameter to limit the number of returned results per page. If not specified then a default value is determined.  If the &#x60;sampleSize&#x60; parameter is provided, then this defaults to 20 times the value of the  &#x60;sampleSize&#x60; parameter.  If the &#x60;sampleSize&#x60; parameter is **not** provided then this simply defaults to &#x60;100&#x60;.  If using the &#x60;sampleSize&#x60; query  parameter and specifying a value for the &#x60;pageSize&#x60; then the &#x60;pageSize&#x60;  should be greater than the &#x60;sampleSize&#x60; by at least an order of magnitude in order tp provide an adequate set of results from which to choose a random sample.  For example, a &#x60;pageSize&#x60; of &#x60;1000&#x60; would be appropriate for a  &#x60;sampleSize&#x60; of &#x60;50&#x60; or &#x60;100&#x60;.
+      * @param sampleSize The optional parameter to extract a sample of this size from the page of  results being returned.  When using this parameter the caller should typically use a much larger page size (e.g.: 1000 or 5000) and pull a  random sample (e.g.: 50 to 100).  To obtain another sample with no overlap with the previous sample(s), simply change the &#x60;bound&#x60; and &#x60;boundType&#x60; parameter so the eligible results for the page are outside the range of the previous sample(s).  The value of this parameter should be less-than the specified &#x60;pageSize&#x60; query parameter (typically by at least an order of magnitude).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'body', reportProgress?: boolean): Observable<SzPagedRelationsResponse>;
+     public getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzPagedRelationsResponse>>;
+     public getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzPagedRelationsResponse>>;
+     public getPossiblyRelatedRelations(dataSourceCode: string, matchKey?: string, principle?: string, bound?: string, boundType?: SzBoundType, pageSize?: number, sampleSize?: number, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getPossiblyRelatedRelations.');
+         }
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (bound !== undefined && bound !== null) {
+             queryParameters = queryParameters.set('bound', <any>bound);
+         }
+         if (boundType !== undefined && boundType !== null) {
+             queryParameters = queryParameters.set('boundType', <any>boundType);
+         }
+         if (pageSize !== undefined && pageSize !== null) {
+             queryParameters = queryParameters.set('pageSize', <any>pageSize);
+         }
+         if (sampleSize !== undefined && sampleSize !== null) {
+             queryParameters = queryParameters.set('sampleSize', <any>sampleSize);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzPagedRelationsResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}/possible-relations/relations`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the entity and record counts for a specific data source from the data mart.
+      * 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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getSourceLoadedStatistics(dataSourceCode: string, observe?: 'body', reportProgress?: boolean): Observable<SzSourceLoadedStatsResponse>;
+     public getSourceLoadedStatistics(dataSourceCode: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzSourceLoadedStatsResponse>>;
+     public getSourceLoadedStatistics(dataSourceCode: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzSourceLoadedStatsResponse>>;
+     public getSourceLoadedStatistics(dataSourceCode: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getSourceLoadedStatistics.');
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzSourceLoadedStatsResponse>('get',`${this.basePath}/statistics/loaded/data-sources/${encodeURIComponent(String(dataSourceCode))}`,
+             {
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the summary statistics for a specific data source versus every other data source including itself.
+      * Gets the summary statisitcs for a specific data source versus every other data source including itsef.  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.
+      * @param dataSourceCode The data source code identifying the data source.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param onlyLoadedSources The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to &#x60;true&#x60;.  Set this explicitly to &#x60;false&#x60; to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the \&quot;zeroes\&quot;).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'body', reportProgress?: boolean): Observable<SzSourceSummaryResponse>;
+     public getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzSourceSummaryResponse>>;
+     public getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzSourceSummaryResponse>>;
+     public getSourceSummaryStatistics(dataSourceCode: string, matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+         if (dataSourceCode === null || dataSourceCode === undefined) {
+             throw new Error('Required parameter dataSourceCode was null or undefined when calling getSourceSummaryStatistics.');
+         }
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (onlyLoadedSources !== undefined && onlyLoadedSources !== null) {
+             queryParameters = queryParameters.set('onlyLoadedSources', <any>onlyLoadedSources);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzSourceSummaryResponse>('get',`${this.basePath}/statistics/summary/data-sources/${encodeURIComponent(String(dataSourceCode))}`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+     /**
+      * Gets the summary statistics for each data source versus every other  data source including itself.
+      * Gets the summary statisitcs for each data source versus every other data source including itsef.  *NOTE*: Data mart statistics may be slightly delayed from the entity repository.
+      * @param matchKey The optional parameter to specify a match key for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all match keys should be returned. 
+      * @param principle The optional parameter to specify a principle for which the statistics are being requested.  Specify an asterisk (&#x60;*&#x60;) if the statistics for  all principles should be returned. 
+      * @param onlyLoadedSources The optional parameter to specify if only loaded data sources should be considered when iterating over data sources to retrieve statistics. If not specified, this defaults to &#x60;true&#x60;.  Set this explicitly to &#x60;false&#x60; to iterate over all data sources regardless of loaded records in generating the statistics (i.e.: to include the \&quot;zeroes\&quot;).
+      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+      * @param reportProgress flag to report request and response progress.
+      */
+     public getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'body', reportProgress?: boolean): Observable<SzSummaryStatsResponse>;
+     public getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<SzSummaryStatsResponse>>;
+     public getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<SzSummaryStatsResponse>>;
+     public getSummaryStatistics(matchKey?: string, principle?: string, onlyLoadedSources?: boolean, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ 
+ 
+ 
+ 
+         let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()});
+         if (matchKey !== undefined && matchKey !== null) {
+             queryParameters = queryParameters.set('matchKey', <any>matchKey);
+         }
+         if (principle !== undefined && principle !== null) {
+             queryParameters = queryParameters.set('principle', <any>principle);
+         }
+         if (onlyLoadedSources !== undefined && onlyLoadedSources !== null) {
+             queryParameters = queryParameters.set('onlyLoadedSources', <any>onlyLoadedSources);
+         }
+ 
+         let headers = this.defaultHeaders;
+ 
+         // to determine the Accept header
+         let httpHeaderAccepts: string[] = [
+             'application/json; charset=UTF-8',
+             'application/json',
+             'default'
+         ];
+         const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+         if (httpHeaderAcceptSelected != undefined) {
+             headers = headers.set('Accept', httpHeaderAcceptSelected);
+         }
+ 
+         // to determine the Content-Type header
+         const consumes: string[] = [
+         ];
+ 
+         return this.httpClient.request<SzSummaryStatsResponse>('get',`${this.basePath}/statistics/summary`,
+             {
+                 params: queryParameters,
+                 withCredentials: this.configuration.withCredentials,
+                 headers: headers,
+                 observe: observe,
+                 reportProgress: reportProgress
+             }
+         );
+     }
+ 
+ }
+ 
+
+ +
+ + + + + + + + + + + + + +
+
+

results matching ""

+
    +
    +
    +

    No results matching ""

    +
    +
    +
    + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/interfaces/BulkdataAnalyzeBody.html b/docs/interfaces/BulkdataAnalyzeBody.html index d082710..79d1601 100644 --- a/docs/interfaces/BulkdataAnalyzeBody.html +++ b/docs/interfaces/BulkdataAnalyzeBody.html @@ -12,10 +12,61 @@ - -