ignoreEventsInStreaming: 'true'
forceIgnoreInStreaming: 'false'
dependedTasksIds: 0ee6035a-c9f9-4ea3-823e-c730476a9db4
currentState: {}
duration: 0s
dependsOnTasksIds: 0ee6035a-c9f9-4ea3-823e-c730476a9db4
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Cleanse%20Jobs/cleanseByTenant
/services/reltio/api/{tenantId}/cleanupMatches:
post:
tags:
- Match Jobs
summary: >-
A background job which is used to clean up the MATCHES table of the
information related to specified match groups
description: >-
The API runs matches cleanup job which cleans up the MATCHES table of
the information related to specified match groups. It is recommended to
run this job when there is inconsistency by unknown/unidentified
reasons.
operationId: startCleanupMatchesTask
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: distributed
in: query
description: >-
The default value is false. If set to true the job is
run in distributed mode. It applies if the version=v1 or not
specified
schema:
type: boolean
default: false
- name: taskPartsCount
in: query
description: >-
The parameter specifies how many job parts are requested for the
distributed mode
schema:
type: integer
example: 8
requestBody:
description: >-
The payload to specify entity type and match rule uris to delete
matches associated with them
content:
application/json:
schema:
$ref: '#/components/schemas/CleanupMatchesPayload'
examples:
sample:
description: Sample request for API
value:
entityType: Individual
rules:
- >-
configuration/entityTypes/Individual/matchGroups/MatchByMiddleName
- >-
configuration/entityTypes/Individual/matchGroups/MatchByMiddleNameAndLastName
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: 3a828d2b-e4d8-470c-baec-3b8aa387649b
groupId: 34c3dc04-b796-4c8f-9956-8daad6947bb8
createdTime: 1706810981899
createdBy: someUser
updatedTime: 1706810981899
updatedBy: someUser
type: >-
com.reltio.businesslogic.tasks.matching.cleanupMatchesTask.CleanupMatchesTask
status: SCHEDULED
name: >-
com.reltio.businesslogic.tasks.matching.cleanupMatchesTask.CleanupMatchesTask
createdOnHost: someHost
parallelExecution: false
nodesGroup: default
parameters:
tenantId: tenantId
entityType: Individual
matchRules: >-
configuration/entityTypes/Individual/matchGroups/MatchByMiddleName,configuration/entityTypes/Individual/matchGroups/MatchByMiddleNameAndLastName
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.tasks.MatchTasksController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/startCleanupMatchesTask
/services/reltio/api/{tenantId}/externalMatch:
post:
tags:
- Match Jobs
summary: >-
A background job which is used to calculate the matches for the input
entities based on the match rule configuration
description: >-
The API runs the External Match job which calculates the match pairs for
the input entities. The job is run for the match rules having ALL and
EXTERNAL scope.
operationId: startExternalMatchJobByTenantAdmin
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: entityType
in: query
description: >-
Entity type to filter and match from the entire set of entities
represented in an external file
schema:
type: string
example: Individual
- name: emails
in: query
description: >-
Defines a comma-separated list of emails to which a notification of
completion will be sent
schema:
type: string
example: someUser@someCompany.com
- name: fileFormat
in: query
description: >-
The format of the output file records. Formats:
- csv —
CSV format
- json — Multiline JSON (single input line may
result in multiple output lines)
- json_v2 — Single line JSON
(single input line results into single output line)
schema:
type: string
default: json
enum:
- json
- json_v2
- csv
example: json_v2
- name: distributed
in: query
description: Specifies whether the task is distributed or not
schema:
type: boolean
default: false
- name: distributedTasksPartsCount
in: query
description: Defines the number of distributed tasks to be created. Default is 2
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: s3Bucket
in: query
description: >-
Defines the AWS S3 bucket where the source file must reside and
where the result file will be created. This parameter is deprecated
schema:
type: string
example: externalMatchResults
- name: s3Region
in: query
description: Defines the AWS region for S3 bucket
schema:
type: string
example: us-east-1
- name: s3Path
in: query
description: >-
Determines the path to a source file in a bucket (including folders,
if necessary). This parameter is deprecated
schema:
type: string
example: Individual/2020-01-01/input.txt
- name: s3PathOut
in: query
description: >-
Determines the path where the output result file will be created in
a bucket (including folders, if necessary). This parameter is
deprecated
schema:
type: string
example: Individual/2020-01-01/output.txt
- name: bucket
in: query
description: >-
Defines the bucket where the source file must reside and where the
result file will be created
schema:
type: string
example: externalMatchResults
- name: path
in: query
description: >-
Determines the path to a source file in a bucket (including folders,
if necessary)
schema:
type: string
example: Individual/2020-01-01/input.txt
- name: pathOut
in: query
description: >-
Determines the path where the output result file will be created in
a bucket (including folders, if necessary)
schema:
type: string
example: Individual/2020-01-01/output.txt
- name: fileEncoding
in: query
description: >-
Defines the source and result file encoding. The default value is
UTF-8
schema:
type: string
example: UTF-8
- name: entitiesLimit
in: query
description: Defines the number of entities to be processed from the source
schema:
type: integer
example: 1000000
- name: skipEntitiesCount
in: query
description: Defines the number of entities to be skipped from the source file
schema:
type: integer
default: 0
example: 10000
- name: distributedTaskIndex
in: query
description: >-
Defines task index to start only. If not defined, all created tasks
will be started automatically
schema:
type: integer
example: 1
- name: urlExpirationPeriod
in: query
description: >-
Expiration period in days for the download link from the S3 bucket
(default and max value is 7)
schema:
maximum: 7
minimum: 1
type: integer
default: 7
example: 7
- name: maxPotentialMatchesPerChunk
in: query
description: >-
External match goes through entities by chunk (10 entities), each
chunk has a limitation for the maximum of potential matches found by
chunk. Default value is 200
schema:
type: integer
default: 200
example: 100
- name: rules
in: query
description: >-
Defines a comma separated set of match group URIs which must take
part in the matching process. All other match groups will be ignored
if this parameter is defined
schema:
type: list[string]
example: >-
configuration/entityTypes/HCP/matchGroups/MatchByMiddleName,configuration/entityTypes/HCP/matchGroups/MatchByMiddleNameAndLastName
- name: cleanse
in: query
description: >-
If set to true, the API enriches the entities with the cleansed
values for attributes. The cleansed entities are then matched with
the entities in the tenant
schema:
type: boolean
default: false
- name: resolveLookups
in: query
description: >-
If set to true, then lookups are resolved for entities in the input
file
schema:
type: boolean
default: false
- name: awsAccessKey
in: header
description: AWS access key for the AWS S3 bucket
schema:
type: string
default: 'false'
- name: awsSecretKey
in: header
description: AWS secret key for the AWS S3 bucket
schema:
type: string
default: 'false'
- name: awsRoleArn
in: header
description: AWS role ARN for the AWS S3 bucket
schema:
type: string
default: 'false'
- name: awsRoleSessionName
in: header
description: AWS role session name for the AWS S3 bucket
schema:
type: string
default: 'false'
- name: awsExternalId
in: header
description: AWS externalId for the AWS S3 bucket
schema:
type: string
default: 'false'
- name: googleCredentials
in: header
description: GCP service key account JSON
schema:
type: string
default: 'false'
requestBody:
description: The payload of the External Match job
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMatchPayload'
examples:
sample:
description: Sample request for API
value:
entityType: HCP
skipEntitiesCount: 0
distributed: false
emails: someUser@someCompany@reltio.com
fileFormat: json_v2
bucket: externalMatchResults
s3Region: us-east-1
path: Individual/2020-01-01/input.txt
pathOut: Individual/2020-01-01/output.txt
maxPotentialMatchesPerChunk: 40
rules:
- >-
configuration/entityTypes/Individual/matchGroups/PersonByMEAuto
cleanse: false
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: 7841f9d9-72d1-47f0-818c-5ee486bfc6a5
groupId: 7bca98de-d04f-4cc2-85b1-11027d62c3bf
createdTime: 1611186928500
createdBy: someUser@someCompany.com
updatedTime: 1611186928500
updatedBy: someUser@someCompany.com
type: com.reltio.businesslogic.tasks.matching.ExternalMatchTask
status: SCHEDULED
name: External Match
createdOnHost: dataload
parallelExecution: false
nodesGroup: default
parameters:
tenantId: '{tenantId}'
entityType: Individual
skipEntitiesCount: '0'
entitiesLimit: '0'
uriList: >-
configuration/entityTypes/Individual/matchGroups/PersonByMEAuto
distributedTaskIndex: '0'
distributedTasksPartsCount: '1'
fileFormat: json_v2
parallelTasksIds: '[]'
s3Bucket: externalMatchResults
s3Region: us-east-1
s3Path: Individual/2020-01-01/input.txt
s3PathOut: Individual/2020-01-01/output.txt
forceCleansing: 'false'
email: someUser@someCompany.com
maxPotentialMatchesPerChunk: '40'
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.tasks.MatchTasksController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/startExternalMatchJobByTenantAdmin
/services/reltio/api/{tenantId}/rebuildmatchtable:
post:
tags:
- Match Jobs
summary: >-
A background job which is used to recalculate the matches based on the
match rule configuration
description: >-
The API runs the Rebuild Match Table job which recalculates the match
pairs. It is recommended to run this job when the match rules are
changed in the business configuration or in cases when the matching
information is not up-to-date with the data.
operationId: startRebuildMatchTableJobAdmin
parameters:
- name: rebuildInBackground
in: query
schema:
type: boolean
- name: maintenanceOptions
in: query
schema:
type: string
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: entityType
in: query
description: >-
The type name of entities whose match tables information should be
rebuilt
schema:
type: string
example: Individual
- name: skipEntitiesCount
in: query
description: >-
The number of entities that have to be skipped while iterating over
the dataset. It applies if the version=v1 or not specified
schema:
type: integer
example: 1000
- name: entitiesLimit
in: query
description: >-
The maximum number of entities that should be processed by each part
of the distributed job or by the non-distributed job. It applies if
the version=v1 or not specified
schema:
type: integer
example: 100000
- name: distributed
in: query
description: >-
The default value is false. If set to true the job is
run in distributed mode. It applies if the version=v1 or not
specified
schema:
type: boolean
default: false
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. It applies if the version=v1 or not specified
schema:
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The parameter specifies how many job parts are requested for the
distributed mode. It applies if the version=v1 or not
specified
schema:
type: integer
example: 8
- name: scanOver
in: query
description: >-
Specifies the scope of the data to be processed during the rebuild
match table task. It determines whether the task should operate over
all entities or only potential matches
schema:
type: string
default: entities
enum:
- entities
- potentialMatches
example: potentialMatches
requestBody:
description: >-
The payload to specify the entities to process by the job. One of the
RebuildMatchTableTaskPayload, RebuildMatchTableTaskEntitiesListPayload
content:
application/json:
schema:
$ref: '#/components/schemas/AbstractRebuildMatchTableTaskPayload'
examples:
sample:
description: Sample request for API
value:
objects:
includeList:
- entities/123abcDE
- entities/234bcdEF
- entities/345cdeFG
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: f3b32a64-81bc-4622-9600-feb7c76f9a6b
createdTime: 1610414935938
createdBy: someUser@companyName.com
updatedTime: 1610414935938
updatedBy: someUser@companyName.com
type: >-
com.reltio.businesslogic.tasks.matching.RebuildMatchTableTask
status: SCHEDULED
name: >-
Rebuild match table process for all types in tenant
{tenantId}
createdOnHost: dataload-b96db656d-hcc6w
parallelExecution: false
nodesGroup: default
parameters:
tenantId: '{tenantId}'
entityType: all types
skipEntitiesCount: '0'
entitiesLimit: '-1'
uriList: >-
["entities/123abcDE","entities/234bcdEF","entities/345cdeFG"]
rebuildMatchTableTaskVersion: v1
rebuildInBackground: 'false'
uriListType: INPUT
dependedTasksIds: ''
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.tasks.MatchTasksController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/startRebuildMatchTableJobAdmin
/services/reltio/api/{tenantId}/rebuildpmcounters:
post:
tags:
- Match Jobs
summary: >-
A background job which is used to recalculate the potential match counts
shown in the Reltio UI
description: >-
The API runs the job to reindex potential matches. The job is required
if there are inconsistencies in the potential matches counters or after
the Rebuild Match Table job of version=v2 is completed. The call
automatically runs the Remove Potential Matches Counters job before.
operationId: startRebuildPotentialMatchesCountersAdmin
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
- name: taskPartsCount
in: query
description: >-
The parameter specifies how many job parts are requested for the
distributed mode
schema:
type: integer
default: 2
example: 8
- name: filter
in: query
description: >-
The parameter specifies a subset of the entities whose potential
matches need to be reindexed
schema:
type: string
example: (equals(type,'Individual') and gt(updatedTime,1556053012537))
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: c9181794-1be1-456a-8ba3-34039126b0a2
groupId: fb8a4e4f-74c3-4391-a5fe-3bad4e284a7a
createdTime: 1610475382180
createdBy: someUser@someCompany.com
updatedTime: 1610475382180
updatedBy: someUser@someCompany.com
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
status: SCHEDULED
name: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
createdOnHost: dataload
parallelExecution: false
nodesGroup: default
parameters:
tenantId: '{tenantId}'
currentState: {}
duration: 0s
- id: 730e97f4-6821-4654-9cd5-41fbc3a37a2c
groupId: 76527bd0-83a1-4738-9901-0b45fa6109f9
createdTime: 1610475382180
createdBy: someUser@someCompany.com
updatedTime: 1610475382180
updatedBy: someUser@someCompany.com
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask
status: SCHEDULED
name: >-
Reindexing potential matches information for tenant
{tenantId}
createdOnHost: dataload
parallelExecution: false
nodesGroup: default
parameters:
tenantId: '{tenantId}'
ignoreEventsInStreaming: 'false'
forceIgnoreInStreaming: 'false'
dependedTasksIds: c9181794-1be1-456a-8ba3-34039126b0a2
currentState: {}
duration: 0s
dependsOnTasksIds: c9181794-1be1-456a-8ba3-34039126b0a2
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.tasks.MatchTasksController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/startRebuildPotentialMatchesCountersAdmin
/services/reltio/api/{tenantId}/reindex:
post:
tags:
- Reindex Jobs
summary: A background job which is used to reindex entity data in a tenant
description: >-
Reindexes entity data in a tenant.
Stop and Pause are
supported.
You may run this task if any data synchronization issues
are detected. This job does not rebuild match tables. It is recommended
that you also run the rebuild match tables jobs after reindexing data in
your tenant.
This task refreshes the index that supports Elastic
search of a tenant's Entity data. To speed up the search of a large
database, the database management system builds one or more database
indexes. Like a book index, a database index is a list of paired items:
one item is a significant term from the database, and the other is the
address of that term in the data storage (like the page number in a
large book), where the program can go to find that term. When you type
in a term to search for, it's much faster for the program to scan the
index for the term, and go directly to the indexed address, than it is
to search through the entire database. Database indexes keep large
databases tuned up, so that searches can be performed quickly.
As
databases change, however, performance degrades: database records shift
around in memory, and the indexes become less accurate and less
effective. It's important to run Reindex Data to scan the databases and
update the indexes periodically.
Reltio's enterprise-scale database
system includes a primary Entity database which is searched by a utility
called ElasticSearch. In addition to the ElasticSearch index, the system
is supported by a sub-database that captures the history of all database
transactions, an index of all matching records from various sources, and
tables that store the output of Reltio's analytics layer (RI). Each of
these supporting data structures needs to be updated when the primary
database changes. The Reindex Data task updates the ElasticSearch index
and updates the supporting structures as well.
Important: This
work can put a significant strain on the system's resources. In
addition, each change to the database and any supporting structure
generates a database event which is streamed to recording servers. This
sudden surge of new events can overwhelm these streaming channels. To
avoid overwhelming your databases and reporting channels when
reindexing, you can tweak the Reindex Data task in the following
ways:- Instruct the task to reindex the ElasticSearch index but
leave the match tables, history, and analytics data
alone.
- Restrict the reindexing process to a subset of the Entity
database.
- Instruct the process to skip some number of
Entities.
- Cap the number of Entities to be
reindexed.
- Distribute the reindexing task among a number of
processing nodes.
- Run the reindexing job against a limited list
of Entities (by appending a list of URLs in the body of the Reindex Data
request).
Note: It is not recommended to update the
business configuration of the tenant while the reindex data task is
running.
Note: This task also starts
PotentialMatchesReindexTask to reindex potential matches
information for the entire tenant. However, when you reindex specific
entities, the PotentialMatchesReindexTask is not
started.
Body (optional):
JSON Array of entity URIs to
reindex or JSON Array of file names with entity URIs in case you send
awsAccessKey and awsSecretKey or
googleCredentials.
File format is JSON Array of entity
URIs:
["entities/aaaa", "entities/bbbb",
"entities/cccc"]Note: If a JSON array of entity URIs is
specified, then only the specified entities are reindexed. If the header
parameters are specified, then only file URI's are accepted in the
request body.
operationId: startReindexEntities
parameters:
- name: drSecondaryJob
in: query
schema:
type: boolean
default: false
- name: propagateDrRegion
in: query
schema:
type: boolean
default: true
- name: tenantId
in: path
description: ID of the tenant to reindex entities
required: true
schema:
type: string
example:
- name: entityType
in: query
description: >-
If provided, the task restricts the reindexing scope to Entities of
specified type
schema:
type: string
example: Individual
- name: skipEntitiesCount
in: query
description: >-
When specified as N, reindexing starts with the N+1st entity read.
This parameter can be used if a reindex job had to be stopped before
completion to avoid reindexing the same entities that were processed
previously
schema:
minimum: 0
type: int
example: '100'
- name: entitiesLimit
in: query
description: >-
If provided, sets the maximum number of Entities are reindexed.
Otherwise, all entities are processed
schema:
minimum: 1
type: int
example: '1000'
- name: updateEntities
in: query
description: >-
If set to true, in addition to refreshing the ElasticSearch
index, the task also updates history, match tables, and the
analytics layer (RI). This ensures that all indexes and supporting
structures are as up-to-date as possible. As explained above,
however, triggering all these activities may decrease the overall
performance level of the database system for business work, and
overwhelm the event streaming channels. Note that update to match
tables would be done if and only if entity version is different for
the main storage and match storage. So, if you want completely
update match storage (for example, because matching rules change in
Tenant Business Configuration, then you have to run rebuild match
tables task).If set to false, the task updates ElasticSearch
data only. It does not perform rematching, or update history or
analytics. These other activities can be performed at different
times to spread out the performance impact
schema:
type: boolean
default: true
example: false
- name: updatedSince
in: query
description: >-
Only entities with updatedTime >= updatedSince are
reindexed
schema:
minimum: 0
type: integer
format: int64
default: 0
example: 1610445566000
- name: checkCrosswalksConsistency
in: query
description: >-
Specify true to start a task which checks whether all
crosswalks are unique before reindexing
schema:
type: boolean
default: false
example: false
- name: distributed
in: query
description: >-
If set to true, the task runs in distributed mode, which is a
good way to take advantage of a networked or clustered computing
environment to spread the performance demands of reindexing over
several nodes
schema:
type: boolean
default: false
example: true
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. 1 <= distributedTaskIndex <= taskPartsCount
schema:
minimum: 1
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of Entities. And all tasks can
run in parallel. Should not exceed maxTaskPartsCount property
of Tenant Configuration.
Note: This parameter is used only
in distributed mode (distributed=true); otherwise, its
ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: forceIgnoreInStreaming
in: query
description: >-
If set to true, the events generated by the task execution
are not published to streaming queues
schema:
type: boolean
default: false
example: false
- name: enableSeparateIndexing
in: query
description: >-
If set to true, the Reindex Data task builds a new index.
When the task is completed, the task replaces the old index with the
new one. Run the Reindex Data task with this parameter to continue
your activities in Reltio Cloud without waiting for the task to
finish
schema:
type: boolean
default: false
example: false
- name: bucket
in: query
description: >-
Name of AWS S3 or GCP Cloud Filestore bucket that contains files
with entity URIs to reindex
schema:
type: string
example: bucket1
- name: s3Region
in: query
description: Name of AWS S3 Region for the bucket
schema:
type: string
example: us-east-1
- name: fileFormat
in: query
description: Format of the file that contains Entity URIs to reindex
schema:
type: string
enum:
- json
- line_break
example: json
- name: awsAccessKey
in: header
description: S3 access key for amazon bucket
schema:
type: string
example: AKIXXXXXXXXXXXXXXX3Z
- name: awsSecretKey
in: header
description: S3 secret key for amazon bucket
schema:
type: string
example: MFUxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxGL
- name: googleCredentials
in: header
description: >-
Google credentials to access GCP Cloud Filestore bucket. Can contain
a Service Account key file in JSON format from the Google Developers
Console or a stored user credential using the format supported by
the Cloud SDK
schema:
type: string
example: |-
{
"type": "service_account",
"project_id": "",
"private_key_id": "",
"private_key": "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n",
"client_email": "",
"client_id": "",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/"
}
- name: processors
in: query
description: >-
Comma-separated list of processor IDs to restrict which event queue
processors handle the reindexed data. When omitted, all processors
receive events (default behavior). For ES-only reindex use:
crud_search_entities,crud_search_activities,crud_search_others
schema:
type: string
example: crud_search_entities,crud_search_activities,crud_search_others
requestBody:
content:
application/json:
schema:
type: string
examples:
sample:
description: >-
This sample request body will redinex only the 3 entities with
IDs "aaaa", "bbbb", and "cccc"
value:
- entities/aaaa
- entities/bbbb
- entities/cccc
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: c0d5be5e-58d8-4c70-87a8-11a864a4a5f6
groupId: 14123281-f7a1-487b-b665-83ff895e64b3
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: com.reltio.businesslogic.tasks.reindex.ReindexDataTask
status: SCHEDULED
name: >-
Reindexing of configuration/entityTypes/Individual in tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
entityType: Individual
skipEntitiesCount: '0'
updateEntities: 'true'
updatedSince: '0'
force: 'false'
uriList: ''
enableSeparateIndexing: 'false'
distributedTaskIndex: '0'
distributedTasksPartsCount: '2'
parallelTasksIds: '["7cd3a8a0-0f8d-4670-b543-4c5156d3f5ff"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
- id: 7cd3a8a0-0f8d-4670-b543-4c5156d3f5ff
groupId: 14123281-f7a1-487b-b665-83ff895e64b3
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: com.reltio.businesslogic.tasks.reindex.ReindexDataTask
status: SCHEDULED
name: >-
Reindexing of configuration/entityTypes/Individual in tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
entityType: Individual
skipEntitiesCount: '0'
updateEntities: 'true'
updatedSince: '0'
force: 'false'
uriList: ''
enableSeparateIndexing: 'false'
distributedTaskIndex: '1'
distributedTasksPartsCount: '2'
parallelTasksIds: '["c0d5be5e-58d8-4c70-87a8-11a864a4a5f6"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
- id: 0ee6035a-c9f9-4ea3-823e-c730476a9db4
groupId: b16fbbbb-f586-499c-98f1-0d1f8bd90afb
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
status: SCHEDULED
name: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
dependedTasksIds: >-
c0d5be5e-58d8-4c70-87a8-11a864a4a5f6,7cd3a8a0-0f8d-4670-b543-4c5156d3f5ff
currentState: {}
duration: 0s
dependsOnTasksIds: >-
c0d5be5e-58d8-4c70-87a8-11a864a4a5f6,7cd3a8a0-0f8d-4670-b543-4c5156d3f5ff
- id: 1c9a4f7f-00d9-4207-90bb-4b8beb08cbbc
groupId: c90588a0-0d35-4bc4-b666-6e4023987fa0
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask
status: SCHEDULED
name: >-
Reindexing potential matches information for tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
ignoreEventsInStreaming: 'true'
forceIgnoreInStreaming: 'false'
dependedTasksIds: 0ee6035a-c9f9-4ea3-823e-c730476a9db4
currentState: {}
duration: 0s
dependsOnTasksIds: 0ee6035a-c9f9-4ea3-823e-c730476a9db4
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Reindex%20Jobs/startReindexEntities
/services/reltio/api/{tenantId}/reindexActivities:
post:
tags:
- Reindex Jobs
summary: A background job which is used to reindex activities in a tenant
description: >-
This API runs the reindex activity task
(com.reltio.businesslogic.tasks.reindex.ReindexActivityTask), that
performs reindexing of activities in a tenant. By default
(activityFullReindex=false), only activities for the
previous month will be reindexed. Only users with the Tenant
Administrator role can perform this action.
operationId: startReindexActivitiesJobByTenant
parameters:
- name: drSecondaryJob
in: query
schema:
type: boolean
default: false
- name: propagateDrRegion
in: query
schema:
type: boolean
default: true
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: distributed
in: query
description: If set to true, the task runs in distributed mode
schema:
type: boolean
default: false
- name: taskPartsCount
in: query
description: >-
Number of tasks that are created for distributed reindexing. Each
task reindexes its own sub-set of activities, and all of them can be
executed on different API nodes in parallel. This parameter is used
ONLY in distributed mode (distributed=true),
otherwise, it's ignored
schema:
type: int
format: int32
default: '2'
- name: forceIgnoreInStreaming
in: query
description: If set to true, the task won't send events to streaming
schema:
type: boolean
default: true
- name: activityFullReindex
in: query
description: >-
If set to true, reindexes all activities. If set to
false or not specified, only activities for the previous
month are reindexed
schema:
type: boolean
default: false
requestBody:
description: >-
A list of activity URIs, if specified, only activities from this list
will be reindexed, activity URIs can be obtained via the Activity APIs
content:
application/json:
schema:
type: array
items:
type: string
examples:
sample:
description: >-
This sample request body will reindex only the 4 activities
with the IDs "12d2cb88-c024-4e02-a095-d7071c1fe2d1",
"f234e8ba-8665-46ad-baea-248a23ea319b",
"3cd58a19-5cf7-40d4-a156-09c81c5479f2", and
"4d9b615a-0a7c-40dc-a6db-8cd1798fa65"
value:
- activities/12d2cb88-c024-4e02-a095-d7071c1fe2d1
- activities/f234e8ba-8665-46ad-baea-248a23ea319b
- activities/3cd58a19-5cf7-40d4-a156-09c81c5479f2
- activities/4d9b615a-0a7c-40dc-a6db-8cd1798fa652
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: bba41b88-c576-420a-9478-411b4c524d38
groupId: 754e634c-0c37-40fe-af93-e282c928bc7f
createdTime: 1612873485108
createdBy: user@example.com
updatedTime: 1612873485108
updatedBy: user@example.com
type: com.reltio.businesslogic.tasks.reindex.ReindexActivityTask
status: SCHEDULED
name: Reindexing of all activities in tenant Merill
createdOnHost: dataload-xxxxxxxxxx-xxxxx
parallelExecution: false
nodesGroup: default
parameters:
tenantId: Merill
updatedSince: '0'
force: 'false'
uriList: ''
skipActivitiesCount: '0'
enableSeparateIndexing: 'false'
distributedTaskIndex: '0'
distributedTasksPartsCount: '2'
parallelTasksIds: '["f16b7b52-6d51-4d3a-be4e-7502987f149d"]'
forceIgnoreInStreaming: 'true'
currentState: {}
duration: 0s
- id: f16b7b52-6d51-4d3a-be4e-7502987f149d
groupId: 754e634c-0c37-40fe-af93-e282c928bc7f
createdTime: 1612873485108
createdBy: user@example.com
updatedTime: 1612873485108
updatedBy: user@example.com
type: com.reltio.businesslogic.tasks.reindex.ReindexActivityTask
status: SCHEDULED
name: Reindexing of all activities in tenant Merill
createdOnHost: dataload-xxxxxxxxxx-xxxxx
parallelExecution: false
nodesGroup: default
parameters:
tenantId: Merill
updatedSince: '0'
force: 'false'
uriList: ''
skipActivitiesCount: '0'
enableSeparateIndexing: 'false'
distributedTaskIndex: '1'
distributedTasksPartsCount: '2'
parallelTasksIds: '["bba41b88-c576-420a-9478-411b4c524d38"]'
forceIgnoreInStreaming: 'true'
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Tenant Merill not configured. Use admin API to configure
tenant
errorCode: 127
errorDetailMessage: >-
Tenant Merill not configured. Use admin API to configure
tenant
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation Failed to parse activities list. Please view
application log for details
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Reindex%20Jobs/startReindexActivitiesJobByTenant
/services/reltio/api/{tenantId}/reindexAll:
post:
tags:
- Reindex Jobs
summary: A background job which is used to reindex all tenant data
description: >-
Reindexes all data in a tenant, including entities, relations,
interactions, matches and merges.
Stop and Pause are supported.
operationId: startReindexAll
parameters:
- name: updatedSince
in: query
schema:
type: integer
format: int64
default: 0
- name: tenantId
in: path
description: >-
ID of the tenant to reindex all data ie, entities, relations,
interaction, potential matches and merges
required: true
schema:
type: string
example:
- name: processors
in: query
description: Comma-separated list of processors where events should be sent
schema:
type: string
example: targetProcessor
- name: streamingDestinations
in: query
description: >-
Comma-separated list of streaming destinations where events should
be sent
schema:
type: string
example: targetQueue
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. 1 <= distributedTaskIndex <= taskPartsCount
schema:
minimum: 1
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of objects. And all tasks can run
in parallel. Should not exceed maxTaskPartsCount property of
Tenant Configuration.
Note: This parameter is used only in
distributed mode (distributed=true); otherwise, its ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: reindexDeleted
in: query
description: >-
If set to true the job will add sub task for deleted
Entities and Relations
schema:
type: boolean
default: false
example: true
- name: dataTypes
in: query
description: Comma-separated list of data types to be synchronized
schema:
type: string
enum:
- entities
- relations
- interactions
- matches
- merges
- activities
- deleted_entities
- deleted_relations
- deleted_interactions
example: >-
entities,relations,interactions,merges,matches,deleted_entities,deleted_relations,deleted_interactions
requestBody:
content:
application/json:
schema:
type: string
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Reindex%20Jobs/startReindexAll
/services/reltio/api/{tenantId}/reindexInteractions:
post:
tags:
- Reindex Jobs
summary: A background job which is used to reindex interactions in a tenant
description: Reindex interactions in a tenant.
Stop and Pause are supported.
operationId: startReindexInteractions
parameters:
- name: drSecondaryJob
in: query
schema:
type: boolean
default: false
- name: propagateDrRegion
in: query
schema:
type: boolean
default: true
- name: processors
in: query
schema:
type: string
- name: tenantId
in: path
description: ID of the tenant to reindex interactions
required: true
schema:
type: string
example:
- name: updatedSince
in: query
description: >-
Only interactions with updatedTime >= updatedSince are
reindexed
schema:
type: integer
format: int64
default: 0
example: 1610445566000
- name: forceIgnoreInStreaming
in: query
description: >-
If set to true, the events generated by the task execution
are not published to streaming queues
schema:
type: boolean
default: false
example: false
- name: enableSeparateIndexing
in: query
description: >-
If set to true, the Reindex Interaction task builds a new
index. When the task is completed, the task replaces the old index
with the new one. Run the Reindex Interactions task with this
parameter to continue your activities in Reltio Cloud without
waiting for the task to finish
schema:
type: boolean
default: false
example: false
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of Entities. And all tasks can
run in parallel. Should not exceed maxTaskPartsCount property
of Tenant Configuration.
Note: This parameter is used only
in distributed mode (distributed=true); otherwise, its
ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
groupId: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: >-
com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask
status: SCHEDULED
name: Reindexing interactions in tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
updatedSince: '1610445566000'
enableSeparateIndexing: 'false'
distributedTaskIndex: '0'
distributedTasksPartsCount: '2'
parallelTasksIds: '["235535d4-79fc-46e0-b672-f928ac6ca300"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
- id: 235535d4-79fc-46e0-b672-f928ac6ca300
groupId: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
createdTime: 1679924189993
createdBy: someUser@companyName.com
updatedTime: 1679924189993
updatedBy: someUser@companyName.com
type: >-
com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask
status: SCHEDULED
name: Reindexing interactions in tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
updatedSince: '0'
enableSeparateIndexing: 'false'
distributedTaskIndex: '1'
distributedTasksPartsCount: '2'
parallelTasksIds: '["3aab9c27-4d3d-48a3-98e0-7a7491059ab2"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Reindex%20Jobs/startReindexInteractions
/services/reltio/api/{tenantId}/reindexRelations:
post:
tags:
- Reindex Jobs
summary: A background job which is used to reindex relations in a tenant
description: >-
Reindex relations in a tenant.
Stop and Pause are supported.
The
Reindex relations task can:- Reindex tenant's
relations
- Update the history table
- Update the match
tables to reflect each relation change/creation/deletion caused by
reindexing
- Repopulate the analytics layer
(RI)
Note: The Reindex relations task can generate a
large volume of events, which may overwhelm the tenant's
queues.
Body (optional):
JSON Array of relations URIs to
reindex. Only these relations are reindexed in this case.
operationId: startReindexRelations
parameters:
- name: drSecondaryJob
in: query
schema:
type: boolean
default: false
- name: propagateDrRegion
in: query
schema:
type: boolean
default: true
- name: tenantId
in: path
description: ID of the tenant to reindex relations
required: true
schema:
type: string
example:
- name: relationType
in: query
description: If provided, restricts reindex scope to relations of a specific type
schema:
type: string
example: HasAddress
- name: skipRelationsCount
in: query
description: >-
When specified as N, reindexing starts with the N+1st relation read.
This parameter can be used if a reindex job had to be stopped before
completion to avoid reindexing the same relations that were
processed previously
schema:
minimum: 0
type: int
default: '0'
example: '100'
- name: relationsLimit
in: query
description: >-
If provided, sets the maximum number of relations are reindexed.
Otherwise, all relations are processed
schema:
minimum: 1
type: int
example: '1000'
- name: updateRelations
in: query
description: >-
If set to true, in addition to refreshing the relations in
the tenant, the task also updates history, match tables, and the
analytics layer (RI). This may interfere with normal event
streaming.
If set to false, the task updates ElasticSearch
relations data only – does not perform rematching or update history
or analytics
schema:
type: boolean
default: true
example: false
- name: updatedSince
in: query
description: >-
Only relations with updatedTime >= updatedSince are
reindexed
schema:
minimum: 0
type: integer
format: int64
default: 0
example: 1610445566000
- name: checkCrosswalksConsistency
in: query
description: >-
Specify true to start a task which checks whether all
crosswalks are unique before reindexing
schema:
type: boolean
default: false
example: false
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. 1 <= distributedTaskIndex <= taskPartsCount
schema:
minimum: 1
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of Entities. And all tasks can
run in parallel. Should not exceed maxTaskPartsCount property
of Tenant Configuration.
Note: This parameter is used only
in distributed mode (distributed=true); otherwise, its
ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: forceIgnoreInStreaming
in: query
description: >-
If set to true, the events generated by the task execution
are not published to streaming queues
schema:
type: boolean
default: false
example: false
- name: enableSeparateIndexing
in: query
description: >-
If set to true, the Reindex Relations task builds a new
index. When the task is completed, the task replaces the old index
with the new one. Run the Reindex Relations task with this parameter
to continue your activities in Reltio Cloud without waiting for the
task to finish
schema:
type: boolean
default: false
example: false
- name: processors
in: query
description: >-
Comma-separated list of processor IDs to restrict which event queue
processors handle the reindexed data. When omitted, all processors
receive events (default behavior). For ES-only reindex use:
crud_search_entities,crud_search_activities,crud_search_others
schema:
type: string
example: crud_search_entities,crud_search_activities,crud_search_others
requestBody:
content:
application/json:
schema:
type: string
examples:
sample:
description: >-
This sample request body will redinex only the 3 relations
with IDs "aaaa", "bbbb", and "cccc"
value:
- relations/aaaa
- relations/bbbb
- relations/cccc
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: f740e42f-649f-406c-be90-9c0eb299305b
groupId: 42aaba7d-f4ea-486b-b95b-94bebfa95c03
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: com.reltio.businesslogic.tasks.reindex.ReindexRelationsTask
status: SCHEDULED
name: >-
Reindexing of configuration/relationTypes/HasAddress in
tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
updatedSince: '0'
force: 'false'
uriList: ''
relationType: HasAddress
updateRelations: 'true'
skipRelationsCount: '0'
distributedTaskIndex: '0'
distributedTasksPartsCount: '2'
parallelTasksIds: '["4caae778-27f3-41fa-9f44-e17df33e0219"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
- id: 4caae778-27f3-41fa-9f44-e17df33e0219
groupId: 42aaba7d-f4ea-486b-b95b-94bebfa95c03
createdBy: someUser@companyName.com
createdTime: '1609135627918'
updatedBy: someUser@companyName.com
updatedTime: '1609135627918'
type: com.reltio.businesslogic.tasks.reindex.ReindexRelationsTask
status: SCHEDULED
name: >-
Reindexing of configuration/relationTypes/HasAddress in
tenant
createdOnHost: dataload-947b546c9-5tz97
parallelExecution: false
nodesGroup: default
parameters:
tenantId:
updatedSince: '0'
force: 'false'
uriList: ''
relationType: HasAddress
updateRelations: 'true'
skipRelationsCount: '0'
distributedTaskIndex: '1'
distributedTasksPartsCount: '2'
parallelTasksIds: '["f740e42f-649f-406c-be90-9c0eb299305b"]'
forceIgnoreInStreaming: 'false'
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Reindex%20Jobs/startReindexRelations
/services/reltio/api/{tenantId}/removeEndDates:
post:
tags:
- End-dates Jobs
summary: Remove end-dates from entities and entity crosswalks
description: >-
This is an asynchronous background task that removes end-dates from
entities and entity crosswalks. This API can handle both single entity
or an array of entities separated by the entity URIs.
operationId: removeEndDates
parameters:
- name: filter
in: query
schema:
type: string
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: entityType
in: query
description: >-
This is the entity type to be processed (all entity types are
processed if this parameter is not specified). If this parameter is
provided, then the processing is restricted to a specific entity
type.
schema:
type: string
example: Individual
- name: skipEntitiesCount
in: query
description: >-
This parameter indicates the number of entities that are skipped
during the processing. The default value is 0.
schema:
type: Integer
- name: updatedSince
in: query
description: >-
This is the timestamp in UNIX format. If this parameter is
specified, only entities with greater or equal timestamp are
processed
schema:
type: Long
- name: distributed
in: query
description: >-
If this parameter is set to true, the task is run in
distributed mode. The default value is false.
schema:
type: boolean
default: false
example: false
- name: distributedTaskIndex
in: query
description: This parameter indicates the task index.
schema:
minimum: 1
type: Integer
example: '1'
- name: taskPartsCount
in: query
description: >-
This parameter indicates the number of tasks that are created for
distributed processing. Each task processes its own objects and all
of them may be executed on different API nodes in parallel.
Recommended value - Count of API nodes that can execute the
tasks. The default value 2. This parameter is used only in
distributed mode when distributed=true otherwise, it is
ignored.
schema:
type: Integer
example: '2'
- name: startTimestamp
in: query
description: >-
This is the timestamp in UNIX format. If this parameter is
specified, only end-dates greater or equal timestamp are removed
schema:
type: Long
- name: endTimestamp
in: query
description: >-
This is the timestamp in UNIX format. If this parameter is
specified, only end-dates less or equal timestamp are removed
schema:
type: Long
requestBody:
content:
application/json:
schema:
type: string
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/End-dates%20Jobs/removeEndDates
/services/reltio/api/{tenantId}/removepmcounters:
post:
tags:
- Match Jobs
summary: A background job which is used to remove the potential matches.
description: >-
The API call runs the job to clean the old potential matches information
in the Reltio tenant.
operationId: startRemovePotentialMatchesCountersAdmin
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: filter
in: query
description: >-
The parameter specifies a subset of the entities whose potential
matches need to be reindexed
schema:
type: string
example: (equals(type,'Individual') and gt(updatedTime,1556053012537))
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
id: c9181794-1be1-456a-8ba3-34039126b0a2
groupId: fb8a4e4f-74c3-4391-a5fe-3bad4e284a7a
createdTime: 1610475382180
createdBy: someUser@someCompany.com
updatedTime: 1610475382180
updatedBy: someUser@someCompany.com
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
status: SCHEDULED
name: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesRemoveTask
createdOnHost: dataload
parallelExecution: false
nodesGroup: default
parameters:
tenantId: '{tenantId}'
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.tasks.MatchTasksController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/startRemovePotentialMatchesCountersAdmin
/services/reltio/api/{tenantId}/runSegmentCleanUp/{segmentId}:
post:
tags:
- Segment Clean Up Job
summary: >-
A background job which is used to clean up the labels for the given
Segment
description: Clean up the given segment's labels on entities
operationId: runSegmentCleanUp
parameters:
- name: tenantId
in: path
description: ID of the tenant for which labels needs to be calculated
required: true
schema:
type: string
example:
- name: segmentId
in: path
description: SegmentId for which labels needs to be cleaned up
required: true
schema:
type: string
example: S1
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Segment%20Clean%20Up%20Job/runSegmentCleanUp
/services/reltio/api/{tenantId}/runSegmentRecalculation:
post:
tags:
- Segment Calculation Job
summary: A background job which is used to calculate the labels for Segment
description: Generate Labels for entities applicable for the segment rule.
operationId: runSegmentRecalculation
parameters:
- name: segmentId
in: query
required: true
schema:
type: string
- name: tenantId
in: path
description: ID of the tenant for which labels needs to be calculated
required: true
schema:
type: string
example:
- name: consistencyThreshold
in: query
description: >-
This field is used to check the consistency between Elastic Search
and Batch Search storage after reindex data task is completed. Once
the desired consistency level reached the task proceeds to Labelling
task.The value should be between 1 and 100.
schema:
type: integer
example: <90>
- name: maxQueueSizeToWait
in: query
description: >-
This field is used to check the queue size after reindex data task
is completed. Once the queue count is less than the number passed
the task proceeds to Labelling task.The value should be greater than
0.
schema:
type: integer
example: <90>
- name: bufferSize
in: query
description: >-
This field is used to define the amount of data we get per scan of
the labeling segmentation query.
schema:
type: integer
default: 150
example: <15000>
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Segment%20Calculation%20Job/runSegmentRecalculation
/services/reltio/api/{tenantId}/runSyncForSegmentation:
post:
tags:
- Segmentation Reindex Jobs
summary: >-
A background job which is used to reindex all entities data to
Segmentation Search
description: >-
Reindexes entities data in a tenant to Segmentation Search.
Stop and
Pause are supported.
operationId: runSyncForSegmentation
parameters:
- name: tenantId
in: path
description: ID of the tenant to reindex all entities data
required: true
schema:
type: string
example:
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. 1 <= distributedTaskIndex <= taskPartsCount
schema:
minimum: 1
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of objects. And all tasks can run
in parallel. Should not exceed maxTaskPartsCount property of
Tenant Configuration.
Note: This parameter is used only in
distributed mode (distributed=true); otherwise, its ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: updatedSince
in: query
description: >-
Only entities with updatedTime >= updatedSince are
reindexed
schema:
minimum: 0
type: integer
format: int64
default: 0
example: 1610445566000
- name: reindexDeleted
in: query
description: >-
If set to true the job will add sub task for deleted
Entities
schema:
type: boolean
default: false
example: true
- name: entityType
in: query
description: >-
If provided, the task restricts the reindexing scope of entities to
only provided type, while reindexing entities
schema:
type: string
example: Individual
requestBody:
content:
application/json:
schema:
type: string
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Segmentation%20Reindex%20Jobs/runSyncForSegmentation
/services/reltio/api/{tenantId}/runVectorReindexTask:
post:
tags:
- Vector DB Reindex Jobs
summary: A background job which is used to reindex all entities data to Vector DB
description: >-
Reindexes entities data in a tenant to Vector Database.
Stop and
Pause are supported.
operationId: runVectorReindexTask
parameters:
- name: runRebuildMatchTableTask
in: query
schema:
type: boolean
- name: rebuildMatchTablePartsCount
in: query
schema:
type: integer
format: int32
- name: tenantId
in: path
description: ID of the tenant to reindex all entities data
required: true
schema:
type: string
example:
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of objects. And all tasks can run
in parallel. Should not exceed maxTaskPartsCount property of
Tenant Configuration.
Note: This parameter is used only in
distributed mode (distributed=true); otherwise, its ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: updatedSince
in: query
description: >-
Only entities with updatedTime >= updatedSince are
reindexed
schema:
minimum: 0
type: integer
format: int64
default: 0
example: 1610445566000
- name: entityType
in: query
description: >-
If provided, the task restricts the reindexing scope of entities to
only provided type, while reindexing entities
schema:
type: string
example: Individual
requestBody:
content:
application/json:
schema:
type: string
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Vector%20DB%20Reindex%20Jobs/runVectorReindexTask
/services/reltio/api/{tenantId}/syncToDataPipeline:
post:
tags:
- DPH Reindex Jobs
summary: A background job which is used to reindex all tenant data to DPH
description: >-
Reindexes all data in a tenant to DPH, including entities, relations,
interactions, matches and merges.
Stop and Pause are supported.
operationId: syncToDataPipeline
parameters:
- name: updatedSince
in: query
schema:
type: integer
format: int64
default: 0
- name: adapters
in: query
schema:
type: string
- name: tenantId
in: path
description: >-
ID of the tenant to reindex all data ie, entities, relations,
interaction, potential matches and merges
required: true
schema:
type: string
example:
- name: distributed
in: query
description: If set to true the job is run in distributed mode
schema:
type: boolean
default: false
example: true
- name: distributedTaskIndex
in: query
description: >-
The parameter specifies which part of the distributed job needs
running. The parameter is applicable if distributed=true. The
option is designed to rerun a specific job part that was previously
failed. 1 <= distributedTaskIndex <= taskPartsCount
schema:
minimum: 1
type: integer
example: 1
- name: taskPartsCount
in: query
description: >-
The number of tasks which are created for distributed reindexing.
Each task reindexes its own subset of objects. And all tasks can run
in parallel. Should not exceed maxTaskPartsCount property of
Tenant Configuration.
Note: This parameter is used only in
distributed mode (distributed=true); otherwise, its ignored
schema:
minimum: 1
type: integer
default: 2
example: 2
- name: reindexDeleted
in: query
description: >-
If set to true the job will add sub task for deleted
Entities and Relations
schema:
type: boolean
default: false
example: true
- name: dataTypes
in: query
description: Comma-separated list of data types to be synchronized
schema:
type: string
enum:
- entities
- relations
- interactions
- matches
- merges
- activities
- deleted_entities
- deleted_relations
- deleted_interactions
example: >-
entities,relations,interactions,merges,matches,deleted_entities,deleted_relations,deleted_interactions
- name: entityType
in: query
description: >-
If provided, the task restricts the reindexing scope of entities to
only provided type, while reindexing entities
schema:
type: string
example: Individual
- name: relationType
in: query
description: >-
If provided, the task restricts the reindexing scope of entities to
only provided type, while reindexing relations
schema:
type: string
example: HasAddress
requestBody:
content:
application/json:
schema:
type: string
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
example:
- id: be09bd03-7042-41d4-96fb-8fa91680f827
groupId: 9684d5c2-301e-4827-b869-e073e40ed2ba
createdTime: 1675932300663
createdBy: xxxxxxxxxx@reltio.com
updatedTime: 1675932300663
updatedBy: xxxxxxxxxx@reltio.com
type: com.reltio.businesslogic.tasks.reindex.ReindexDataTask
status: SCHEDULED
name: Reindexing of all types in tenant LocalTest
createdOnHost: DESKTOP-1N09DOF
parallelExecution: false
nodesGroup: default
parameters:
tenantId: LocalTest
updatedSince: '0'
eventQueueProcessors: crud_streaming,datapipeline_gbg_processor
streamingDestinations: >-
03ff3091f067027b0d484b4e02exxxxx_queue_local-datapipeline-events_LocalTest
currentState: {}
duration: 0s
- id: 95083a11-5a9a-4e88-829b-72c47f6d83c0
groupId: f33516d7-3bed-4b83-a181-1d979ca37ecd
createdTime: 1675932300663
createdBy: xxxxxxxxxx@reltio.com
updatedTime: 1675932300663
updatedBy: xxxxxxxxxx@reltio.com
type: com.reltio.businesslogic.tasks.reindex.ReindexRelationsTask
status: SCHEDULED
name: Reindexing of all types in tenant LocalTest
createdOnHost: DESKTOP-1N09DOF
parallelExecution: false
nodesGroup: default
parameters:
tenantId: LocalTest
updatedSince: '0'
eventQueueProcessors: crud_streaming,datapipeline_gbg_processor
streamingDestinations: >-
03ff3091f067027b0d484b4e02exxxxx_queue_local-datapipeline-events_LocalTest
currentState: {}
duration: 0s
- id: b55f3365-72ab-4afd-82b0-7f76f7b70459
groupId: 77aa4edc-7186-4c2c-a81e-fb6f6752bd3d
createdTime: 1675932300663
createdBy: xxxxxxxxxx@reltio.com
updatedTime: 1675932300663
updatedBy: xxxxxxxxxx@reltio.com
type: >-
com.reltio.businesslogic.tasks.reindex.ReindexInteractionsTask
status: SCHEDULED
name: Reindexing interactions in tenant LocalTest
createdOnHost: DESKTOP-1N09DOF
parallelExecution: false
nodesGroup: default
parameters:
tenantId: LocalTest
updatedSince: '0'
eventQueueProcessors: crud_streaming,datapipeline_gbg_processor
streamingDestinations: >-
03ff3091f067027b0d484b4e02exxxxx_queue_local-datapipeline-events_LocalTest
currentState: {}
duration: 0s
- id: 67276b26-def0-4cce-9d5d-5945a9d83941
groupId: 1b99f4c6-b34a-40e5-a94b-1ae353bb18b1
createdTime: 1675932300663
createdBy: xxxxxxxxxx@reltio.com
updatedTime: 1675932300663
updatedBy: xxxxxxxxxx@reltio.com
type: >-
com.reltio.businesslogic.tasks.reindex.PotentialMatchesReindexTask
status: SCHEDULED
name: >-
Reindexing potential matches information for tenant
LocalTest
createdOnHost: DESKTOP-1N09DOF
parallelExecution: false
nodesGroup: default
parameters:
tenantId: LocalTest
updatedSince: '0'
eventQueueProcessors: crud_streaming,datapipeline_gbg_processor
streamingDestinations: >-
03ff3091f067027b0d484b4e02exxxxx_queue_local-datapipeline-events_LocalTest
currentState: {}
duration: 0s
- id: 54f016a7-b2c1-4107-bea0-e8b3addafa92
groupId: d1d1f194-ba26-4cb4-aa09-bfcc54dbe7b7
createdTime: 1675932300663
createdBy: xxxxxxxxxx@reltio.com
updatedTime: 1675932300663
updatedBy: xxxxxxxxxx@reltio.com
type: com.reltio.businesslogic.tasks.reindex.ReindexMergesTask
status: SCHEDULED
name: Reindexing of merges in tenant LocalTest
createdOnHost: DESKTOP-1N09DOF
parallelExecution: false
nodesGroup: default
parameters:
tenantId: LocalTest
updatedSince: '0'
eventQueueProcessors: match_streaming,datapipeline_gbg_processor
streamingDestinations: >-
03ff3091f067027b0d484b4e02exxxxx_queue_local-datapipeline-events_LocalTest
currentState: {}
duration: 0s
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/DPH%20Reindex%20Jobs/syncToDataPipeline
/services/reltio/api/{tenantId}/verification/emailVerifyTask:
post:
tags:
- Verification Jobs
summary: Starts a background job to verify email attributes for tenant entities
description: >-
Schedules an asynchronous background task to verify entity email
attributes using the configured external verifier.
- You may restrict
verification to a specific entity type using the 'entityType'
parameter.
- You can limit verification to a specific subset of
entities by providing a JSON array of entity URIs in the request
body.
- Verification can also be filtered to only entities updated
after a certain time, or to force re-verification bypassing cache.
-
Configurable batch size.
If entityType is omitted, all entity types
will be checked. If a list of URIs is provided, only those entities will
be verified.
operationId: startEmailVerificationTask
parameters:
- name: tenantId
in: path
description: >-
ID of the tenant for which the email verification task will be
scheduled
required: true
schema:
type: string
example:
- name: entityType
in: query
description: >-
Restrict verification to this entity type. If absent, verification
runs for all entity types.
schema:
type: string
example: Individual
- name: updatedSince
in: query
description: >-
If specified, only entities updated on or after this UNIX timestamp
will be verified.
schema:
type: Long
example: '1627849267000'
- name: forceVerify
in: query
description: >-
If true, verifies all scoped entities by calling the external
verifier(s) regardless of previous verification results (bypassing
verification cache).
schema:
type: boolean
default: false
example: false
- name: batchSize
in: query
description: >-
Specifies the number of entities to verify per batch during
processing. Default is 100.
schema:
type: Integer
example: '10'
requestBody:
description: >-
Optional: JSON array of specific entity URIs to restrict email
verification to that set (e.g. ['entities/aaaa', 'entities/bbbb']).
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAdminController'
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: urisList
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Verification%20Jobs/startEmailVerificationTask
/services/reltio/api/{tenantId}/verification/phoneVerifyTask:
post:
tags:
- Verification Jobs
summary: Starts a background job to verify phone attributes for tenant entities
description: >-
Schedules an asynchronous background task to verify entity phone
attributes using the configured external verifier.
- You may restrict
verification to a specific entity type using the 'entityType'
parameter.
- You can limit verification to a specific subset of
entities by providing a JSON array of entity URIs in the request
body.
- Verification can also be filtered to only entities updated
after a certain time, or to force re-verification bypassing cache.
-
Configurable batch size.
If entityType is omitted, all entity types
will be checked. If a list of URIs is provided, only those entities will
be verified.
operationId: startPhoneVerificationTask
parameters:
- name: tenantId
in: path
description: >-
ID of the tenant for which the phone verification task will be
scheduled
required: true
schema:
type: string
example:
- name: entityType
in: query
description: >-
Restrict verification to this entity type. If absent, verification
runs for all entity types.
schema:
type: string
example: Individual
- name: updatedSince
in: query
description: >-
If specified, only entities updated on or after this UNIX timestamp
will be verified.
schema:
type: Long
example: '1627849267000'
- name: forceVerify
in: query
description: >-
If true, verifies all scoped entities by calling the external
verifier(s) regardless of previous verification results (bypassing
verification cache).
schema:
type: boolean
default: false
example: false
- name: batchSize
in: query
description: >-
Specifies the number of entities to verify per batch during
processing. Default is 100.
schema:
type: Integer
example: '10'
requestBody:
description: >-
Optional: JSON array of specific entity URIs to restrict phone
verification to that set (e.g. ["entities/aaaa", "entities/bbbb"]).
content:
application/json:
schema:
$ref: '#/components/schemas/TenantAdminController'
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PeriodicTaskTO'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantAdminController
x-codegen-request-body-name: urisList
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Verification%20Jobs/startPhoneVerificationTask
/services/reltio/tenants/{tenantId}/enableV2Interactions:
put:
tags:
- Enable V2 Interactions
summary: Enable V2 Interaction for tenant
description: 'This API enables V2 Interactions for the tenant. '
operationId: enableV2Interactions
parameters:
- name: tenantId
in: path
description: ID of the tenant to enable V2 Interactions for.
required: true
schema:
type: string
example:
- name: force
in: query
description: >-
true / false - If true then V2 interactions will be force enabled
even if they are already enabled.
schema:
type: string
example: force=true
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfiguration'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.admin.TenantsController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Enable%20V2%20Interactions/enableV2Interactions
/services/reltio/tools/{tenantId}/analyzeMatchRules/v2:
post:
tags:
- Match Jobs
summary: >-
A Background job which is used to perform the match rule analysis using
the current match rule configuration in the tenant or using the supplied
match configuration in the request
description: >-
The API call submits the match rules analysis for the given match rules
configuration and the existing entities
operationId: analyzeMatchRulesV2Tools
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
requestBody:
description: The specification of the requested analysis
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeMatchRulesV2Payload'
examples:
sample:
description: Sample request for API
value:
entityTypes:
- Location
- HCP
staticAnalysis:
enabled: true
hideEmptyResults: true
profiling:
enabled: true
useSkippedRules: false
scopes:
- INTERNAL
- EXTERNAL
required: false
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeMatchRulesV2Response'
example:
staticAnalysis:
- entityType: configuration/entityTypes/Location
attributeList:
- >-
configuration/entityTypes/Location/attributes/AddressLine1
- >-
configuration/entityTypes/Location/attributes/AddressLine2
- configuration/entityTypes/Location/attributes/City
- configuration/entityTypes/Location/attributes/Country
- >-
configuration/entityTypes/Location/attributes/StateProvince
- >-
configuration/entityTypes/Location/attributes/Zip/attributes/Zip5
tokenizationGroups:
- id: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
matchGroup: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
type: automatic
attributes:
- uri: >-
configuration/entityTypes/Location/attributes/AddressLine1
operands:
- path:
- and
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/Location/attributes/AddressLine2
operands:
- path:
- and
- ''
- exactOrAllNull
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: configuration/entityTypes/Location/attributes/City
operands:
- path:
- and
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/Location/attributes/Country
operands:
- path:
- and
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/Location/attributes/StateProvince
operands:
- path:
- and
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/Location/attributes/Zip/attributes/Zip5
operands:
- path:
- and
- ''
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
comparatorGroups:
- id: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
matchGroup: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
type: automatic
attributes:
- uri: >-
configuration/entityTypes/Location/attributes/AddressLine1
operands:
- path:
- and
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/Location/attributes/AddressLine2
operands:
- path:
- and
- ''
- exactOrAllNull
ignoreInToken: true
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: configuration/entityTypes/Location/attributes/City
operands:
- path:
- and
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/Location/attributes/Country
operands:
- path:
- and
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/Location/attributes/StateProvince
operands:
- path:
- and
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/Location/attributes/Zip/attributes/Zip5
operands:
- path:
- and
- ''
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
useOvOnly: true
- entityType: configuration/entityTypes/HCP
attributeList:
- configuration/entityTypes/HCP/attributes/FirstName
- >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID
- >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status
- >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type
- configuration/entityTypes/HCP/attributes/LastName
- configuration/entityTypes/HCP/attributes/ME
tokenizationGroups:
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
type: automatic
attributes:
- uri: configuration/entityTypes/HCP/attributes/FirstName
operands:
- path:
- and
- and
- ''
- fuzzy
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactNumberMatchToken
- uri: configuration/entityTypes/HCP/attributes/LastName
operands:
- path:
- and
- and
- ''
- fuzzy
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactNumberMatchToken
- uri: configuration/entityTypes/HCP/attributes/ME
operands:
- path:
- and
- and
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactNumberMatchToken
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: automatic
attributes:
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID
operands:
- path:
- and
- and
- ''
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type
constraints:
- type: equals
values:
- ims id
attribute:
path:
- Identifiers
- Type
nested: false
weight: 1
ovOnly: false
useCleansed: false
ignoreInToken: false
inspectionResults:
- inspectionId: SimilarTokenDefinitionInspection
issues:
- id: similarTokenDefinition
severity: MEDIUM
text: >-
Token definitions in rules {1} and {2} are
very similar
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: tokenizationGroupId
- id: '2'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: tokenizationGroupId
recommendations:
- id: similarTokenDefinition
text: >-
Consider removing one of the rules {1} or {2}
or combining them into one rule
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: tokenizationGroupId
- id: '2'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: tokenizationGroupId
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: suspect
attributes:
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID
operands:
- path:
- and
- and
- ''
- ''
- exact
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status
operands:
- path:
- and
- and
- ''
- ''
- exactOrNull
matchTokenConfig:
matchTokenClass: com.reltio.match.token.ExactMatchToken
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type
constraints:
- type: equals
values:
- tm
attribute:
path:
- Identifiers
- Type
nested: false
weight: 1
ovOnly: false
useCleansed: false
ignoreInToken: false
inspectionResults:
- inspectionId: SimilarTokenDefinitionInspection
issues:
- id: similarTokenDefinition
severity: MEDIUM
text: >-
Token definitions in rules {1} and {2} are
very similar
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: tokenizationGroupId
- id: '2'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: tokenizationGroupId
recommendations:
- id: similarTokenDefinition
text: >-
Consider removing one of the rules {1} or {2}
or combining them into one rule
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: tokenizationGroupId
- id: '2'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: tokenizationGroupId
comparatorGroups:
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
type: automatic
attributes:
- uri: configuration/entityTypes/HCP/attributes/FirstName
operands:
- path:
- and
- and
- ''
- fuzzy
ignoreInToken: true
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.DynamicDamerauLevenshteinDistance
- uri: configuration/entityTypes/HCP/attributes/LastName
operands:
- path:
- and
- and
- ''
- fuzzy
ignoreInToken: true
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.DynamicDamerauLevenshteinDistance
- uri: configuration/entityTypes/HCP/attributes/ME
operands:
- path:
- and
- and
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
useOvOnly: false
inspectionsResults:
- inspectionId: TokenComparatorContractViolationInspection
issues:
- id: tokenComparatorContractViolation
severity: MEDIUM
text: >-
Comparator class {1} does not conform to match
token class {2} for attribute {3}. This might
lead to violation of contract between match
token and comparator
parameters:
- id: '1'
value: >-
com.reltio.match.comparator.DynamicDamerauLevenshteinDistance
type: comparatorClass
- id: '2'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '3'
value: >-
configuration/entityTypes/HCP/attributes/FirstName
type: attributeUri
- id: tokenComparatorContractViolation
severity: MEDIUM
text: >-
Comparator class {1} does not conform to match
token class {2} for attribute {3}. This might
lead to violation of contract between match
token and comparator
parameters:
- id: '1'
value: >-
com.reltio.match.comparator.DynamicDamerauLevenshteinDistance
type: comparatorClass
- id: '2'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '3'
value: >-
configuration/entityTypes/HCP/attributes/LastName
type: attributeUri
- id: tokenComparatorContractViolation
severity: MEDIUM
text: >-
Comparator class {1} does not conform to match
token class {2} for attribute {3}. This might
lead to violation of contract between match
token and comparator
parameters:
- id: '1'
value: >-
com.reltio.match.comparator.BasicStringComparator
type: comparatorClass
- id: '2'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '3'
value: >-
configuration/entityTypes/HCP/attributes/ME
type: attributeUri
recommendations:
- id: tokenComparatorContractViolation
text: >-
Reltio recommends use of corresponding match
token and comparator classes. Consider
changing match token class {1}, e.g. to {2}
parameters:
- id: '1'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '2'
value: >-
com.reltio.match.token.FuzzyTextAndNumberMatchToken
type: matchTokenClass
- id: tokenComparatorContractViolation
text: >-
Reltio recommends use of corresponding match
token and comparator classes. Consider
changing match token class {1}, e.g. to {2}
parameters:
- id: '1'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '2'
value: >-
com.reltio.match.token.FuzzyTextAndNumberMatchToken
type: matchTokenClass
- id: tokenComparatorContractViolation
text: >-
Reltio recommends use of corresponding match
token and comparator classes. Consider
changing match token class {1}, e.g. to {2}
parameters:
- id: '1'
value: >-
com.reltio.match.token.ExactNumberMatchToken
type: matchTokenClass
- id: '2'
value: com.reltio.match.token.ExactMatchToken
type: matchTokenClass
- inspectionId: PreferOvOnlyEntityInspection
recommendations:
- id: ovOnlyIsNotSetForMatchGroup
text: >-
Reltio recommends to set 'useOvOnly' for match
groups. Consider changing 'useOvOnly' to true
for {1}
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
type: matchGroupUri
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: automatic
attributes:
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID
operands:
- path:
- and
- and
- ''
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type
ignoreInToken: false
constraints:
- type: equals
values:
- ims id
attribute:
path:
- Identifiers
- Type
nested: false
weight: 1
ovOnly: false
useCleansed: false
ignoreInToken: false
useOvOnly: false
inspectionsResults:
- inspectionId: PreferOvOnlyEntityInspection
recommendations:
- id: ovOnlyIsNotSetForMatchGroup
text: >-
Reltio recommends to set 'useOvOnly' for match
groups. Consider changing 'useOvOnly' to true
for {1}
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
type: matchGroupUri
- id: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
matchGroup: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: suspect
attributes:
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/ID
operands:
- path:
- and
- and
- ''
- ''
- exact
ignoreInToken: false
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Status
operands:
- path:
- and
- and
- ''
- ''
- exactOrNull
ignoreInToken: true
comparatorConfig:
comparatorClass: >-
com.reltio.match.comparator.BasicStringComparator
- uri: >-
configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type
ignoreInToken: false
constraints:
- type: equals
values:
- tm
attribute:
path:
- Identifiers
- Type
nested: false
weight: 1
ovOnly: false
useCleansed: false
ignoreInToken: false
useOvOnly: false
inspectionsResults:
- inspectionId: PreferOvOnlyEntityInspection
recommendations:
- id: ovOnlyIsNotSetForMatchGroup
text: >-
Reltio recommends to set 'useOvOnly' for match
groups. Consider changing 'useOvOnly' to true
for {1}
parameters:
- id: '1'
value: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
type: matchGroupUri
profiling:
description: >-
Summary about execution of the match groups based on the
existing data (tenantId={tenantId})
id: af46c8fd-fd36-4fb9-92eb-838de99d8f36
uri: >-
analyzeMatchRules/v2/profiling/af46c8fd-fd36-4fb9-92eb-838de99d8f36
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.match.AnalyzeMatchRulesController
x-codegen-request-body-name: body
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/analyzeMatchRulesV2Tools
/services/reltio/tools/{tenantId}/analyzeMatchRules/v2/precision/{taskId}:
get:
tags:
- Match Jobs
summary: Returns the results of the match rule analysis precision job
description: >-
The API requests the currently available results of the match precision
analysis by the identifier
operationId: getMatchRulesPrecisionResultTools
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: taskId
in: path
description: The identifier of the analysis
required: true
schema: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PrecisionResult'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.match.AnalyzeMatchRulesController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/getMatchRulesPrecisionResultTools
/services/reltio/tools/{tenantId}/analyzeMatchRules/v2/profiling/{profilingId}:
get:
tags:
- Match Jobs
summary: Returns the results of the match rule analysis profiling job
description: >-
The API requests the currently available results of the profiling
analysis by the identifier
operationId: getMatchRulesProfilingResultTools
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: profilingId
in: path
description: The identifier of the analysis
required: true
schema: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ProfilingResult'
example:
status: COMPLETED
startTimestamp: 1610748891486
startTime: '2021-01-15T22:14:51.486Z'
finishTimestamp: 1610748891583
finishTime: '2021-01-15T22:14:51.583Z'
duration: 97
totalObjectsProcessed: 0
useSkippedRules: false
scopes:
- INTERNAL
- EXTERNAL
objectsProcessed:
configuration/entityTypes/Location: 0
configuration/entityTypes/HCP: 0
entityTypes:
- entityType: configuration/entityTypes/Location
analyses:
- analysisType: matchDocumentMatches
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: histogram
parameters:
nbins: 100
- name: countFrequency
parameters:
lower: 20
upper: 2147483647
examplesAmount: 30
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 5
upper: 20
examplesAmount: 30
value:
frequency: 0
total: 0
inspections:
- uid: 8-a3b118b7-3699-4942-a61b-28d7151198a6
inspectionId: tooManyMatches
parameters:
- name: thresholdError
value: 20
- name: thresholdWarning
value: 5
- name: thresholdPercentage
value: 5
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchDocumentsPerMatchGroup
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: frequencies
inspections:
- uid: 7-31c301ba-032d-49ba-b66a-ef885d26c199
inspectionId: uselessMatchGroups
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchGroupsPerMatchDocument
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: mostFrequent
parameters:
k: 10
- analysisType: matchToken
enabled: true
perMatchGroup: true
splitByMatchGroupType: true
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 5
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 300
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 1-d562bfb7-1e95-4222-8e79-c8270cbcc6e8
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 300
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 2-74840ebc-fb06-48db-b322-4aecf38cf130
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 5
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 1
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 150
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 3-a0b1350d-753b-44b3-800b-489812155f23
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 150
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 4-7b3220aa-7740-4da7-b61f-dad6341d24e1
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 1
- name: thresholdEntitiesPercentage
value: 20
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-type-automatic
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 5
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 300
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 5-06d33ac4-fd2b-4d6c-8653-9de86ea3638e
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 300
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 6-f744527d-2c97-4e43-8671-e8d51e59c7b6
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 5
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchTokenIntersections
enabled: true
perMatchGroup: true
splitByMatchGroupType: true
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-type-automatic
matchGroups:
- uri: >-
configuration/entityTypes/Location/matchGroups/AutoMatch
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- entityType: configuration/entityTypes/HCP
analyses:
- analysisType: matchDocumentMatches
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: histogram
parameters:
nbins: 100
- name: correlation
- name: countFrequency
parameters:
lower: 20
upper: 2147483647
examplesAmount: 30
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 5
upper: 20
examplesAmount: 30
value:
frequency: 0
total: 0
inspections:
- uid: 22-d5ab2c07-b7fa-4c52-b8b7-781127be1874
inspectionId: highlyCorrelatedMatchGroups
parameters:
- name: thresholdError
value: 0.95
- name: thresholdWarning
value: 0.9
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 23-1f9b391e-73f0-4657-bb2f-0f2ab3e06e7c
inspectionId: tooManyMatches
parameters:
- name: thresholdError
value: 20
- name: thresholdWarning
value: 5
- name: thresholdPercentage
value: 5
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchDocumentsPerMatchGroup
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: frequencies
inspections:
- uid: 21-c8b9e183-ecd0-47bf-966d-b68e5b7a28e5
inspectionId: uselessMatchGroups
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchGroupsPerMatchDocument
enabled: true
perMatchGroup: false
splitByMatchGroupType: false
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: mostFrequent
parameters:
k: 10
- name: covariance
- name: correlation
- analysisType: matchToken
enabled: true
perMatchGroup: true
splitByMatchGroupType: true
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 5
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 300
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 9-d48ad0bf-9a6d-402d-ba43-6bfbfcacb1aa
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 300
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 10-5488200a-826f-43ed-9bc7-1d274dc779c3
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 5
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 1
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 150
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 11-99e201fc-91fa-478b-ad04-061f782e5952
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 150
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 12-c6a9b2e0-6f0b-42b1-a890-dd87885a9079
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 1
- name: thresholdEntitiesPercentage
value: 20
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 1
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 150
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 13-b5e18b66-fa0f-4227-992e-df85402fd219
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 150
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 14-0c4bae7a-defc-4011-8382-d69e6aa56fe3
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 1
- name: thresholdEntitiesPercentage
value: 20
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 1
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 150
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 15-3bd9e7ce-3d9a-4f5b-84a9-27e53afe02ba
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 150
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 16-846f6911-845e-499f-a2db-4e3e0c381196
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 1
- name: thresholdEntitiesPercentage
value: 20
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-type-automatic
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 5
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 300
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 17-1ea1b439-7676-4168-b51b-1169d13b8fe2
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 300
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 18-8e026fac-8613-4653-88f9-c22a388b0c07
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 5
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- type: match-group-type-suspect
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: mostFrequent
parameters:
k: 10
- name: histogram
parameters:
nbins: 100
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- name: countFrequency
parameters:
lower: 0
upper: 5
examplesAmount: 10
value:
frequency: 0
total: 0
- name: countFrequency
parameters:
lower: 300
upper: 2147483647
examplesAmount: 10
value:
frequency: 0
total: 0
inspections:
- uid: 19-3637c90a-860b-4214-866d-9fa74249de24
inspectionId: tooManyTokens
parameters:
- name: thresholdManyTokens
value: 300
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- uid: 20-160c1ebe-51b9-4a9a-bd74-d359d9d44f44
inspectionId: veryFewTokens
parameters:
- name: thresholdFewTokens
value: 5
- name: thresholdEntitiesPercentage
value: 2
computationResults:
- name: entitiesPercentage
- name: examples
summary:
severity: INFO
explanation: {}
recommendation: {}
- analysisType: matchTokenIntersections
enabled: true
perMatchGroup: true
splitByMatchGroupType: true
projections:
- type: match-group-all
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-single
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-type-automatic
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByMEAuto
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIMSID
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
- type: match-group-type-suspect
matchGroups:
- uri: >-
configuration/entityTypes/HCP/matchGroups/PersonByIdentifiersSuspectId1
statistics:
- name: min
value: -1
- name: max
value: -1
- name: range
value: 0
- name: total
value: 0
- name: mean
value: -1
- name: std
value: -1
- name: median
value: -1
- name: firstQuartile
value: -1
- name: thirdQuartile
value: -1
- name: histogram
parameters:
nbins: 10
- name: upperBoundOutliers
parameters:
k: 1.5
details:
fence: -1
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.match.AnalyzeMatchRulesController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/getMatchRulesProfilingResultTools
/services/reltio/tools/{tenantId}/analyzeMatchRules/v2/{profilingId}/_stop:
put:
tags:
- Match Jobs
summary: The API initiates stopping of the job running the Match Rules Analysis
description: The API submits request to stop the analysis job
operationId: stopAnalyzeMatchRulesV2Tools
parameters:
- name: tenantId
in: path
description: ID of the tenant
required: true
schema:
type: string
- name: profilingId
in: path
description: The identifier of the analysis
required: true
schema: {}
requestBody: {}
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OperationStatusString'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Failed to parse content as JSON
errorCode: 150
errorDetailMessage: >-
Expecting request content in JSON format, failed to parse.
Reason: Code: UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
innerErrorData:
exception: >-
com.reltio.rest.data.marshalling.MarshallerException:Code:
UNMARSHALLING_IO_ERROR; Message parameters: [].
UnMarshalling I/O Error. UnMarshalling I/O Error
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorModel'
'403':
description: >-
The operation is forbidden for the current user, please check your
privileges
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Security error. This endpoint is forbidden for current user.
errorCode: 804
errorDetailMessage: Security error. This endpoint is forbidden for current user.
innerErrorData:
exception: >-
org.springframework.security.access.AccessDeniedException:Access
is denied at
org.springframework.security.access.vote.UnanimousBased.decide,
line 88
'404':
description: The requested resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Object with
id={entities|relations|changeRequests|interactions}/someId not
found
errorCode: 101
errorDetailMessage: No object with specified id found
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
OBJECT_NOT_FOUND; Message parameters:
[{entities|relations|changeRequests|interactions}/someId].
Object with
id={entities|relations|changeRequests|interactions}/someId
not found. No object with specified id found
'429':
description: Too many requests, please try later
'500':
description: Internal server error, see details in the returned error message
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
errorCode: 119
errorDetailMessage: >-
Type is not found for URI configuration/entityTypes/SomeType
and tenant SomeTenant
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException: Code:
TYPE_IS_NOT_FOUND; Message parameters:
[configuration/entityTypes/SomeType, SomeTenant]. Type is
not found for URI configuration/entityTypes/SomeType and
tenant SomeTenant. Type is not found for URI
configuration/entityTypes/SomeType and tenant SomeTenant
'503':
description: >-
This status code could represent 2 possible scenarios. First, the
'Service Unavailable' scenario. Second, this status code is used
when too many requests are being sent in-parallel and API
backpressure mechanism was used to protect the platform. In both
scenarios, an exponential backoff mechanism should be used to
control the rate of requests sent to the server.
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: Internal application error.
errorCode: 2001
errorDetailMessage: >-
Internal application exception caught during executing
operation. Please view application log for details
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INTERNAL_SERVER_ERROR; Message parameters: []. Internal
application exception caught during executing operation.
Please view application log for details
'507':
description: The request consumes more resources than it is allowed
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorRepresentation'
example:
severity: Error
errorMessage: The request might consume more resources than it is allowed
errorCode: 2006
errorDetailMessage: >-
The system detected that to process the request there are much
more resources required than it is allowed for the request
innerErrorData:
exception: >-
com.reltio.metadata.errors.CommonException:Code:
INSUFFICIENT_STORAGE; Message parameters: []. The system
detected that to process the request there are much more
resources required than it is allowed for the request
extensions:
x-module: server
x-controllerName: com.reltio.rest.match.AnalyzeMatchRulesController
x-path: >-
/private/swagger.htm?module=Tenant%20Management#/Match%20Jobs/stopAnalyzeMatchRulesV2Tools
components:
securitySchemes:
Basic Authentication:
type: http
scheme: basic
schemas:
TokenResponse:
type: object
properties:
access_token:
type: string
extensions: {}
exampleSetFlag: true
token_type:
type: string
extensions: {}
exampleSetFlag: true
refresh_token:
type: string
extensions: {}
exampleSetFlag: true
expires_in:
type: integer
extensions: {}
exampleSetFlag: true
scope:
type: string
extensions: {}
exampleSetFlag: true
description: Token Response
exampleSetFlag: false
TokenResponseError:
type: object
properties:
error:
type: string
extensions: {}
exampleSetFlag: true
error_description:
type: string
extensions: {}
exampleSetFlag: true
description: Token Error Response
exampleSetFlag: false
ReltioErrors:
type: object
properties:
severity:
type: string
errorMessage:
type: string
errorCode:
type: integer
format: int32
errorDetailMessage:
type: string
Error response:
type: object
properties:
status:
type: string
description: result of operation
readOnly: true
example: failed
error:
$ref: '#/components/schemas/Error'
description: If the error happened the API returns response in this format
Error:
type: object
properties:
errorCode:
type: integer
description: 5-digit error code
format: int32
readOnly: true
example: 10016
errorMessage:
type: string
description: Error Message
readOnly: true
example: 'Missing mandatory Parameter(s) : [EnvironmentURL]'
errorDetailMessage:
type: string
description: Error Detail Message
readOnly: true
example: 'Missing mandatory Parameter(s) : [EnvironmentURL]'
errorData:
$ref: '#/components/schemas/Error data'
innerError:
$ref: '#/components/schemas/ReltioResponse'
description: >-
Detailed description of the error including unique error code and
message
ReltioResponse:
type: object
properties:
index:
type: integer
format: int32
successful:
type: boolean
errors:
$ref: '#/components/schemas/ReltioErrors'
error:
type: string
error_description:
type: string
errorCode:
type: integer
format: int32
errorMessage:
type: string
errorDetailMessage:
type: string
innerErrorData:
type: object
uri:
type: string
status:
type: string
state:
type: string
responseCode:
type: integer
format: int32
Error data:
type: object
properties:
exception:
type: string
description: Exception message
readOnly: true
example: >-
com.reltio.workflow.core.KeyedException: User is not authorized to
perform this operation.
stack:
type: array
description: Stack trace
readOnly: true
items:
type: string
Deployment response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
deploymentId:
type: string
description: Id of new deployment
example: '123'
List Response Without Total:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
data:
type: array
description: Array with results
items:
type: object
discriminator:
propertyName: Nope
Clean Process Instances Request:
type: object
properties:
processDefinitionId:
type: string
description: Process definition ID
createdBy:
type: string
description: Initiator of the process instance
example: user1
startedAfter:
type: integer
description: Time in milliseconds
format: int64
startedBefore:
type: integer
description: Time in milliseconds
format: int64
processType:
type: string
description: Process Definition Type
example: reviewUpdateAttribute
objectURIs:
type: array
description: List of URIs for Reltio objects
example: '["entities/12345"]'
items:
type: string
List Response:
allOf:
- $ref: '#/components/schemas/List Response Without Total'
- type: object
properties:
total:
type: integer
description: No. of total records
format: int64
example: 1
Status response with multiple background tasks information:
allOf:
- $ref: '#/components/schemas/List Response'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Background task information'
BusinessProcessSyncBackgroundTaskData:
type: object
properties:
filter:
$ref: '#/components/schemas/Process Instances Request'
Background task information:
type: object
properties:
tenantId:
type: string
jobId:
type: string
format: uuid
Process Instances Request:
allOf:
- $ref: '#/components/schemas/Clean Process Instances Request'
- type: object
properties:
assignee:
type: string
description: Assignee of the active task
state:
type: string
description: Validation state of process instance, default value=all
enum:
- valid
- invalid
- all
Possible assignees Response:
allOf:
- $ref: '#/components/schemas/List Response'
- type: object
properties:
data:
type: array
description: Array with results
items:
type: string
Tasks Filter:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
variables:
type: array
description: List of Reltio task variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
localVariables:
type: array
description: List of Reltio task local variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
objectFilter:
type: string
description: Object filter
example: equals(attributes.FirstName,'Alex')
ApiPossibleAssigneeRequest:
type: object
properties:
tasks:
type: array
description: Task Ids
items:
type: string
filter:
$ref: '#/components/schemas/Tasks Filter'
exclude:
type: array
description: Task Ids to exclude from list (even if they satisfy the filter)
items:
type: string
AssigneeExplanationRequest:
type: object
properties:
username:
type: string
description: Username to verify
example: some.user
taskId:
type: string
description: Task id to check permissions against
example: '123456'
AssigneeExplanationCheck:
type: object
properties:
passed:
type: boolean
label:
type: string
details:
type: string
description: >-
A single check in the examination of the user for being an assignee. Al
the checks must be passed.
AssigneeExplanationDetails:
type: object
properties:
candidate:
$ref: '#/components/schemas/AssigneeExplanationCheck'
access:
$ref: '#/components/schemas/AssigneeExplanationCheck'
owner:
$ref: '#/components/schemas/AssigneeExplanationCheck'
workflow:
$ref: '#/components/schemas/AssigneeExplanationCheck'
description: The list of check of user examination.
AssigneeExplanationResponse:
type: object
properties:
possibleAssignee:
type: boolean
description: Overall status, shows if the user eligible to be the task assignee.
checks:
$ref: '#/components/schemas/AssigneeExplanationDetails'
Tasks Action:
type: object
properties:
action:
type: string
description: action name
label:
type: string
description: display value for the action
commentRequired:
type: boolean
description: Action requires a comment
Task Data:
type: object
properties:
assignee:
type: string
description: Task assignee
processInstanceId:
type: string
description: Process instance ID
processType:
type: string
description: Process instance type
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
createTime:
type: integer
description: Create time
format: int64
dueDate:
type: integer
description: Due date
format: int64
processInstanceComments:
type: array
description: Process instance comments
items:
$ref: '#/components/schemas/ProcessInstanceComment'
taskId:
type: string
description: Task ID
displayName:
type: string
description: Display name
processDefinitionDisplayName:
type: string
description: Process Definition Display Name
possibleActions:
type: array
description: Possible actions
items:
$ref: '#/components/schemas/Tasks Action'
priority:
type: integer
description: Priority
format: int32
preferredAction:
$ref: '#/components/schemas/Tasks Action'
repeatingTask:
type: boolean
description: indicates whether the task has been repeated or not
validationMessage:
type: string
description: validation message
taskVariables:
type: object
additionalProperties:
type: object
description: Task variables
taskLocalVariables:
type: object
additionalProperties:
type: object
description: Task local variables
valid:
type: boolean
description: true/false to indicate if the task is valid/not valid
discriminator:
propertyName: Nope
ProcessInstanceComment:
type: object
properties:
id:
type: string
message:
type: string
author:
type: string
time:
type: integer
format: int64
Tasks with variables request:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
variables:
type: array
description: List of Reltio task variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
localVariables:
type: array
description: List of Reltio task local variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
objectFilter:
type: string
description: Object filter
example: equals(attributes.FirstName,'Alex')
offset:
minimum: 0
type: integer
description: Start position
format: int32
max:
maximum: 2000
minimum: 1
type: integer
description: Number of records to be returned
format: int32
orderBy:
type: string
description: Sort criteria
enum:
- createTime
- assignee
- dueDate
- priority
ascending:
type: boolean
description: Used in combination with orderBy
showTaskVariables:
type: boolean
description: Show Task Variables
showTaskLocalVariables:
type: boolean
description: Show Task Local Variables
Tasks Response:
allOf:
- $ref: '#/components/schemas/List Response Without Total'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Task Data'
total:
type: integer
description: No. of total records
format: int64
example: 1
offset:
type: integer
description: Start position of records
format: int32
example: 0
size:
type: integer
description: No. of records returned
format: int32
example: 1
Update Task Request:
type: object
properties:
assignee:
type: string
description: Task assignee
dueDate:
type: integer
description: Due date for the task in milliseconds
format: int64
processInstanceComment:
type: string
description: User comment on the process instance
priority:
type: integer
description: Task priority
format: int32
enum:
- 1
- 50
- 100
- 1000
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
discriminator:
propertyName: Nope
BulkUpdateByFilterRequest:
required:
- changes
- filter
type: object
properties:
filter:
$ref: '#/components/schemas/Tasks Filter'
changes:
$ref: '#/components/schemas/Update Task Request'
exclude:
uniqueItems: true
type: array
description: >-
Task ids that shouldn't be updated (even if they are satisfy the
filter)
items:
type: string
Status response with background task information:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
backgroundTaskId:
type: string
description: Background task id
format: uuid
example: 82882053-73ef-4845-b2cd-6aebbcbe19d6
All jars response:
allOf:
- $ref: '#/components/schemas/List Response'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Jar Deployment'
Jar Deployment:
type: object
properties:
module:
type: string
description: Complete Jar path in S3
example: workflow/prod/OnboardingListeners.jar
name:
type: string
description: Name of new deployment
example: OnboardingCustomListeners
description:
type: string
description: Description for the deployment
example: Listeners to be used for Onboarding process
createdBy:
type: string
description: Name of the user
example: user1
createTime:
type: integer
description: Creation Time of the deployment
format: int64
example: 1234567890
discriminator:
propertyName: Nope
Jar Deployment Response:
allOf:
- $ref: '#/components/schemas/Jar Deployment'
- type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
Status response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
AggregatingBackgroundJobDTO:
type: object
properties:
id:
type: string
format: uuid
type:
type: string
state:
type: string
enum:
- SCHEDULED
- IN_PROGRESS
- COMPLETED
- FAILED
createdBy:
type: string
createdTime:
type: integer
format: int64
startTime:
type: integer
format: int64
endTime:
type: integer
format: int64
parameters:
type: string
name:
type: string
tenantId:
type: string
Bulk Action Tasks Filter:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Process instance type
example: dataChangeRequestReview
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
variables:
type: array
description: List of Reltio task variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
localVariables:
type: array
description: List of Reltio task local variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
objectFilter:
type: string
description: Object filter
example: equals(attributes.FirstName,'Alex')
Execute Task Request with forbidden taskId and objectURIs fields:
allOf:
- $ref: '#/components/schemas/Execute Task Request'
- type: object
BulkActionByFilterRequest:
required:
- requestAction
type: object
properties:
filter:
$ref: '#/components/schemas/Bulk Action Tasks Filter'
tasks:
type: array
description: Task Ids
items:
type: string
requestAction:
$ref: >-
#/components/schemas/Execute Task Request with forbidden taskId and
objectURIs fields
exclude:
uniqueItems: true
type: array
description: >-
Task ids to exclude from bulk requestAction (even if they are
satisfy the filter)
items:
type: string
Execute Task Request:
required:
- action
type: object
properties:
action:
type: string
description: Action for the task
processInstanceComment:
type: string
description: User comment on the process instance
discriminator:
propertyName: Nope
GBQtoHubSyncRequest:
type: object
properties:
timestamp:
type: integer
format: int64
timestampFrom:
type: integer
format: int64
timestampTo:
type: integer
format: int64
objectURIs:
type: string
processInstanceId:
type: string
taskId:
type: string
processType:
type: string
taskType:
type: string
processInstanceCreateTime:
type: integer
format: int64
processInstanceCreateTimeFrom:
type: integer
format: int64
processInstanceCreateTimeTo:
type: integer
format: int64
taskCreateTime:
type: integer
format: int64
taskCreateTimeFrom:
type: integer
format: int64
taskCreateTimeTo:
type: integer
format: int64
username:
type: string
assignee:
type: string
processInstanceDueDate:
type: integer
format: int64
processInstanceDueDateFrom:
type: integer
format: int64
processInstanceDueDateTo:
type: integer
format: int64
decision:
type: string
userActivityTime:
type: integer
format: int64
userActivityTimeFrom:
type: integer
format: int64
userActivityTimeTo:
type: integer
format: int64
processInstanceComplete:
type: boolean
processInstanceCompletionTime:
type: integer
format: int64
processInstanceCompletionTimeFrom:
type: integer
format: int64
processInstanceCompletionTimeTo:
type: integer
format: int64
processSuspended:
type: boolean
ProcessResponseData:
type: object
properties:
id:
type: string
type:
type: string
name:
type: string
description:
type: string
displayName:
type: string
tenantId:
type: string
processInstanceId:
type: string
suspended:
type: boolean
processDefinitionId:
type: string
entityTypeURIs:
type: array
items:
type: string
objectURIs:
type: array
items:
type: string
possibleAssignees:
type: array
items:
type: string
dueDateDelta:
type: integer
format: int32
objectTypes:
type: array
items:
type: string
currentTasks:
type: array
items:
$ref: '#/components/schemas/CurrentTasksResponse'
manualStart:
type: boolean
message:
type: string
author:
type: string
time:
type: integer
format: int64
processType:
type: string
Workflow task details:
type: object
properties:
taskId:
type: string
description: ID of the task
example: '23726752'
taskDisplayName:
type: string
description: Name of the task
example: DCR Review
taskLocalVariables:
type: object
additionalProperties:
type: object
description: Local variables of the task
taskVariables:
type: object
additionalProperties:
type: object
description: Variables that are shared across tasks within the process instance
ProcessResponse:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
total:
type: integer
description: No. of total records
format: int64
example: 1
offset:
type: integer
format: int32
size:
type: integer
format: int32
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/ProcessResponseData'
The list of available JARs for the tenant:
type: object
properties:
limitExceeded:
type: boolean
description: True if number of JARs in the directory exceeds 1000 files
example: false
total:
type: integer
description: Total number of JARs in the directory
format: int32
example: 1
jars:
type: array
description: List of JARs
items:
$ref: '#/components/schemas/An external JAR module'
An external JAR module:
type: object
properties:
module:
type: string
description: Module url
example: reltio.workflow-custom-jars/myCompany/my-custom-workflow-1.0.jar
updateTime:
type: integer
description: JAR upload time
format: int64
example: 1582213200000
size:
type: integer
description: Size of the JAR file in bytes
format: int64
example: 123456
Filter for getting available jars:
type: object
properties:
max:
type: integer
description: Maximum records to return
format: int32
example: 100
offset:
type: integer
description: Return records starting from this number
format: int32
orderBy:
type: string
description: Result ordering type
enum:
- module
- updateTime
ascending:
type: boolean
description: Whether to sort results in ascending or descending order
Operations Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
operations:
uniqueItems: true
type: array
description: list of operations the user is eligible for
items:
type: string
Process Count Response:
allOf:
- $ref: '#/components/schemas/List Response'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/ProcessCountResponseData'
ProcessCountResponseData:
type: object
properties:
processType:
type: string
noOfInstances:
type: integer
format: int32
Process Definition List:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Process Definition'
total:
type: integer
description: No. of total records
format: int64
example: 1
offset:
type: integer
description: Start position of records
format: int32
example: 0
size:
type: integer
description: No. of records returned
format: int32
example: 1
Process Definition:
type: object
properties:
id:
type: string
description: process definition ID
type:
type: string
description: process definition key (provided while designing the process)
description:
type: string
description: >-
process definition description (provided while designing the
process)
displayName:
type: string
description: process definition name (provided while designing the process)
objectTypes:
type: array
description: entity types on which this process is applicable
items:
type: string
manualStart:
type: boolean
description: >-
indicator for whether the process definition can be started from
Workflow tab
deploymentId:
type: string
description: deployment id of the process definition
deployTime:
type: integer
description: time of the deployment
format: int64
deployedBy:
type: string
description: user's name who deployed
generic:
type: boolean
description: ' true/false (generic or tenant-specific deployment)'
fileName:
type: string
description: File name of the process definition
requiresCommentOnStart:
type: boolean
description: Whether a comment is required to start the process
Filter Process Definition:
type: object
properties:
max:
type: integer
description: Maximum records to return
format: int32
example: 100
offset:
type: integer
description: Return records starting from this number
format: int32
orderBy:
type: string
description: Result ordering type
enum:
- module
- updateTime
ascending:
type: boolean
description: Whether to sort results in ascending or descending order
Start Process Request With Comment:
required:
- objectURIs
- processType
type: object
properties:
processType:
type: string
description: Process Definition Type
example: reviewUpdateAttribute
objectURIs:
type: array
description: List of URIs for Reltio objects
example: '["entities/12345"]'
items:
type: string
comment:
type: string
description: Process Instance comment
example: Started Review update attribute process
variables:
type: object
additionalProperties:
type: string
description: Variables map of the process
example: '{"key1": "value1", "key2": "value2"}'
Process Instance Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
processInstanceId:
type: string
description: Process Instance ID
example: '1234'
discriminator:
propertyName: Nope
Process Instance List Response:
allOf:
- $ref: '#/components/schemas/List Response'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: >-
#/components/schemas/Process Instance With Object URIs
Response
taskId:
type: string
description: Background task ID for tracking
readOnly: true
Start process instance from search query request:
allOf:
- $ref: '#/components/schemas/Start Process By Type Request'
- required:
- searchString
type: object
properties:
searchString:
type: string
description: Search String
example: >-
((equals(type,'configuration/entityTypes/SoldToCustomer'))and(range(matches,5,6)))
Process Instance With Object URIs Response:
type: object
properties:
processInstanceId:
type: string
description: Process Instance ID
example: '1234'
objectURIs:
type: array
description: URI of pair of entities to be match-reviewed
items:
type: string
Start Process By Type Request:
required:
- processType
type: object
properties:
processType:
type: string
description: Process Definition Type
example: reviewUpdateAttribute
discriminator:
propertyName: Nope
Filter Process Request:
type: object
properties:
suspended:
type: boolean
description: Is suspended
offset:
type: integer
description: Start position
format: int32
example: 0
max:
type: integer
description: No. of records to be returned
format: int32
example: 1
processType:
type: string
description: Process Definition Type
example: reviewUpdateAttribute
objectURIs:
type: array
description: List of URIs for Reltio objects
example: '["entities/12345"]'
items:
type: string
Filtered Process Instance:
type: object
properties:
processInstanceId:
type: string
description: process instance ID
example: '5'
suspended:
type: boolean
description: Is suspended
processDefinitionId:
type: string
description: process definition ID
example: reviewDeleteEntity:1:3
processType:
type: string
description: process definition type
example: reviewDeleteEntity
Filtered Process Instance List Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Filtered Process Instance'
total:
type: integer
description: No. of total records
format: int64
example: 1
offset:
type: integer
description: Start position of records
format: int32
example: 0
size:
type: integer
description: No. of records returned
format: int32
example: 1
Process Instance Details Response:
allOf:
- $ref: '#/components/schemas/Process Instance Response'
- type: object
properties:
processDefinitionId:
type: string
description: process definition ID
example: dataChangeRequestReview:118:23001979
processType:
type: string
description: process definition type
example: dataChangeRequestReview
suspended:
type: boolean
description: is suspended
currentTasks:
type: array
description: current open tasks of the process instance
items:
$ref: '#/components/schemas/Workflow task details'
objectURIs:
type: array
description: URIs of objects related to the process
example: '["changeRequests/5SnP3mfD","entities/tKN8XEt"]'
items:
type: string
processVariables:
type: object
additionalProperties:
type: object
description: Process variables
All Tasks Response:
allOf:
- $ref: '#/components/schemas/List Response Without Total'
- type: object
properties:
data:
type: array
description: Array with results
items:
$ref: '#/components/schemas/Full Task Data'
total:
type: integer
description: No. of total records
format: int64
example: 1
offset:
type: integer
description: Start position of records
format: int32
example: 0
size:
type: integer
description: No. of records returned
format: int32
example: 1
Full Task Data:
allOf:
- $ref: '#/components/schemas/Task Data'
- type: object
properties:
isOpen:
type: boolean
description: true/false to indicate if the task is open/closed
updateTime:
type: integer
description: time of the last update on the task
format: int64
completedAction:
$ref: '#/components/schemas/Tasks Action'
completeTime:
type: integer
description: time of the task completion (for closed tasks only)
format: int64
completedBy:
type: string
description: user that completed this task (for closed tasks only)
Update Task Request via Batch:
allOf:
- $ref: '#/components/schemas/Update Task Request'
- required:
- taskId
type: object
properties:
taskId:
type: string
description: Task ID
example: '22591486'
Multiple Tasks Update Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
data:
type: object
additionalProperties:
type: object
description: Successfully updated task ids
Tasks Request:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
variables:
type: array
description: List of Reltio task variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
localVariables:
type: array
description: List of Reltio task local variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
objectFilter:
type: string
description: Object filter
example: equals(attributes.FirstName,'Alex')
offset:
minimum: 0
type: integer
description: Start position
format: int32
max:
maximum: 2000
minimum: 1
type: integer
description: Number of records to be returned
format: int32
orderBy:
type: string
description: Sort criteria
enum:
- createTime
- assignee
- dueDate
- priority
ascending:
type: boolean
description: Used in combination with orderBy
discriminator:
propertyName: Nope
Get all task assignees Request:
type: object
properties:
createdBy:
type: string
description: Creator of the tasks
open:
type: boolean
description: Whether to scan open or closed tasks
User names list response:
type: object
properties:
users:
type: array
description: list of user names
items:
type: string
Get all task creators Request:
type: object
properties:
assignee:
type: string
description: Tasks assignee
open:
type: boolean
description: Whether to scan open or closed tasks
All tasks with variables request:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
variables:
type: array
description: List of Reltio task variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
localVariables:
type: array
description: List of Reltio task local variables (key/value pairs)
example: '[{"name1":"value1"},{"name1":"value2"},{"name2":"value2"}]'
items:
type: object
additionalProperties:
type: string
objectFilter:
type: string
description: Object filter
example: equals(attributes.FirstName,'Alex')
offset:
minimum: 0
type: integer
description: Start position
format: int32
max:
maximum: 2000
minimum: 1
type: integer
description: Number of records to be returned
format: int32
orderBy:
type: string
description: Sort criteria
enum:
- createTime
- assignee
- dueDate
- priority
ascending:
type: boolean
description: Used in combination with orderBy
open:
type: boolean
description: Return open tasks
completedAfter:
type: integer
description: Time in milliseconds
format: int64
completedBefore:
type: integer
description: Time in milliseconds
format: int64
completedBy:
type: string
description: Username
showTaskVariables:
type: boolean
description: Show Task Variables
showTaskLocalVariables:
type: boolean
description: Show Task Local Variables
All Tasks Variables Request:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
open:
type: boolean
description: Return open tasks
completedAfter:
type: integer
description: Time in milliseconds
format: int64
completedBefore:
type: integer
description: Time in milliseconds
format: int64
completedBy:
type: string
description: Username
Variables Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
taskVariables:
type: array
description: Array with task variables
items:
type: string
taskLocalVariables:
type: array
description: Array with task local variables
items:
type: string
Open Tasks Variables Request:
type: object
properties:
assignee:
type: string
description: Task assignee
example: user1
processInstanceId:
type: string
description: Process instance ID
example: '23726741'
processType:
type: string
description: Deprecated. Process instance type
example: dataChangeRequestReview
processTypes:
type: array
description: Process instance types
example: '["dataChangeRequestReview","accountReview"]'
items:
type: string
suspended:
type: boolean
description: 'Suspended: true or false'
createdBy:
type: string
description: Task owner
example: user2
priorityClass:
type: string
description: Priority class
enum:
- Urgent
- High
- Medium
- Low
taskType:
type: string
description: Task type
example: dcrReview
createdAfter:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
createdBefore:
type: integer
description: Time in milliseconds
format: int64
example: 1601486621140
state:
type: string
description: Validation state of task
enum:
- valid
- invalid
- all
objectURIs:
type: array
description: List of Reltio object URIs (entity/relation)
example: '["changeRequests/3Eq4ieYl","entities/16lJBkms","relations/fTV3W5z"]'
items:
type: string
Task Data Response:
allOf:
- $ref: '#/components/schemas/Task Data'
- type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
Validation Result Response:
type: object
properties:
status:
type: string
description: result of operation
example: OK
warning:
type: string
description: if operation is successful but there were some problems
valid:
type: boolean
description: Validation result flag
message:
type: string
description: Validation message
CurrentTasksResponse:
type: object
properties:
taskId:
type: string
taskDisplayName:
type: string
taskLocalVariables:
type: object
additionalProperties:
type: object
taskVariables:
type: object
additionalProperties:
type: object
APIErrorRepresentation:
type: object
properties:
severity:
type: string
description: Severity of the error message
readOnly: true
example: Error
errorMessage:
type: string
description: Brief error message
readOnly: true
example: Brief error message here
errorCode:
type: integer
description: Unique code of the error
format: int32
readOnly: true
example: 123
errorDetailMessage:
type: string
description: Detailed error message
readOnly: true
example: Detailed error message here
innerErrorData:
$ref: '#/components/schemas/APIException'
description: Model representing API error
APIException:
type: object
properties:
exception:
type: string
description: Brief information about the exception
readOnly: true
example: >-
com.reltio.metadata.errors.CommonException:Code: OBJECT_NOT_FOUND;
Message parameters: [entities/someId]. Object with
id=entities/someId not found. No object with specified id found at
com.reltio.businesslogic.crud.AbstractCRUDService.getBusinessObjects,
line 633
description: Model representing API exception
ProcessActionResponse:
type: object
properties:
jobId:
type: string
status:
type: string
enum:
- SUCCESS
- FAILED
- RUNNING
message:
type: string
errors:
type: array
items:
type: string
action:
type: string
adapterResponse:
type: object
properties:
threshold:
type: integer
format: int32
loadFactor:
type: number
format: float
additionalProperties:
type: object
UnauthorizedErrorModel:
type: object
properties:
error:
type: string
description: Brief information about the error
readOnly: true
example: invalid_token
error_description:
type: string
description: Additional details about the error
readOnly: true
example: 'Token is invalid: 6e4f0d00-7bcf-4be5-b583-f47916495d39'
description: Model representing API error
SecretsResult:
type: object
properties:
secretsName:
type: string
secretsArn:
type: string
lastChangedDate:
type: string
lastAccessedDate:
type: string
secrets:
type: object
properties:
threshold:
type: integer
format: int32
loadFactor:
type: number
format: float
additionalProperties:
type: object
DataPipelineMonitoredEvent:
type: object
properties:
total:
type: integer
format: int32
eventId:
type: string
eventType:
type: string
eventState:
type: string
objectUri:
type: string
timestamp:
type: integer
format: int64
checksum:
type: integer
format: int64
platformChecksum:
type: integer
format: int64
dataPipelineChecksum:
type: integer
format: int64
dataPipelineFileName:
type: string
DataPipelineEventMonitoringReport:
type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/DataPipelineMonitoredEvent'
totalEventsCount:
type: integer
format: int64
totalIncompleteEventsCount:
type: integer
format: int64
sqlQuery:
type: string
error:
type: string
FailedEventsResponse:
type: object
properties:
failedEvents:
type: array
items:
$ref: '#/components/schemas/FailedEventResponse'
page:
type: integer
format: int32
size:
type: integer
format: int32
totalPages:
type: integer
format: int32
totalCount:
type: integer
format: int64
sqlQuery:
type: string
error:
type: string
objectUri:
type: string
FailedEventResponse:
type: object
properties:
total:
type: integer
format: int32
eventId:
type: string
eventType:
type: string
eventState:
type: string
objectUri:
type: string
timestamp:
type: integer
format: int64
checksum:
type: integer
format: int64
platformChecksum:
type: integer
format: int64
dataPipelineChecksum:
type: integer
format: int64
dataPipelineFileName:
type: string
errorMessage:
type: string
EventStatusResponse:
type: object
properties:
totalEvents:
type: integer
format: int64
createdCount:
type: integer
format: int64
sentCount:
type: integer
format: int64
datapipelineProcessedCount:
type: integer
format: int64
deadCount:
type: integer
format: int64
objectUri:
type: string
sqlQuery:
type: string
error:
type: string
DltPipelineStatusResponse:
type: object
properties:
adapterId:
type: string
pipelineName:
type: string
pipelineId:
type: string
currentState:
type: string
latestUpdateState:
type: string
DltPipelineStatusPageResponse:
type: object
properties:
pipelines:
type: array
items:
$ref: '#/components/schemas/DltPipelineStatusResponse'
total:
type: integer
format: int32
nextOffset:
type: integer
format: int32
prevOffset:
type: integer
format: int32
PipelineErrorResponse:
type: object
properties:
timestamp:
type: string
message:
type: string
updateId:
type: string
details:
type: string
DltPipelineEventsPageResponse:
type: object
properties:
adapterId:
type: string
pipelineName:
type: string
pipelineId:
type: string
currentState:
type: string
latestUpdateState:
type: string
errors:
type: array
items:
$ref: '#/components/schemas/PipelineErrorResponse'
total:
type: integer
format: int32
nextOffset:
type: integer
format: int32
prevOffset:
type: integer
format: int32
PipelineOperationResponse:
type: object
TriggerPipelineRequest:
type: object
properties:
fullRefresh:
type: boolean
validateOnly:
type: boolean
DatashareStatesResponse:
type: object
properties:
adapterName:
type: string
state:
type: string
QueueInfo:
type: object
properties:
count:
type: integer
format: int64
updateTimestamp:
type: integer
format: int64
AuditLogRequest:
required:
- eventTargetObjects
- events
type: object
properties:
ip:
type: string
description: ip related to the Auth Security Audit log requested log filter
example: 99.99.99.99
format:
type: string
description: >-
format related to the Auth Security Audit log requested log filter,
default value CSV
example: csv
enum:
- json
- csv
start:
type: string
description: >-
start Timestamp which is in ISO format related to the Auth Security
Audit log requested log filter
format: date
customerId:
type: string
description: >-
customerId related to the Auth Security Audit log requested log
filter
example: SampleCustomerId
usernames:
type: array
description: >-
list of usernames related to the Auth Security Audit log requested
log filter
example: '["user1"]'
items:
type: object
end:
type: string
description: >-
end Timestamp which is in ISO format related to the Auth Security
Audit log requested log filter
format: date
eventTargetObjects:
type: array
description: >-
list of eventTargetObjects related to the Auth Security Audit log
requested log filter
example: '["user1", "user2"]'
items:
type: object
endTimestamp:
type: integer
description: >-
end timestamp which is unix timestamp related to the Auth Security
Audit log requested log filter
format: int64
example: 1695280740
events:
type: array
description: >-
list of events related to the Auth Security Audit log requested log
filter
example: '["LOGIN", "LOGIN_SSO"]'
items:
type: object
startTimestamp:
type: integer
description: >-
start timestamp which is unix timestamp related to the Auth Security
Audit log requested log filter
format: int64
example: 1695280740
MFADetails:
type: object
properties:
secret:
type: string
verified:
type: boolean
ReltioUser:
required:
- customer
- email
- username
type: object
properties:
username:
type: string
description: Indicates username of the user
example: user@reltio.com
accountNonExpired:
type: boolean
description: set to true if the user has not expired
example: true
accountNonLocked:
type: boolean
description: >-
Indicates user is locked if the user has crossed the unsuccessful
attempts
example: true
credentialsNonExpired:
type: boolean
description: >-
Indicates whether the user's credentials (password) has expired.
Expired credentials prevent authentication.
example: true
enabled:
type: boolean
description: >-
Indicates whether the user is enabled or disabled. A disabled user
cannot be authenticated
example: true
email:
type: string
description: Indicates email of the user
example: user@reltio.com
customer:
type: string
description: Customer name that this user belongs to
example: BestCustomer
passwordChangedDate:
type: integer
description: Indicates user's last Password change date in timestamp
format: date-time
readOnly: true
lastLoginDate:
type: integer
description: Indicates user's last login date in timestamp
format: date-time
readOnly: true
numberOfFailedMFALoginAttempts:
type: integer
format: int32
accountNonLockedFailedMFALoginAttempts:
type: boolean
encrypted:
type: boolean
description: Indicates user data is encrypted
example: true
externalUser:
type: boolean
description: Indicates user is a Native or SSO user
example: true
locale:
type: string
description: Indicates locale of the user
example: en
timezone:
type: string
description: Indicates timezone of the user
example: UTC
firstLogin:
type: boolean
description: Indicates user is logged at least once
readOnly: true
example: true
userPermissions:
$ref: '#/components/schemas/ReltioUserPermissions'
groups:
uniqueItems: true
type: array
description: Indicates list of groups that this user belongs to
example: '[SALES_GROUP]'
items:
type: string
jwtVersion:
type: string
description: Indicates jwtVersion of the user
example: v1
enum:
- V1
dbUserId:
type: integer
format: int64
isMFAExempted:
type: boolean
mfaDetails:
$ref: '#/components/schemas/MFAUserEnrollmentDetails'
updatedDate:
type: integer
format: int64
createdDate:
type: integer
format: int64
updatedBy:
type: string
createdBy:
type: string
numberFailedLoginAttempts:
type: integer
description: Indicates number of failed login attempts by this user
format: int32
readOnly: true
example: 2
description: User object model
MFAUserEnrollmentDetails:
type: object
properties:
availables:
type: array
items:
type: string
enum:
- AUTHENTICATOR
- EMAIL
details:
type: object
additionalProperties:
$ref: '#/components/schemas/MFADetails'
ReltioUserPermissions:
type: object
properties:
roles:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
type: string
permissions:
type: object
additionalProperties:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
type: string
QRCodeEnrollmentResetRequest:
required:
- mfatype
type: object
properties:
mfatype:
type: string
description: mfatype
example: AUTHENTICATOR
enum:
- AUTHENTICATOR
- EMAIL
EnrollmentVerifyRequest:
required:
- mfatype
- totp
type: object
properties:
totp:
type: string
description: totp
example: '659865'
mfatype:
type: string
description: mfatype
example: AUTHENTICATOR
enum:
- AUTHENTICATOR
- EMAIL
state_token:
type: string
description: 1d9dc92f-e9db-46b1-be2e-fde61761f1cf
example: 1d9dc92f-e9db-46b1-be2e-fde61761f1cf
stateToken:
type: string
ReltioUserShort:
required:
- email
- username
type: object
properties:
username:
type: string
description: Indicates username of the user
example: user@reltio.com
email:
type: string
description: Indicates email of the user
example: user@reltio.com
isClient:
type: boolean
description: User object model with minimal info
OperationStatus:
type: object
properties:
status:
type: string
GroupsContainer:
type: object
properties:
groups:
uniqueItems: true
type: array
items:
type: string
API Error:
type: object
properties:
errorMessage:
type: string
description: Error message
readOnly: true
example: >-
Incorrect tenant id provided for value:
user_tenant_id/State/Reltio/AR
errorCode:
type: integer
description: Error code
format: int32
readOnly: true
example: 400
innerErrorData:
$ref: '#/components/schemas/API Exception'
description: Contains detailed information about occurred error
Export parameters:
required:
- fileFormat
type: object
properties:
fileFormat:
type: string
description: The file format for the exported data
example: csv
enum:
- csv
- json
exportParents:
type: boolean
description: To include parents or not as part of the exported data
example: true
exportLookupTypes:
type: array
description: >-
The list of lookup types to be exported. All lookup types are
exported if this parameter is not specified.
example: '["Country"]'
items:
type: string
exportSources:
$ref: '#/components/schemas/Include sources parameter'
exportLocalizations:
$ref: '#/components/schemas/Include localizations parameter'
exportAttributes:
$ref: '#/components/schemas/Include attributes parameter'
exportUpdateInfo:
type: boolean
description: >-
To include update information of lookups, such as updatedBy and
updatedDate.
example: false
exportVersion:
type: boolean
description: To include version of lookups or not as part of the exported data.
example: false
email:
type: string
description: >-
The email ID to send the download link after the export is complete.
The email is sent to the user who scheduled export task if this
parameter is not specified.
example: user@domain.com
API Exception:
type: object
properties:
innerErrorData:
$ref: '#/components/schemas/API Exception'
exception:
type: string
description: Exception message
readOnly: true
example: |2-
"com.reltio.rdm.utils.RDMUtils.precondition at RDMUtils.java, line 153",
"com.reltio.rdm.model.base.Model.setRdTenantId at Model.java, line 91",...
stack:
type: array
description: Exception stack
readOnly: true
example: >-
com.reltio.rdm.RDMException:Incorrect tenant id provided for value:
user_tenant_id/State/Reltio/AR
items:
type: string
Include localizations parameter:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description: To include localizations or not as part of the exported data.
example: true
include:
type: array
description: >-
The list of language codes to be included. If this parameter is
null, then all localizations are included.
example: '["en-us"]'
items:
type: string
Include sources parameter:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description: To include source values or not as part of the exported data.
example: true
include:
type: array
description: >-
The list of sources to be included in the export. If this parameter
is null, then all sources are included.
example: '["Reltio"]'
items:
type: string
Include attributes parameter:
required:
- enabled
type: object
properties:
enabled:
type: boolean
description: To include attributes or not as part of the exported data.
example: true
include:
type: object
additionalProperties:
type: array
items:
type: string
description: The map of attribute names by lookup type.
example: '{"Country": ["Population"]}'
EntityUnmerge:
type: object
properties:
enabled:
type: boolean
retainManualMerges:
type: boolean
retainMergeConditions:
$ref: '#/components/schemas/RetainMergeCondition'
actions:
type: array
items:
$ref: '#/components/schemas/UnmergeActionDefinition'
UnmergeMatchGroup:
type: object
properties:
uri:
type: string
description: Path that is used to identify a match group configuration element
example: configuration/entityTypes/Individual/matchGroups/IndividualByEmail
description: >-
A reference to a match group to compare entities within the entity type
for unmerge purposes
RetainMergeCondition:
type: object
properties:
sources:
type: array
items:
type: string
matchGroups:
type: array
items:
$ref: '#/components/schemas/UnmergeMatchGroup'
QueryObjectsSpecification:
required:
- filter
type: object
properties:
filter:
type: string
description: The query text
example: (equals(type,'Individual') and gt(updatedTime,1556053012537))
options:
type: string
description: The search query options
example: searchByOv
activeness:
type: string
description: The activeness of the objects to query
example: ALL
enum:
- ALL
- NOT_ACTIVE
- ACTIVE
objectsLimit:
type: integer
description: The maximum number of objects allowed to be queried
format: int32
example: 100000
description: The search query specification
BatchUnmergeFilterSpecification:
type: object
properties:
objects:
$ref: '#/components/schemas/ObjectListSpecification'
query:
type: array
description: The specification of the entities subset using the search queries
items:
$ref: '#/components/schemas/QueryObjectsSpecification'
description: >-
The structure to describe the batch unmerge entities task filter
specification
MatchParam:
required:
- name
- parameter
type: object
properties:
value:
type: string
description: The parameter value
values:
type: string
description: >-
The parameter values. The field allows specifying multiple values or
the values with a composite structure
items:
type: object
additionalProperties:
type: object
parameter:
type: string
description: The parameter name
example: ML_MODEL
description: >-
The structure to describe a parameter of a comparator class or match
token class
UnmergeActionDefinition:
required:
- enabled
- proceed
- type
type: object
properties:
enabled:
type: boolean
description: The toggle to enable or disable the action
example: true
type:
type: string
description: The type of the action
example: tag
enum:
- unmerge
- tag
- dcr
proceed:
type: boolean
description: >-
Whether processing should continue with the next configured unmerge
action
example: true
parameters:
type: array
description: The parameters of the action
items:
$ref: '#/components/schemas/MatchParam'
BatchUnmergeEntitiesPayload:
type: object
properties:
unmerge:
$ref: '#/components/schemas/EntityUnmerge'
filter:
$ref: '#/components/schemas/BatchUnmergeFilterSpecification'
maxRetries:
type: integer
description: >-
Maximum number of retry attempts for transient failures (default:
10)
format: int32
example: 10
initialRetryDelayMs:
type: integer
description: >-
Initial delay in milliseconds for exponential backoff with 1.5x
multiplier (default: 200 ms)
format: int64
example: 200
includeCrosswalksAndSummary:
type: boolean
description: >-
Include crosswalk and summary details in reports (default: false).
Excluding reduces file size significantly
example: false
description: The payload of the Batch unmerge entities job
PeriodicTaskTO:
type: object
properties:
id:
type: string
description: Unique ID of the periodic task
example: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
groupId:
type: string
description: Unique ID of periodic task group
example: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
createdBy:
type: string
description: ID of a user who created this task
example: someUser@companyName.com
createdTime:
type: string
description: Timestamp when the task was created
format: int64
example: 1609135627918
updatedBy:
type: string
description: >-
ID of a user who updated this task (e.g. who canceled/paused the
task)
example: someUser@companyName.com
updatedTime:
type: string
description: Timestamp when task was most recently updated
format: int64
example: 1609135627918
startTime:
type: string
description: Time when the task was started
format: int64
example: 1609135627918
stopTime:
type: string
description: Time when the task was stopped
format: int64
example: 1609135627918
type:
type: string
description: A type of periodic task
example: com.reltio.businesslogic.tasks.cleanse.ReCleanseDataTask
taskParams:
type: object
additionalProperties:
type: string
description: A set of parameters of the periodic task
example: >-
{"tenantId": "tenantId","entityType":
"Location","skipEntitiesCount": "0"}
createdOnHost:
type: string
description: Host name of API node where the task was created
example: dataload-947b546c9-5tz97
executedOnHost:
type: string
description: Host name of API node where the task is executing/was executed
example: dataload-947b546c9-5tz97
status:
type: string
description: >-
A status of the periodic tasks, possible statuses: SCHEDULED,
PROCESSING, PAUSING, PAUSED, CANCELING, CANCELED, COMPLETED, FAILED,
THROTTLING
example: SCHEDULED
enum:
- SCHEDULED
- PROCESSING
- PAUSING
- PAUSED
- CANCELING
- CANCELED
- COMPLETED
- FAILED
- THROTTLING
statusChangedTime:
type: string
description: Time when the task status was changed
format: int64
example: 1609135627918
currentState:
type: string
description: >-
Set of fields which represent the current state of task (e.g.
numberOfProcessedObjects)
example: '{"lastHourThroughput": 46.125,"numberOfProcessedObjects": 623700}'
error:
type: string
description: If periodic task failed, this attribute contains error description
example: Periodic task failed to execute
internalErrorDetails:
type: string
description: >-
If periodic task failed, this attribute contains detailed error
description
example: Periodic task failed to execute
parentTaskId:
type: string
description: Contains ID of parent periodic task for multi-step tasks
example: 3aab9c27-4d3d-48a3-98e0-7a7491059ab2
pausedTime:
type: string
description: Time when the task was paused
format: int64
example: 1609135627918
totalPausedTime:
type: string
description: Duration of time interval when task was paused
format: int64
example: 160913
name:
type: string
description: Name of periodic task
example: >-
Re-cleansing of configuration/entityTypes/Location in tenant
testTenant background task.
parallelExecution:
type: string
description: >-
Task can be executed in the same time with another task for the same
tenant if this property is true. Otherwise, all tasks for the same
tenant will be processed one by one (it does not matter how many API
nodes are exist in the cluster). Default is false.
example: true
nodesGroup:
type: string
description: Determines the group of nodes where this task can be executed.
example: default
dependsOnTasksIds:
uniqueItems: true
type: string
description: IDs of tasks that should be finished before this task execution
example: 4c50bfe2-f9eb-44e1-87d3-1ba863bac248
items:
type: string
alwaysRunAfterDependents:
type: string
description: >-
Forces the task to be executed even if tasks with dependsOnTasksIds
ids have failed.
example: true
lastThrottledTime:
type: string
description: Timestamp when the task was throttled
format: int64
example: 1609135627918
userEmail:
type: string
description: Contains state of Periodic task execution
ObjectListSpecification:
type: object
properties:
includeList:
type: array
description: The list of included objects
items:
type: string
excludeList:
type: array
description: The list of excluded objects
items:
type: string
description: The list of included and excluded objects
CleanupMatchesPayload:
type: object
properties:
entityType:
type: string
description: Entity type ID
example: Individual
rules:
type: array
description: >-
Defines a comma separated set of match group URIs to delete matches
associated with them
example: >-
["configuration/entityTypes/Individual/matchGroups/MatchByMiddleName",
"configuration/entityTypes/Individual/matchGroups/MatchByMiddleNameAndLastName"]
items:
type: string
description: The payload of the Cleanup Matches task
ExternalMatchPayload:
type: object
properties:
entityType:
type: string
description: >-
Entity type to filter and match from the entire set of entities
represented in an external file
example: Individual
skipEntitiesCount:
type: integer
description: Defines the number of entities to be skipped from the source file
format: int32
example: 10000
entitiesLimit:
type: integer
description: Defines the number of entities to be processed from the source
format: int32
example: 1000000
distributed:
type: boolean
description: Specifies whether the task is distributed or not
distributedTaskIndex:
type: integer
description: >-
Defines task index to start only. If not defined, all created tasks
will be started automatically
format: int32
example: 1
distributedTasksPartsCount:
minimum: 1
type: integer
description: Defines the number of distributed tasks to be created. Default is 2
format: int32
example: 2
emails:
type: string
description: >-
Defines a comma-separated list of emails to which a notification of
completion will be sent
example: someUser@someCompany.com
fileFormat:
type: string
description: >-
The format of the output file records. Formats:
- csv —
CSV format
- json — Multiline JSON (single input line may
result in multiple output lines)
- json_v2 — Single line JSON
(single input line results into single output line)
example: json_v2
enum:
- json
- json_v2
- csv
fileEncoding:
type: string
description: >-
Defines the source and result file encoding. The default value is
UTF-8
example: UTF-8
bucket:
type: string
description: >-
Defines the bucket where the source file must reside and where the
result file will be created
example: externalMatchResults
s3Region:
type: string
description: Defines the AWS region for S3 bucket
example: us-east-1
path:
type: string
description: >-
Determines the path to a source file in a bucket (including folders,
if necessary)
example: Individual/2020-01-01/input.txt
pathOut:
type: string
description: >-
Determines the path where the output result file will be created in
a bucket (including folders, if necessary)
example: Individual/2020-01-01/output.txt
awsAccessKey:
type: string
description: AWS access key for the AWS S3 bucket
awsSecretKey:
type: string
description: AWS secret key for the AWS S3 bucket
awsRoleArn:
type: string
description: AWS role ARN for the AWS S3 bucket
awsRoleSessionName:
type: string
description: AWS role session name for the AWS S3 bucket
awsExternalId:
type: string
description: AWS externalId for the AWS S3 bucket
awsSessionToken:
type: string
description: AWS sessionToken for the AWS S3 bucket
googleCredentials:
type: string
description: GCP service key account JSON
urlExpirationPeriod:
maximum: 7
minimum: 1
type: integer
description: >-
Expiration period in days for the download link from the S3 bucket
(default and max value is 7)
format: int32
example: 7
maxPotentialMatchesPerChunk:
type: integer
description: >-
External match goes through entities by chunk (10 entities), each
chunk has a limitation for the maximum of potential matches found by
chunk. Default value is 200
format: int32
example: 200
rules:
type: array
description: >-
Defines a comma separated set of match group URIs which must take
part in the matching process. All other match groups will be ignored
if this parameter is defined
example: >-
configuration/entityTypes/HCP/matchGroups/MatchByMiddleName,configuration/entityTypes/HCP/matchGroups/MatchByMiddleNameAndLastName
items:
type: string
selectAttributes:
type: array
description: >-
An array of string values that allows selecting the attributes that
will be included in the output file
example: >-
["configuration/entityTypes/HCP/attributes/FirstName",
"configuration/entityTypes/HCP/attributes/Identifiers/attributes/Type"]
items:
type: string
cleanse:
type: boolean
description: >-
If set to true, the API enriches the entities with the cleansed
values for attributes. The cleansed entities are then matched with
the entities in the tenant
resolveLookups:
type: boolean
description: >-
If set to true, then lookups are resolved for entities in the input
file
options:
type: string
description: >-
Comma-separated list of the custom options applicable to the
External Match job
example: ovOnly
enum:
- ovOnly
- nonOvOnly
azureStorageContainer:
type: string
description: Azure blob container name
azureStorageAccountName:
type: string
description: Azure blob account name
azureStorageAccountKey:
type: string
description: Azure blob storage account key
azureSasToken:
type: string
description: 'Azure shared access signature '
description: The payload of the External Match job
AbstractRebuildMatchTableTaskPayload:
type: object
description: >-
The payload of the Rebuild Match Table job:
RebuildMatchTableTaskPayload, RebuildMatchTableTaskEntitiesListPayload
discriminator:
propertyName: type
LookupsVersionUpdater:
type: object
properties:
lookupsDAO:
$ref: '#/components/schemas/ISafeDaoHolderIDBLookupsDAO'
lookupCache:
$ref: '#/components/schemas/ILookupCache'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
IGroupingDAO:
type: object
TenantDisasterRecoveryConfiguration:
type: object
properties:
namespace:
type: string
platformUrl:
type: string
ITenantsInfoProvider:
type: object
ApiErrorFactory:
type: object
properties:
messageSource:
$ref: '#/components/schemas/MessageSource'
localizationService:
$ref: '#/components/schemas/LocalizationService'
emptyArgs:
type: array
items:
type: string
MatchAssetsConfiguration:
type: object
properties:
commonAssetsEnabled:
type: boolean
commonAssetsFrequencyCap:
type: integer
format: int64
lowLevelConfiguration:
$ref: '#/components/schemas/MatchAssetsLowLevelConfiguration'
rematchOnThreshold:
type: boolean
OverwriteObjectService:
type: object
properties:
crudService:
$ref: '#/components/schemas/ICRUDService'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
mergeSplitService:
$ref: '#/components/schemas/IMergeSplitService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
ReltioBusinessModelRecord:
type: object
properties:
businessModelReference:
$ref: '#/components/schemas/ReltioBusinessModelReference'
lastModified:
type: integer
format: int64
LoadingCacheStringGeneratorTO:
type: object
CompiledMatchGroupsCache:
type: object
properties:
cache:
$ref: '#/components/schemas/LoadingCacheEntityTypeKeyEntityTypeMatchGroups'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
matchGroupsFilter:
$ref: '#/components/schemas/IFilterMatchGroup'
ILockIgnoreTenantHandler:
type: object
IntArray:
type: object
properties:
items:
type: array
items:
type: integer
format: int32
size:
type: integer
format: int32
ordered:
type: boolean
File storage configuration:
type: object
properties:
id:
type: string
description: Unique identified for storage config
example: 3r61-s3-test
fileStorageConfig:
$ref: '#/components/schemas/IFileStorageConfig'
description: File storage configuration of tenant
AbstractTenantFilteringService:
type: object
properties:
listeners:
type: array
items:
$ref: '#/components/schemas/ITenantFilterListener'
IEncryptionEngine:
type: object
StatsLogger:
type: object
MetadataInheritor:
type: object
properties:
systemMetadataConfig:
$ref: '#/components/schemas/SystemMetadataConfigAccess'
AttributesLabelPatternCache:
type: object
properties:
timestampsCache:
$ref: '#/components/schemas/LoadingCacheTenantIdLong'
valuesCache:
type: object
additionalProperties:
$ref: '#/components/schemas/CacheRecordMapStringListString'
metadataService:
$ref: '#/components/schemas/MetadataService'
EmbeddingConfiguration:
type: object
properties:
modelId:
type: string
embeddingDimension:
type: integer
format: int32
description: >-
Embedding configuration specifying model type and dimension for vector
generation
DatabaseDAOStrategyRegistry:
type: object
properties:
strategies:
type: object
additionalProperties:
$ref: '#/components/schemas/DatabaseDAOStrategy'
NotificationService:
type: object
HistoryCache:
type: object
properties:
enabled:
type: boolean
status:
type: string
enum:
- PROCESSED
- PROCESSING
taskPartCount:
type: integer
format: int32
Entries:
type: object
properties:
hasNext:
type: boolean
map:
$ref: '#/components/schemas/IdentityMapObjectObject'
nextIndex:
type: integer
format: int32
currentIndex:
type: integer
format: int32
entry:
$ref: '#/components/schemas/EntryObjectObject'
EventHubCRUDServiceEvent:
type: object
FunctionTenantIdIPredicateQueryDAO:
type: object
Feature Generation Sampling Configuration:
type: object
properties:
maxFlatRows:
type: integer
description: Maximum appropriate number of rows in the sampled table
format: int64
example: 10000000
samplingStrategy:
type: string
description: >-
This property set the sampling strategy.
OV_FIRST (default) - try to flatten all values in the tenant table. If the flattened table size exceeds the maxFlatRows limit try using OV values only. If the flattened table is still too big, try taking fewer entities (but not less than minSampleSize)
SAMPLING_FIRST - try to flatten all values in the tenant table. If
the flattened table size exceeds the maxFlatRows limit, try taking
fewer entities. If you have to take less than minSampleSize, try
taking the OV values only as a fallback strategy
example: OV_FIRST
enum:
- OV_FIRST
- SAMPLING_FIRST
minSampleSize:
type: integer
description: Minimum number of entities to participate in feature generation
format: int64
example: 10000
description: Feature Generation Sampling Configuration Object
TimeZone:
type: object
properties:
ID:
type: string
TypeResolverBuilderObject:
type: object
NoneOVSearchRequestFilterFactory:
type: object
CacheRecordOptionCacheEntryIPermissions:
type: object
properties:
value:
$ref: '#/components/schemas/OptionCacheEntryIPermissions'
timestamp:
type: integer
format: int64
IPlatformsStatisticsAccess:
type: object
MatchEventHubService:
type: object
properties:
platform:
$ref: '#/components/schemas/ReltioAPIPlatform'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
configuration:
$ref: '#/components/schemas/Configuration'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
lifecycleProcessor:
$ref: '#/components/schemas/ReltioLifecycleProcessor'
processorStatusProvider:
$ref: '#/components/schemas/EventProcessorStatusProvider'
eventsHubFactory:
$ref: '#/components/schemas/ReltioMessagingEventsHubFactory'
tenantConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantConfiguration'
eventsHub:
$ref: '#/components/schemas/EventHubMatchServiceEventEntityURI'
running:
type: boolean
currentCollectorBatch:
type: integer
format: int32
threadCount:
type: integer
format: int32
immediateHubStatisticsStorage:
$ref: '#/components/schemas/ImmediateHubStatisticsStorage'
sequentialEmptyCountThreshold:
type: integer
format: int64
sequentialEmptyTimerThreshold:
type: integer
format: int64
lockLeaseTime:
type: integer
format: int64
legacyResourcesCleanupDelay:
type: integer
format: int64
listener:
$ref: '#/components/schemas/ResourceLifecycleListener'
RDMServiceDefinition:
type: object
properties:
rdmServiceUri:
type: string
rdmTenantId:
type: string
dictionary:
type: string
oauthInstance:
type: string
IObjectChangesProcessorEntityTO:
type: object
MaterializedViewService:
type: object
properties:
predicateQueryDAOProvider:
$ref: '#/components/schemas/FunctionTenantIdIPredicateQueryDAO'
metadataService:
$ref: '#/components/schemas/IMetadataService'
predicateAPIEnablementChecker:
$ref: '#/components/schemas/PredicateTenantId'
serializationHelperSupplier:
$ref: >-
#/components/schemas/SupplierRemoteEventSerializationHelperCRUDServiceEvent
ConditionToRemoveManualMatch:
type: object
properties:
type:
type: string
CleanseService:
type: object
properties:
logJsonField:
$ref: '#/components/schemas/MessageFormat'
cleanser:
$ref: '#/components/schemas/Cleanser'
nestedCleanser:
$ref: '#/components/schemas/NestedCleanser'
errorFactory:
$ref: '#/components/schemas/ApiErrorFactory'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
overwriteObjectService:
$ref: '#/components/schemas/OverwriteObjectService'
amazonS3ClientFactory:
$ref: '#/components/schemas/AmazonS3ClientFactory'
configuration:
$ref: '#/components/schemas/Configuration'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
attributeVerificationService:
$ref: '#/components/schemas/AttributeVerificationService'
LcaAzureConfig:
type: object
properties:
azureFunctionTimeOut:
type: integer
description: Azure Function LCA time out in milliseconds
format: int32
example: 1000
customerTenantId:
type: string
description: Customers azure tenant Id
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
customerFunctionAppId:
type: string
description: Customers function app id which is added under identity provider
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
reltioAppId:
type: string
description: Reltio's app id
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
reltioAppSecret:
type: string
description: Reltio's app Secret
example: xxxxxx
reltioAzureTenantId:
type: string
description: Reltio's azure tenant id
example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
description: LCA Azure Configuration
IGraphsDAO:
type: object
TenantLookupsAccess:
type: object
properties:
tenantModificationDate:
type: integer
format: int64
TemplateExceptionHandler:
type: object
LookupsServiceInterface:
type: object
IPeriodicTaskDAO:
type: object
TablePropertiesConfiguration:
type: object
properties:
dynamoDBProperties:
$ref: '#/components/schemas/DynamoDBProperties'
IWorkflowDAO:
type: object
DBLayerConverterFactory:
type: object
properties:
tenantsDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
cassandraWriter:
$ref: '#/components/schemas/CassandraWriter'
interactionCassandraWriter:
$ref: '#/components/schemas/InteractionCassandraWriter'
cassandraExecutorWorkflowDataConverter:
$ref: '#/components/schemas/CassandraExecutorWorkflowDataConverter'
commonWorkflowDataConverter:
$ref: '#/components/schemas/CommonWorkflowDataConverter'
dbLayerToConverterMap:
type: object
additionalProperties:
$ref: '#/components/schemas/IDBLayerConverterObjectObjectObjectObject'
Path:
type: object
properties:
id:
type: string
label:
type: string
PropertyName:
type: object
properties:
_simpleName:
type: string
_namespace:
type: string
_encodedSimple:
$ref: '#/components/schemas/SerializableString'
TaskLoggerWrapper:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
messagePrefix:
type: string
RejectedExecutionHandler:
type: object
MessageSource:
type: object
ActivityItemsTypeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
MonitoringBigQueryClientFactory:
type: object
RelationsService:
type: object
properties:
dao:
$ref: '#/components/schemas/RelationsDAO'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
objectChangesProcessor:
$ref: '#/components/schemas/IObjectChangesProcessorRelationTO'
postponedChangesThreadLocal:
$ref: '#/components/schemas/ThreadLocalPostponedChangesRelationTO'
logger:
$ref: '#/components/schemas/Logger'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
permissionsService:
$ref: '#/components/schemas/IPermissionsProvider'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
metadataService:
$ref: '#/components/schemas/MetadataService'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceObject'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
relationAnalyticsAttributesService:
$ref: '#/components/schemas/RelationAnalyticsAttributesService'
businessObjectsServiceSupplier:
$ref: '#/components/schemas/SupplierBusinessObjectsService'
AtomicLong:
type: object
properties:
value:
type: integer
format: int64
HazelcastInstance:
type: object
EntityEmbeddingsConverter:
type: object
properties:
vectorizedAttributesProvider:
$ref: '#/components/schemas/VectorizedAttributesProvider'
AnalyticsConfig:
type: object
properties:
isAnalyticsEnabled:
type: boolean
inactive:
type: boolean
updatesConfig:
$ref: '#/components/schemas/AnalyticsUpdatesConfig'
authData:
$ref: '#/components/schemas/EncryptedAuthData'
maxIncrementalWindow:
type: integer
format: int32
maxIncrementalWindowOverlap:
type: integer
format: int32
regularJobQuota:
type: integer
format: int32
cassandraJobQuota:
type: integer
format: int32
maxClusterSize:
type: integer
format: int32
useParquetIDA:
type: boolean
consistencyCheckInterval:
type: integer
format: int32
consistencyFlyCheck:
type: boolean
mergeOnTheFly:
type: boolean
dbAccessMode:
type: string
persistRelationEdgeType:
type: boolean
gbq:
$ref: '#/components/schemas/Gbq'
reportingConfig:
$ref: '#/components/schemas/ReportingConfig'
LoadingCacheTenantIdMatchGroupsOfTenant:
type: object
SegmentService:
type: object
properties:
segmentDAO:
$ref: '#/components/schemas/SegmentDAO'
segmentSearchService:
$ref: '#/components/schemas/ISegmentSearch'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
marshaller:
$ref: '#/components/schemas/IMarshaller'
customerDAOService:
$ref: '#/components/schemas/CustomerDAOService'
zeroCopyMetadataService:
$ref: '#/components/schemas/ZeroCopyMetadataService'
HazelcastConfig:
type: object
properties:
enabled:
type: boolean
testMode:
type: boolean
clientMode:
type: boolean
isSmartRouting:
type: boolean
serverAddress:
type: array
items:
type: string
awsEnabled:
type: boolean
awsAccessKey:
type: string
awsSecretKey:
type: string
awsRegion:
type: string
awsTagKey:
type: string
awsTagValue:
type: string
clusterName:
type: string
publicAddress:
type: string
port:
type: string
maxBlockTime:
type: integer
format: int64
environment:
type: string
environmentWithoutTailingDot:
type: string
healthCheckEnabled:
type: boolean
partitionCount:
type: integer
format: int32
lockVersion:
type: string
enum:
- LOCK_PER_KEY
- UNION_LOCK_FOR_KEYS
- LOCKS_V8
- NO_LOCKS
restEnabled:
type: boolean
lockDetailedLoggingEnabled:
type: boolean
safeUnlock:
type: boolean
managementCenterEnabled:
type: boolean
managementCenterUrl:
type: string
managementCenterUpdateInterval:
type: integer
format: int32
jmxPort:
type: integer
format: int32
inputThreadCount:
type: string
outputThreadCount:
type: string
responseThreadCount:
type: string
inputThreadAffinity:
type: string
outputThreadAffinity:
type: string
responseThreadAffinity:
type: string
trackCpResources:
type: boolean
clusterConnectionTimeout:
type: integer
format: int32
backupClientEnabled:
type: boolean
backupClientConfig:
$ref: '#/components/schemas/HazelcastConfig'
primaryClusterStateMonitoringInterval:
type: integer
format: int64
primaryClusterStateMonitoringTtl:
type: integer
format: int64
primaryClusterStateMonitoringMap:
type: string
failScoreLatencyThreshold:
type: integer
format: int64
failScoreAsyncWeight:
type: integer
format: int32
failScoreHighLatencyWeight:
type: integer
format: int32
failScoreClientThreshold:
type: integer
format: int64
failScoreThreshold:
type: integer
format: int64
failScoreConnectionThreshold:
type: integer
format: int64
failScoreAtomicLongName:
type: string
heartbeatInterval:
type: string
heartbeatTimeout:
type: string
invocationTimeout:
type: string
clusterSchemasMapTtlMinutes:
type: integer
format: int32
generatorValueProviderMode:
type: string
TenantFilteringService:
type: object
properties:
listeners:
type: array
items:
$ref: '#/components/schemas/ITenantFilterListener'
logger:
$ref: '#/components/schemas/Logger'
lock:
type: object
tenantRouting:
type: object
additionalProperties:
type: array
items:
type: string
defaultNodesGroup:
type: array
items:
type: string
filtersLastModified:
type: integer
format: int64
staticTenantsFilter:
type: array
items:
type: string
staticTenantsExcludeFilter:
type: array
items:
type: string
nodeGroupFilter:
$ref: '#/components/schemas/NodeGroupFilter'
enabled:
type: boolean
taskRoutingEnabled:
type: boolean
nodeGroupsFolder:
type: string
nodeGroupsFile:
type: string
nodeGroups:
uniqueItems: true
type: array
items:
type: string
forbiddenNodeGroups:
uniqueItems: true
type: array
items:
type: string
configServiceProvider:
$ref: '#/components/schemas/ConfigServiceProvider'
firstLoadCompleted:
type: boolean
HistoryMigrationConfig:
type: object
properties:
migrationDataStorageId:
type: string
ttlISO:
type: string
AnalyticsUpdatesConfig:
type: object
properties:
flushTries:
type: integer
format: int32
maxBlockSize:
type: integer
format: int32
maxQueueBlocksSize:
type: integer
format: int32
maxFileSize:
type: integer
format: int32
secondsToFlush:
type: integer
format: int32
bucket:
type: string
dir:
type: string
consumeEvents:
type: boolean
consumeGbqEvents:
type: boolean
hoursToGbqCompaction:
type: integer
format: int32
readStaging:
type: boolean
debug:
type: boolean
hoursToShallowCompaction:
type: integer
format: int32
hoursToDeepCompaction:
type: integer
format: int32
updatesToTriggerShallowCompaction:
type: integer
format: int32
updatesToShallowCompaction:
type: integer
format: int32
updatesToDeepCompaction:
type: integer
format: int32
interactionUpdatesToDeepCompaction:
type: integer
format: int32
hoursToDeepCompactionForInteractions:
type: integer
format: int32
HttpServletRequest:
type: object
PredicateQueryService:
type: object
properties:
accessChecker:
$ref: '#/components/schemas/AccessChecker'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
materializedViewService:
$ref: '#/components/schemas/MaterializedViewService'
crudServiceProvider:
$ref: '#/components/schemas/CRUDServiceProvider'
mergeSplitServiceProvider:
$ref: '#/components/schemas/MergeSplitServiceProvider'
searchService:
$ref: '#/components/schemas/StorageSearch'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
indexOvStrategyProvider:
$ref: '#/components/schemas/FunctionTenantIdIndexOvStrategy'
internalEntitiesService:
$ref: '#/components/schemas/IInternalObjectService'
internalRelationsService:
$ref: '#/components/schemas/IInternalObjectService'
predicateQueryDAOProvider:
$ref: '#/components/schemas/FunctionTenantIdIPredicateQueryDAO'
predicateAPIEnablementChecker:
$ref: '#/components/schemas/PredicateTenantId'
processObjectLookupsFunction:
$ref: '#/components/schemas/ConsumerCollectionRelationTO'
forceUseIndexesMaterializedView:
type: boolean
LifecycleActionConfig:
required:
- actions
type: object
properties:
filter:
type: string
description: Executes an LCA when the object data meets the given condition.
example: >-
equals(clientType, 'Reltio UI') and equals(attributes.Group,
'GroupA')
actions:
type: array
description: >-
List of LCA names to be executed for the specified hook. Reltio
supports 3 types of LCAs.
1. LCA registered within the tenant. example: EntityScoreCalculator
2. Shared/Predefined LCA provided by Reltio. example:
Reltio/LogInput
3. LCA deployed in AWS Lambda. example:
Lambda/BinaryJSON/LambdaFnName
example: >-
["EntityScoreCalculator", "Reltio/LogInput",
"Lambda/BinaryJSON/LambdaFnName"]
items:
type: string
Appender:
type: object
TenantsStorageLock:
type: object
ReltioAWSCredentialsProvider:
type: object
properties:
defaultAwsCredentials:
$ref: '#/components/schemas/AWSCredentials'
defaultAwsRoleArn:
type: string
Cardinality:
type: object
properties:
minValue:
type: integer
description: Minumum
format: int32
example: 5
maxValue:
type: integer
description: Maximum
format: int32
example: 10
description: >-
Cardinality of the attribute type. It has two
sub-elements:
During the
application of a configuration, Reltio Cloud verifies that if minValue
is specified, then it should be greater than or equal to zero; if
maxValue is specified, then it should be greater than or equal to 1; and
if both attributes are specified, then maxValue should be greater than
or equal to minValue
TenantDatabaseConfiguration:
type: object
properties:
dataStorages:
type: object
additionalProperties:
$ref: '#/components/schemas/DataStorageMapping'
dataKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
interactionKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
predicateKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
groupingKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
historyKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
hierarchyKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
historyGBTMigration:
type: boolean
hierarchyEnabled:
type: boolean
historyBigTableConfig:
$ref: '#/components/schemas/BigTableConfigMapping'
matchKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
potentialMatchesKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
activityLogKeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
activityLogV2KeyspaceConfig:
$ref: '#/components/schemas/CassandraConfigWithDSMapping'
activityLogV2DynamoDBConfigMapping:
$ref: '#/components/schemas/DynamoDBConfigMapping'
activityLogV2SpannerDBConfigMapping:
$ref: '#/components/schemas/SpannerDBConfigMapping'
entitiesCF:
type: string
entityLinksCF:
type: string
entitiesCompressedCF:
type: string
entityMergeTreeCF:
type: string
relationsCF:
type: string
relationsOneHopsCF:
type: string
relationsStartEndCF:
type: string
relationMergeTreeCF:
type: string
relationsCompressedCF:
type: string
entityGroupsCF:
type: string
groupsCF:
type: string
groupMembersCF:
type: string
groupObjectsCF:
type: string
entityToGroupCF:
type: string
entityGraphsCF:
type: string
graphsCF:
type: string
graphMembersCF:
type: string
entityToGraphCF:
type: string
userPreferencesCF:
type: string
categoriesCF:
type: string
categoriesLinksCF:
type: string
activityRecordsCF:
type: string
activitiesCF:
type: string
activitiesV2CF:
type: string
businessProcessesCF:
type: string
entityHistoryExCF:
type: string
entityHistoryCacheCF:
type: string
configurationHistoryCF:
type: string
attributesDeltaHistoryCF:
type: string
physicalConfigurationHistoryCF:
type: string
matchCF:
type: string
matchDocumentsCF:
type: string
potentialMatchesCF:
type: string
autoMatchesCF:
type: string
notMatchCF:
type: string
autoNotMatchesCF:
type: string
manuallyMarkedAsMatchCF:
type: string
matchingCFPostfix:
type: string
entityMatchesCF:
type: string
commonAssetsCF:
type: string
matchAssetsCF:
type: string
interactionsCF:
type: string
entityToInteractionsCF:
type: string
newInteractionsCF:
type: string
externalCrosswalkCF:
type: string
externalRelationCrosswalkCF:
type: string
commitLogCF:
type: string
performanceIndexesCF:
type: string
materializedViewCF:
type: string
performanceIndexesRelationsCF:
type: string
materializedViewRelationsCF:
type: string
groupingMatchDocumentsCF:
type: string
groupingEntityDocumentsCF:
type: string
groupingEntityAttributesCF:
type: string
groupingEntityToGroupsCF:
type: string
groupingMatchTokensCF:
type: string
entitiesSegAttributesCF:
type: string
entitiesMetadataCF:
type: string
segmentsCF:
type: string
interactionsV2CF:
type: string
interactionsV2AttributesCF:
type: string
interactionsV2MembersCF:
type: string
cacheStatusCF:
type: string
analyticsAttributesCF:
type: string
relationAnalyticsAttributesCF:
type: string
changeRequestsCF:
type: string
changeRequestIndexCF:
type: string
useMatchingMultiTenantFix:
type: boolean
tenantId:
type: string
isolated:
type: boolean
interactionTtl:
type: integer
format: int64
tableProperties:
$ref: '#/components/schemas/TablePropertiesConfigMapping'
entityMergeTreeStoringMode:
type: string
enum:
- writeBoth_readOld
- writeBoth_readNew
- writeNew_readNew
- writeOld_readOld
dataMigration:
$ref: '#/components/schemas/DataMigrationConfig'
historyMigration:
$ref: '#/components/schemas/HistoryMigrationConfig'
commonDynamoDBConfig:
$ref: '#/components/schemas/CommonDynamoDBConfig'
disableOperationsPriority:
type: boolean
oneHopDaoVersion:
type: string
InternalLock:
type: object
properties:
lock:
$ref: '#/components/schemas/ReentrantLock'
WritableMatchingService:
type: object
properties:
matchGroupsConverter:
$ref: '#/components/schemas/MatchGroupsConverter'
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchAssetConverter:
$ref: '#/components/schemas/MatchAssetConverter'
configuration:
$ref: '#/components/schemas/Configuration'
readOnlyMatchingService:
$ref: '#/components/schemas/ReadOnlyMatchingServiceBase'
inMemoryEntitiesSplitter:
$ref: '#/components/schemas/InMemoryEntitiesSplitter'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
cleanseDictionaryServiceFactoryProvider:
$ref: >-
#/components/schemas/SupplierICleanseDictionaryServiceFactoryProvider
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
StorageTracker:
type: object
properties:
bytesRead:
$ref: '#/components/schemas/AtomicLong'
bytesWritten:
$ref: '#/components/schemas/AtomicLong'
rcu:
$ref: '#/components/schemas/AtomicDouble'
wcu:
$ref: '#/components/schemas/AtomicDouble'
ImmediateHubStatisticsStorage:
type: object
MetricsWriterService:
type: object
DeserializerFactory:
type: object
ReltioBusinessModelReferenceSupplier:
type: object
ServiceProvider:
type: object
properties:
module:
$ref: '#/components/schemas/Module'
providerName:
type: string
CommonAssetsStorage:
type: object
MetadataPermissionFilterService:
type: object
properties:
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
AttributeConfig:
type: object
properties:
provider:
type: string
secureOpts:
type: object
additionalProperties:
type: object
providerOpts:
type: object
additionalProperties:
type: object
reltioOpts:
type: object
additionalProperties:
type: object
DataStudioConfig:
type: object
properties:
reportBillingProject:
type: string
IMatchStorageDAO:
type: object
ISafeDaoHolderIDBLookupsDAO:
type: object
ThrottlingStorageTypeGroupConfig:
type: object
properties:
priorityThrottlingCreditsRefreshRate:
type: integer
format: int64
maxPriorityThrottlingCredits:
type: integer
format: int64
syncThrottlingCreditsRefreshRate:
type: integer
format: int64
maxSyncThrottlingCredits:
type: integer
format: int64
VersionService:
type: object
properties:
storageSearch:
$ref: '#/components/schemas/StorageSearch'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
ISegmentDAO:
type: object
FilterMissingCriteria:
required:
- uri
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
description: Defines 'missing' criteria
IEventPublishServiceReltioEventBaseObject:
type: object
PrettyPrinter:
type: object
IBigQueryClientFactory:
type: object
BigTableConfigMapping:
type: object
properties:
project:
type: string
instanceId:
type: string
kmsEncrypted:
type: boolean
tableName:
type: string
ttl:
type: string
environmentName:
type: string
clientEmail:
type: string
CredentialsProviderResolver:
type: object
Condition:
type: object
Interruptible:
type: object
IPermissionConfigStorage:
type: object
TenantSkippedEventPublishMonitoringService:
type: object
properties:
platformsAccess:
$ref: '#/components/schemas/IPlatformsStatisticsAccess'
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
tenantUpdateMapKey:
type: string
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
random:
$ref: '#/components/schemas/Random'
enabled:
type: boolean
EntityFacetsService:
type: object
properties:
entitySearchService:
$ref: '#/components/schemas/AbstractSearchService'
metadataService:
$ref: '#/components/schemas/MetadataService'
MergeTreeService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
ByteBuffer:
type: object
properties:
mark:
type: integer
format: int32
position:
type: integer
format: int32
limit:
type: integer
format: int32
capacity:
type: integer
format: int32
address:
type: integer
format: int64
segment:
$ref: '#/components/schemas/MemorySegment'
hb:
type: array
items:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
offset:
type: integer
format: int32
isReadOnly:
type: boolean
bigEndian:
type: boolean
nativeByteOrder:
type: boolean
SuboptimalRulesInspectionConfiguration:
type: object
properties:
name:
type: string
type:
type: string
enabled:
type: boolean
disableRule:
type: boolean
parameters:
type: object
additionalProperties:
type: object
ITranscodingErrorsTrackerResolver:
type: object
EntryObjectObject:
type: object
properties:
key:
type: object
value:
type: object
ThreadPoolExecutor:
type: object
properties:
ctl:
$ref: '#/components/schemas/AtomicInteger'
workQueue:
type: array
items:
$ref: '#/components/schemas/Runnable'
mainLock:
$ref: '#/components/schemas/ReentrantLock'
workers:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/Worker'
termination:
$ref: '#/components/schemas/Condition'
container:
$ref: '#/components/schemas/SharedThreadContainer'
largestPoolSize:
type: integer
format: int32
completedTaskCount:
type: integer
format: int64
threadFactory:
$ref: '#/components/schemas/ThreadFactory'
handler:
$ref: '#/components/schemas/RejectedExecutionHandler'
keepAliveTime:
type: integer
format: int64
allowCoreThreadTimeOut:
type: boolean
corePoolSize:
type: integer
format: int32
maximumPoolSize:
type: integer
format: int32
ExplainMatchService:
type: object
properties:
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchStorage:
$ref: '#/components/schemas/MatchStorage'
readOnlyMatchingServiceBase:
$ref: '#/components/schemas/ReadOnlyMatchingServiceBase'
matchTokenFactory:
$ref: '#/components/schemas/MatchTokenFactory'
matchExplainer:
$ref: '#/components/schemas/MatchExplainer'
IPeriodicTaskFactoryObject:
type: object
AzureTokenProvider:
type: object
properties:
tokenCache:
$ref: '#/components/schemas/LoadingCacheTokenCacheKeyCachedToken'
PeriodicTaskThrottlingListener:
type: object
AttemptExceptionReporter:
type: object
MonitoringThreadDumpProducer:
type: object
properties:
isCpuTimeSupported:
type: boolean
objectMapper:
$ref: '#/components/schemas/ObjectMapper'
dumpedProblems:
$ref: '#/components/schemas/CacheStringInteger'
outputDirectory:
$ref: '#/components/schemas/Path'
podId:
type: string
threadDumpOutput:
$ref: '#/components/schemas/PrintStream'
outputStreamSupplier:
$ref: '#/components/schemas/FunctionCheckedFileOutputStream'
threadDumpSupplier:
$ref: '#/components/schemas/SupplierIteratorMapStringObject'
memoryUsageService:
$ref: '#/components/schemas/MemoryUsageService'
lastThreadDumpTimestamp:
type: integer
format: int64
Values:
type: object
properties:
hasNext:
type: boolean
map:
$ref: '#/components/schemas/IdentityMapObjectObject'
nextIndex:
type: integer
format: int32
currentIndex:
type: integer
format: int32
LoadingCacheTenantIdMapEntityTypeURIEntityTypeMatchGroups:
type: object
FilterGreaterOrEqualCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'great or equal' criteria
IAuthenticationProvider:
type: object
ReindexTaskConfig:
type: object
properties:
fetcherPoolSize:
type: integer
format: int32
isMultiThreadedModeEnabled:
type: boolean
queueSize:
type: integer
format: int32
MigrateCassandraHistoryTaskFactory:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
historyService:
$ref: '#/components/schemas/HistoryService'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
periodicTasksService:
$ref: '#/components/schemas/PeriodicTasksService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
AWSLambdaConfig:
type: object
properties:
environmentName:
type: string
tenantBasedRoleAWSAccountId:
type: string
lcaTenantBaseRoleNameTemplate:
type: string
lambdaTimeout:
type: integer
format: int32
maxRetriesPerRegion:
type: integer
format: int32
transientFailureThreshold:
type: integer
format: int32
circuitBreakerCooldownMs:
type: integer
format: int64
ServicesCatalog:
type: object
properties:
map:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ServiceProvider'
IMetricsProviderConfigurator:
type: object
TableTenantIdTenantInitializerIdTenantInitializer:
type: object
TemplateNumberFormatFactory:
type: object
ResilientLambdaInvoker:
type: object
properties:
maxRetriesPerEndpoint:
type: integer
format: int32
circuitBreakerRegistry:
$ref: '#/components/schemas/CircuitBreakerRegistry'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
factory:
$ref: '#/components/schemas/AWSLambdaClientFactory'
cfg:
$ref: '#/components/schemas/Configuration'
CloudStorageServiceFactory:
type: object
properties:
retryPolicy:
$ref: '#/components/schemas/RetryPolicy'
s3HelperFactory:
$ref: '#/components/schemas/IS3HelperFactory'
CleanseAttributeMappings:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
inputMapping:
type: array
description: List of Input mappings
items:
$ref: '#/components/schemas/CleanseAttributeMapping'
inputMappingRef:
type: string
description: Uri of input mapping configuration from other sections
example: >-
configuration/entityTypes/Individual/cleanse/mappings/Address/inputMapping
outputMapping:
type: array
description: List of Output mappings
items:
$ref: '#/components/schemas/CleanseAttributeMapping'
outputMappingRef:
type: string
description: Uri of output mapping configuration from other sections
example: >-
configuration/entityTypes/Individual/cleanse/mappings/Address/outputMapping
description: >-
The mapping section of cleanseConfig contains information about the
common input and output mappings for the cleanse functions. These
mappings may be used inside the cleanse infos.
Input mapping
determines the attributes that are collected from an entity of the
cleanse function
IdentityMapObjectObject:
type: object
properties:
size:
type: integer
format: int32
keyTable:
type: array
items:
type: object
valueTable:
type: array
items:
type: object
capacity:
type: integer
format: int32
stashSize:
type: integer
format: int32
loadFactor:
type: number
format: float
hashShift:
type: integer
format: int32
mask:
type: integer
format: int32
threshold:
type: integer
format: int32
stashCapacity:
type: integer
format: int32
pushIterations:
type: integer
format: int32
bigTable:
type: boolean
entries:
$ref: '#/components/schemas/Entries'
values:
$ref: '#/components/schemas/Values'
keys:
$ref: '#/components/schemas/Keys'
Bucket:
type: object
properties:
value:
$ref: '#/components/schemas/JsonSerializerObject'
next:
$ref: '#/components/schemas/Bucket'
_type:
$ref: '#/components/schemas/JavaType'
_isTyped:
type: boolean
CommonHistoryDAO:
type: object
properties:
historyMarshaller:
$ref: '#/components/schemas/IMarshaller'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
defaultMetadataService:
$ref: '#/components/schemas/MetadataService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
recentObjectChanges:
$ref: '#/components/schemas/IRecentObjectChanges'
maxHistoryCacheElements:
type: integer
format: int32
PeriodicTasksExecutorThread:
type: object
properties:
eetop:
type: integer
format: int64
tid:
type: integer
format: int64
name:
type: string
interrupted:
type: boolean
contextClassLoader:
$ref: '#/components/schemas/ClassLoader'
inheritedAccessControlContext:
$ref: '#/components/schemas/AccessControlContext'
holder:
$ref: '#/components/schemas/FieldHolder'
threadLocals:
$ref: '#/components/schemas/ThreadLocalMap'
inheritableThreadLocals:
$ref: '#/components/schemas/ThreadLocalMap'
scopedValueBindings:
type: object
interruptLock:
type: object
parkBlocker:
type: object
nioBlocker:
$ref: '#/components/schemas/Interruptible'
cont:
$ref: '#/components/schemas/Continuation'
uncaughtExceptionHandler:
$ref: '#/components/schemas/UncaughtExceptionHandler'
threadLocalRandomSeed:
type: integer
format: int64
threadLocalRandomProbe:
type: integer
format: int32
threadLocalRandomSecondarySeed:
type: integer
format: int32
container:
$ref: '#/components/schemas/ThreadContainer'
headStackableScopes:
$ref: '#/components/schemas/StackableScope'
currentExecutingTask:
$ref: '#/components/schemas/AbstractPeriodicTask'
lastExecutedTask:
$ref: '#/components/schemas/AbstractPeriodicTask'
stopped:
type: boolean
autoScalingProtector:
$ref: '#/components/schemas/IAutoScalingProtector'
notifier:
type: object
lock:
type: object
ModuleLayer:
type: object
properties:
cf:
$ref: '#/components/schemas/Configuration'
parents:
type: array
items:
$ref: '#/components/schemas/ModuleLayer'
nameToModule:
type: object
additionalProperties:
$ref: '#/components/schemas/Module'
allLayers:
type: array
items:
$ref: '#/components/schemas/ModuleLayer'
modules:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/Module'
servicesCatalog:
$ref: '#/components/schemas/ServicesCatalog'
OrCondition:
required:
- operator
- uri
type: object
properties:
uri:
type: string
operator:
type: string
value:
type: string
or:
type: array
description: 'List of '
items:
$ref: '#/components/schemas/OrCondition'
and:
type: array
description: 'List of '
items:
$ref: '#/components/schemas/AndCondition'
ErrorSummary:
type: object
properties:
destinationName:
type: string
exceptionClass:
type: string
message:
type: string
timestamp:
type: integer
format: int64
cause:
$ref: '#/components/schemas/ErrorSummary'
partialStack:
type: string
AsyncLoadingCacheUserPrefCacheKeyMapStringListString:
type: object
FastSerializationUtils:
type: object
properties:
metadataService:
$ref: '#/components/schemas/IMetadataService'
categoriesServiceInterface:
$ref: '#/components/schemas/CategoriesServiceInterface'
utilsV3:
$ref: '#/components/schemas/FastSerializationUtilsV3'
freeSerializers:
type: array
items:
$ref: '#/components/schemas/Kryo'
IObjectLabelFetcher:
type: object
InteractionMappingMetadataValidator:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
CacheIntegerApacheV5HttpClient:
type: object
L3ConfigurationHistoryDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
marshaller:
$ref: '#/components/schemas/IMarshaller'
historyTOFactory:
$ref: >-
#/components/schemas/HistoryTOFactoryReltioBusinessModelConfigurationHistorySnapshotTO
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
StackTraceElement:
type: object
properties:
classLoaderName:
type: string
moduleName:
type: string
moduleVersion:
type: string
declaringClass:
type: string
methodName:
type: string
fileName:
type: string
lineNumber:
type: integer
format: int32
format:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
InputDecorator:
type: object
LifecycleListener:
type: object
DataPipelineConfig:
type: object
properties:
enabled:
type: boolean
dataShareEnabled:
type: boolean
paused:
type: boolean
activityLogEnabled:
type: boolean
messagingName:
type: string
environment:
type: string
gbqEnableAdditionalFeatures:
type: boolean
adapters:
type: array
items:
$ref: '#/components/schemas/AdapterConfig'
ArithmeticEngine:
type: object
properties:
minScale:
type: integer
format: int32
maxScale:
type: integer
format: int32
roundingPolicy:
type: integer
format: int32
TenantCreditsOperationsProcessor:
type: object
properties:
creditsService:
$ref: '#/components/schemas/ICreditsService'
OptionalParameters:
type: object
properties:
properties:
type: object
additionalProperties:
type: object
ActivityLogLongTermStorageConfig:
type: object
properties:
enabled:
type: boolean
ttl:
type: string
table:
type: string
gbqLimitBytes:
type: integer
format: int64
quotasControlEnabled:
type: boolean
quotasLowWatermarkPercent:
type: number
format: double
compressJsons:
type: boolean
OAuthInstance:
type: object
properties:
url:
type: string
authUser:
type: string
authPassword:
type: string
clientId:
type: string
clientPassword:
type: string
createdDate:
type: string
format: date-time
updatedDate:
type: string
format: date-time
createdBy:
type: string
updatedBy:
type: string
supportEmail:
type: string
timestamp:
type: integer
format: int64
Base64Variant:
type: object
properties:
_name:
type: string
SupplierIPlatformsInfo:
type: object
NotMatchConfiguration:
type: object
properties:
conditionToRemove:
$ref: '#/components/schemas/ConditionToRemoveManualMatch'
ActivityDAO:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
marshaller:
$ref: '#/components/schemas/IMarshaller'
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
StreamEncoder:
type: object
properties:
writeBuffer:
type: array
items:
type: string
lock:
type: object
closed:
type: boolean
cs:
$ref: '#/components/schemas/Charset'
encoder:
$ref: '#/components/schemas/CharsetEncoder'
bb:
$ref: '#/components/schemas/ByteBuffer'
maxBufferCapacity:
type: integer
format: int32
out:
$ref: '#/components/schemas/OutputStream'
ch:
$ref: '#/components/schemas/WritableByteChannel'
haveLeftoverChar:
type: boolean
leftoverChar:
type: string
lcb:
$ref: '#/components/schemas/CharBuffer'
MatchingStatisticsStorage:
type: object
ILocker:
type: object
SecretsManagerService:
type: object
properties:
awsSecretsManagerClient:
$ref: '#/components/schemas/AWSSecretsManager'
mapper:
$ref: '#/components/schemas/ObjectMapper'
ICreateOrUpdateObjectService:
type: object
RDMCache:
type: object
properties:
enabled:
type: boolean
type:
type: string
properties:
type: object
additionalProperties:
type: object
DynamoDBEncryptionConfig:
type: object
properties:
encryptionType:
type: string
enum:
- DEFAULT
- KMS_AWS
- KMS_CUSTOMER
- KMS_RELTIO
kmsCustomerKeyMap:
type: object
additionalProperties:
$ref: '#/components/schemas/DynamoDBEncryptionKeyConfig'
Lock:
type: object
ObjectMapperProvider:
type: object
properties:
tenantConfigurationProvider:
$ref: '#/components/schemas/TenantConfigurationProvider'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
categoriesServiceInterface:
$ref: '#/components/schemas/CategoriesServiceInterface'
metadataService:
$ref: '#/components/schemas/MetadataService'
permissionsService:
$ref: '#/components/schemas/IPermissionsProvider'
tenantsConfigurationService:
$ref: '#/components/schemas/DefaultSourceTypeNameProvider'
objectMapperFactory:
$ref: '#/components/schemas/ObjectMapperFactory'
mapperThreadLocal:
$ref: '#/components/schemas/ThreadLocalObjectMapper'
mapperByFactoryThreadLocal:
$ref: '#/components/schemas/ThreadLocalMapClassObjectMapper'
writerThreadLocal:
$ref: '#/components/schemas/ThreadLocalStringBuilderWriter'
SuboptimalRulesInspection:
type: object
ClassIntrospector:
type: object
IPlatformsAccess:
type: object
SegmentationLimitsService:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
segmentService:
$ref: '#/components/schemas/SegmentService'
periodicTasksService:
$ref: '#/components/schemas/PeriodicTasksService'
NodeGroupFilter:
type: object
OvSecurityFilterFactoryProvider:
type: object
properties:
v2:
$ref: '#/components/schemas/IOvSecurityFilterFactory'
defaultVersion:
type: string
enum:
- V1
- V2
LcaGcpConfig:
type: object
properties:
googleFunctionTimeOut:
type: integer
description: Google Function LCA time out in milliseconds
format: int32
example: 1000
clientServiceAccountEmail:
type: string
description: GCP service account email ID
example: dummy@dummy-projectId.iam.gserviceaccount.com
reltioServiceAccountKey:
type: string
description: Encrypted Base64-encoded Reltio GCP Service Account JSON Key
example: dummy
description: LCA GCP Configuration
AbstractTypeWithAttributesAbstractTypeURI:
required:
- attributes
type: object
properties:
lifecycleActions:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/LifecycleActionConfig'
description: >-
Life Cycle Action (LCA) allows to inject custom logic for various
operations on Reltio profile. Reltio supported operations(hooks)
are: beforeSave, afterSave, beforeMerge etc.
Configuration of LCA can be done in 2 ways:
1. Simple configuration:
{"beforeSave":["BeforeSaveAction","Lambda/BinaryJSON/LambdaAction"],
"afterMerge":["AfterMergeAction"]}
2. Conditional configuration: {"beforeSave":
[{"actions":["BeforeSaveAction"], "filter":"equals(clientType,
'Reltio UI')"}]}
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for which
object should be considered as active. Inactiveness for object means
that it won't appear in any search results by default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}'
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type. One
group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on the
defined expression
items:
$ref: '#/components/schemas/ruleBasedAttributes'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
description: Base class of EntityType and RelationshipType
PairLongString:
type: object
properties:
a:
type: integer
format: int64
b:
type: string
ConfigurationAwareMatchingStatisticsStorage:
type: object
properties:
delegate:
$ref: '#/components/schemas/MatchingStatisticsStorage'
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
CacheStringPairBooleanLong:
type: object
CharsetEncoder:
type: object
properties:
charset:
$ref: '#/components/schemas/Charset'
averageBytesPerChar:
type: number
format: float
maxBytesPerChar:
type: number
format: float
replacement:
type: array
items:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
malformedInputAction:
$ref: '#/components/schemas/CodingErrorAction'
unmappableCharacterAction:
$ref: '#/components/schemas/CodingErrorAction'
state:
type: integer
format: int32
cachedDecoder:
$ref: '#/components/schemas/WeakReferenceCharsetDecoder'
NeptuneGraphConfiguration:
type: object
properties:
instanceType:
type: string
region:
type: string
role:
type: string
clusterParameterGroup:
type: string
subnetGroup:
type: string
securityGroup:
type: string
ObjectMapperFactory:
type: object
properties:
errorFactory:
$ref: '#/components/schemas/APIErrorFactoryInterface'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantConfigurationProvider:
$ref: '#/components/schemas/TenantConfigurationProvider'
tenantsConfigurationService:
$ref: '#/components/schemas/DefaultSourceTypeNameProvider'
metadataService:
$ref: '#/components/schemas/MetadataService'
nestedAttributeValueTOSerializer:
$ref: '#/components/schemas/NestedAttributeValueTOSerializer'
simpleAttributeValueTOSerializer:
$ref: '#/components/schemas/SimpleAttributeValueTOSerializer'
referenceAttributeValueTOSerializer:
$ref: '#/components/schemas/ReferenceAttributeValueTOSerializer'
Random:
type: object
properties:
seed:
$ref: '#/components/schemas/AtomicLong'
nextNextGaussian:
type: number
format: double
haveNextNextGaussian:
type: boolean
InteractionMappingService:
type: object
properties:
dao:
$ref: '#/components/schemas/IInteractionMappingsDAO'
objectMapper:
$ref: '#/components/schemas/ObjectMapper'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
customerDatabaseService:
$ref: '#/components/schemas/CustomerDatabaseService'
customerDatabaseConfigService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
metadataValidator:
$ref: '#/components/schemas/InteractionMappingMetadataValidator'
EventMonitoringConfiguration:
type: object
properties:
logLevel:
type: string
enum:
- DEBUG
- WARNING
- ERROR
- NO_SNAPSHOTS
- NONE
statesToLog:
type: array
items:
type: string
enum:
- CREATED
- POSTPONED
- OPTIMIZED
- FIRED
- SENT
- RECEIVED
- PARTIALLY_PROCESSED
- PROCESSED
- DEAD
- ANALYTICS_PROCESSED
- DATAPIPELINE_PROCESSED
- GROUPING_PROCESSED
alwaysLogSnapshots:
type: boolean
PotentialMatchesService:
type: object
properties:
roMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
matchGroupsConverter:
$ref: '#/components/schemas/MatchGroupsConverter'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
matchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
marshaller:
$ref: '#/components/schemas/IMarshaller'
matchServiceAccess:
$ref: '#/components/schemas/MatchServiceAccess'
eventPublishService:
$ref: '#/components/schemas/IEventPublishService'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
supplementalMatchingStructuresProvider:
$ref: '#/components/schemas/SupplementalMatchingStructuresProviderImpl'
entityEmbeddingsProvider:
$ref: '#/components/schemas/EntityEmbeddingsProvider'
ThreadLocalPostponedChangesObjectTO:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
AsMatchConfiguration:
type: object
properties:
conditionToRemove:
$ref: '#/components/schemas/ConditionToRemoveManualMatch'
CacheKey:
type: object
properties:
name:
type: string
locale:
$ref: '#/components/schemas/Locale'
moduleRef:
$ref: '#/components/schemas/KeyElementReferenceModule'
callerRef:
$ref: '#/components/schemas/KeyElementReferenceModule'
modulesHash:
type: integer
format: int32
format:
type: string
loadTime:
type: integer
format: int64
expirationTime:
type: integer
format: int64
cause:
$ref: '#/components/schemas/Throwable'
providers:
$ref: '#/components/schemas/ServiceLoaderResourceBundleProvider'
providersChecked:
type: boolean
callerHasProvider:
type: boolean
InteractionMemberType:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify an interaction memer type
configuration element
example: configuration/interactionTypes/Email/memberTypes/From
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
objectTypeUri:
type: string
description: URI of an entity type or role that can be a member of the type
example: configuration/roles/Role1
minOccurs:
type: integer
description: Identifies how many members can be of this member type. Default is 0
format: int32
example: 10
name:
type: string
description: Name of the member type
example: MemberType1
description: Interaction Member Type
CacheStorage:
type: object
CachedCPCount:
type: object
properties:
count:
$ref: '#/components/schemas/AtomicLong'
needsUpdate:
$ref: '#/components/schemas/AtomicBoolean'
APIErrorFactoryInterface:
type: object
SpannerDBConfigMapping:
type: object
properties:
serviceAccount:
type: string
databaseId:
type: string
emulatorHost:
type: string
repositoryVersion:
type: string
region:
type: string
ttl:
type: string
FunctionMatchGroupString:
type: object
ServiceLoaderResourceBundleProvider:
type: object
properties:
serviceName:
type: string
layer:
$ref: '#/components/schemas/ModuleLayer'
loader:
$ref: '#/components/schemas/ClassLoader'
acc:
$ref: '#/components/schemas/AccessControlContext'
lookupIterator1:
$ref: '#/components/schemas/IteratorProviderResourceBundleProvider'
instantiatedProviders:
type: array
items:
$ref: '#/components/schemas/ResourceBundleProvider'
lookupIterator2:
$ref: '#/components/schemas/IteratorProviderResourceBundleProvider'
loadedProviders:
type: array
items:
$ref: '#/components/schemas/ProviderResourceBundleProvider'
loadedAllProviders:
type: boolean
reloadCount:
type: integer
format: int32
ITenantDataProvider:
type: object
PermissionConfigManagerIPermissions:
type: object
properties:
lock:
$ref: '#/components/schemas/ReadWriteLock'
configStorage:
$ref: '#/components/schemas/IPermissionConfigStorage'
permissionConfigCache:
$ref: '#/components/schemas/PermissionConfigCacheIPermissions'
JavaType:
type: object
properties:
_hash:
type: integer
format: int32
_valueHandler:
type: object
_typeHandler:
type: object
_asStatic:
type: boolean
OutputConfig:
type: object
properties:
csv:
$ref: '#/components/schemas/CsvConfig'
IPredicateQueryDAO:
type: object
SuboptimalRulesActionStorage:
type: object
properties:
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
matchGroupsProvider:
$ref: '#/components/schemas/MatchGroupsProvider'
suboptimalRulesActionGBQStorage:
$ref: '#/components/schemas/SuboptimalRulesActionGBQStorage'
matchGroupDigest:
$ref: '#/components/schemas/MatchGroupDigest'
PermissionCollection:
type: object
properties:
readOnly:
type: boolean
UserRoleAccess:
type: object
GraphsDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
SmartExportConfig:
type: object
properties:
maxNumberOfObjectsForEsFilteringFactor:
type: number
format: double
maxNumberOfObjectsForAlwaysEsFiltering:
type: integer
format: int64
maxNumberOfObjectsForEsFiltering:
type: integer
format: int64
maxNumberOfObjectsPerTask:
type: integer
format: int64
taskPartsCountForUnknownEstimatedTotal:
type: integer
format: int32
maxNumberOfActivityItemsPerTask:
type: integer
format: int64
relationsToEntitiesRatio:
type: number
format: double
mergesToEntitiesRatio:
type: number
format: double
maxNumberOfMergesPerTask:
type: integer
format: int64
secondaryDsEnabled:
type: boolean
maxNumberOfRelationsForEsFiltering:
type: integer
format: int64
maxNumberOfRelationsForAlwaysEsFiltering:
type: integer
format: int64
entitiesToGraphRatio:
type: number
format: double
FilterGreaterCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'great' criteria
ObjectsModificationService:
type: object
properties:
options:
$ref: '#/components/schemas/IUnmarshallOptions'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
metadataService:
$ref: '#/components/schemas/MetadataService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
Format:
type: object
IEntitiesMetadataDAO:
type: object
ITenantDataAccessParametersProvider:
type: object
ZeroCopyMetadataService:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
interactionMappingService:
$ref: '#/components/schemas/InteractionMappingService'
customerDatabaseConfigService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
MergeRelationsService:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
detailOperationLogger:
$ref: '#/components/schemas/Logger'
cleanseDictionaryServiceFactoryProvider:
$ref: '#/components/schemas/ICleanseDictionaryServiceFactoryProvider'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
relationsService:
$ref: '#/components/schemas/RelationsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
crudService:
$ref: '#/components/schemas/CRUDService'
useCassandraTransactions:
type: boolean
changeRequestService:
$ref: '#/components/schemas/ChangeRequestService'
RebuildMatchTableTaskFactory:
type: object
properties:
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
internalMatchService:
$ref: '#/components/schemas/InternalMatchService'
matchHubService:
$ref: '#/components/schemas/MatchEventHubService'
hubService:
$ref: '#/components/schemas/CRUDEventHubService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
cloudStorageServiceFactory:
$ref: '#/components/schemas/CloudStorageServiceFactory'
tenantsDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
ClassLoader:
type: object
ApiTaskCommonInfoRowConverter:
type: object
Record:
type: object
properties:
operationName:
type: string
totalExecutions:
$ref: '#/components/schemas/AtomicInteger'
executionsFromLastReport:
$ref: '#/components/schemas/AtomicInteger'
lastReportTimeStamp:
type: integer
format: int64
firstExecutionTimeStamp:
type: integer
format: int64
totalExecutionTimeSum:
$ref: '#/components/schemas/AtomicLong'
executionsFromLastReportTimesSum:
$ref: '#/components/schemas/AtomicLong'
varianceCalculator:
$ref: '#/components/schemas/WelfordSampleVarianceCalculator'
AwsAuth:
type: object
properties:
key:
type: string
secret:
type: string
roleArn:
type: string
externalId:
type: string
url:
type: string
region:
type: string
MatchingConfigurationCache:
type: object
properties:
matchGroupsCache:
$ref: '#/components/schemas/LoadingCacheTenantIdMatchGroupsOfTenant'
matchAttributesCache:
$ref: '#/components/schemas/LoadingCacheTenantIdMatchAttributesOfTenant'
PredefinedMatchGroupsSupplier:
type: object
CustomerDAOService:
type: object
properties:
customerDatabaseService:
$ref: '#/components/schemas/CustomerDatabaseService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
interactionMappingService:
$ref: '#/components/schemas/InteractionMappingService'
metadataService:
$ref: '#/components/schemas/MetadataService'
customerDatabaseConfigService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
IActivityLogEventPublisher:
type: object
Feature Toggles:
type: object
properties:
createNewModel:
type: boolean
description: >-
If this flag is set to false, creating a new model flow is not
allowed
publishModel:
type: boolean
description: If this flag is set to false, publishing a model flow is not allowed
trainModel:
type: boolean
description: If this flag is set to false, training a model is not allowed
shareModel:
type: boolean
description: If this flag is set to false, sharing a model flow is not allowed
autoMerge:
type: boolean
description: >-
If this flag is set to false, auto merge is not allowed as matching
action while publishing a model flow
description: Feature toggle flags
CosmosContainerConfig:
type: object
properties:
indexingConfig:
$ref: '#/components/schemas/CosmosIndexingConfig'
containerId:
type: string
containerThroughput:
$ref: '#/components/schemas/CosmosThroughputConfig'
partitionKeyVersion:
type: string
SerializerCache:
type: object
properties:
_sharedMap:
type: object
additionalProperties:
$ref: '#/components/schemas/JsonSerializerObject'
_readOnlyMap:
$ref: '#/components/schemas/AtomicReferenceReadOnlyClassToSerializerMap'
IEmbeddingsAPIClient:
type: object
LRUMapObjectJavaType:
type: object
IActivityLogService:
type: object
SegmentationConfigurationService:
type: object
properties:
segmentationLimitsService:
$ref: '#/components/schemas/SegmentationLimitsService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
NestedCleanser:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
monitoringLog:
$ref: '#/components/schemas/Logger'
warningsLog:
$ref: '#/components/schemas/Logger'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
amazonS3ClientFactory:
$ref: '#/components/schemas/AmazonS3ClientFactory'
logJsonField:
$ref: '#/components/schemas/MessageFormat'
overwriteObjectService:
$ref: '#/components/schemas/OverwriteObjectService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
envLevelCleanseChainResolveLookup:
type: boolean
configuration:
$ref: '#/components/schemas/Configuration'
doAttrDeepCloneInCleanse:
type: boolean
marshaller:
$ref: '#/components/schemas/IMarshaller'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
idUtils:
$ref: '#/components/schemas/IDUtils'
nestedAttributeHandler:
$ref: '#/components/schemas/NestedAttributeHandler'
useOptimizedCleanser:
type: boolean
MixInResolver:
type: object
MailService:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
mailSender:
$ref: '#/components/schemas/IMailSender'
freemarkerConfiguration:
$ref: '#/components/schemas/Configuration'
applicationConfiguration:
$ref: '#/components/schemas/Configuration'
mailFromAddress:
type: string
mailFromName:
type: string
emailTemplate:
type: string
exportDownloadLinkEmailSubject:
type: string
exportProblemsEmailTemplate:
type: string
periodicTaskProblemsEmailTemplate:
type: string
periodicTaskProblemsInternalEmailTemplate:
type: string
periodicTaskProblemsMailList:
type: string
exportDownloadLinkEmailTemplate:
type: string
updateAttributesCompletionEmailTemplate:
type: string
updateAttributesCompletionEmailSubject:
type: string
deleteEntitiesCompletionEmailTemplate:
type: string
deleteEntitiesCompletionEmailSubject:
type: string
NestedAttributeValueTOSerializer:
type: object
SystemMetadataConfigAccess:
type: object
BaseSettings:
type: object
properties:
_classIntrospector:
$ref: '#/components/schemas/ClassIntrospector'
_annotationIntrospector:
$ref: '#/components/schemas/AnnotationIntrospector'
_propertyNamingStrategy:
$ref: '#/components/schemas/PropertyNamingStrategy'
_typeFactory:
$ref: '#/components/schemas/TypeFactory'
_typeResolverBuilder:
$ref: '#/components/schemas/TypeResolverBuilderObject'
_typeValidator:
$ref: '#/components/schemas/PolymorphicTypeValidator'
_dateFormat:
$ref: '#/components/schemas/DateFormat'
_handlerInstantiator:
$ref: '#/components/schemas/HandlerInstantiator'
_locale:
$ref: '#/components/schemas/Locale'
_timeZone:
$ref: '#/components/schemas/TimeZone'
_defaultBase64:
$ref: '#/components/schemas/Base64Variant'
TypeFactory:
type: object
properties:
_typeCache:
$ref: '#/components/schemas/LRUMapObjectJavaType'
_modifiers:
type: array
items:
$ref: '#/components/schemas/TypeModifier'
_parser:
$ref: '#/components/schemas/TypeParser'
_classLoader:
$ref: '#/components/schemas/ClassLoader'
ESSearchLatencyTracker:
type: object
GroupsOVSearchFilterFactory:
type: object
properties:
indexMetadataProvider:
$ref: '#/components/schemas/FunctionTenantIdMappingMetadataWrapper'
metadataService:
$ref: '#/components/schemas/IMetadataService'
ThrottlingStorageTypeConfig:
type: object
properties:
priorityThrottlingCreditsRefreshRate:
type: integer
format: int64
maxPriorityThrottlingCredits:
type: integer
format: int64
syncThrottlingCreditsRefreshRate:
type: integer
format: int64
maxSyncThrottlingCredits:
type: integer
format: int64
asyncThrottlingCreditsRefreshRate:
type: integer
format: int64
maxAsyncThrottlingCredits:
type: integer
format: int64
internalThrottlingCreditsRefreshRate:
type: integer
format: int64
maxInternalThrottlingCredits:
type: integer
format: int64
CustomerNameResolver:
type: object
properties:
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
AttributeVerificationService:
type: object
IEsSnapshotService:
type: object
MessagingConfigurationLoader:
type: object
IBigTableConfigurationProvider:
type: object
AddressAutoCompleteConfig:
type: object
properties:
providerName:
type: string
minSearchTextLen:
type: integer
format: int32
secureOpts:
type: object
additionalProperties:
type: object
providerOpts:
type: object
additionalProperties:
type: object
ILifeCycleActionsService:
type: object
DTSSInfo:
type: object
properties:
tenantId:
type: string
description: Tenant Id of Data Tenant provided by DTSS
example: dfsdfsdf2
operationId:
type: string
description: Operation Id provided by DTSS
example: 123e4567-e89b-12d3-a456-556642440000
matchReasons:
uniqueItems: true
type: array
description: Set of reasons why DTSS has updated this object
items:
type: string
updatedBy:
type: string
description: UpdatedBy provided by DTSS
updatedTime:
type: integer
description: Updated Time provided by DTSS
format: int64
status:
type: string
description: Status provided by DTSS
matchRuleUris:
uniqueItems: true
type: array
description: Match Rules provided by DTSS
items:
type: string
description: Additional information of crosswalk provided by DTSS
SegmentationCommonService:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
segmentService:
$ref: '#/components/schemas/SegmentService'
segmentSearchService:
$ref: '#/components/schemas/ISegmentSearch'
metadataService:
$ref: '#/components/schemas/MetadataService'
segmentationConfigurationService:
$ref: '#/components/schemas/SegmentationConfigurationService'
segmentAnalyticAttributeUpdater:
$ref: '#/components/schemas/ISegmentAnalyticsAttributeUpdater'
periodicTaskService:
$ref: '#/components/schemas/PeriodicTasksService'
customerDAOService:
$ref: '#/components/schemas/CustomerDAOService'
FilterInCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: List of the values to compare with
example: John,Bob,Joe
description: Defines 'in' criteria
RebuildMatchTableV2Configuration:
type: object
properties:
matchJob:
type: string
writeMatchesBatchSize:
type: integer
format: int32
overcollisionedTokenThreshold:
type: integer
format: int32
LogRequestsConfig:
type: object
properties:
enabled:
type: boolean
maskData:
type: boolean
includeOperationTime:
type: boolean
includeHeaders:
type: boolean
uriSubString:
type: string
uriRegEx:
type: string
bodySubString:
type: string
bodyRegEx:
type: string
requiredRequestParameters:
type: object
additionalProperties:
type: string
prohibitedRequestParameters:
type: object
additionalProperties:
type: string
uriPattern:
type: object
properties:
pattern:
type: string
flags:
type: integer
format: int32
$ref: '#/components/schemas/Pattern'
bodyPattern:
type: object
properties:
pattern:
type: string
flags:
type: integer
format: int32
$ref: '#/components/schemas/Pattern'
TenantConfiguration:
type: object
properties:
type:
type: string
enum:
- PLATFORM
- ACTIVITY_LOG
tenantId:
type: string
tenantName:
type: string
customerName:
type: string
analyticsConfig:
$ref: '#/components/schemas/AnalyticsConfig'
encryptionConfig:
$ref: '#/components/schemas/TenantEncryptionConfiguration'
dataStorageConfig:
$ref: '#/components/schemas/TenantDatabaseConfiguration'
searchStorageConfiguration:
$ref: '#/components/schemas/TenantSearchBufferedConfiguration'
vectorConfiguration:
$ref: '#/components/schemas/TenantVectorConfiguration'
drConfig:
$ref: '#/components/schemas/TenantDisasterRecoveryConfiguration'
matchingConfiguration:
$ref: '#/components/schemas/TenantMatchingConfiguration'
objectSizeLimitsConfig:
$ref: '#/components/schemas/ObjectSizeLimitsConfig'
defaultCrosswalk:
type: string
defaultTenant:
type: string
lookupsOperationalValue:
type: string
enum:
- LOOKUP_CODE
- LOOKUP_VALUE
tenantInternalId:
type: integer
format: int32
streamingConfig:
$ref: '#/components/schemas/StreamingConfig'
eventQueuesConfig:
$ref: '#/components/schemas/TenantEventQueuesConfiguration'
addressAutoCompleteConfig:
$ref: '#/components/schemas/AddressAutoCompleteConfig'
attributeVerificationConfig:
$ref: '#/components/schemas/AttributeVerificationConfig'
cleanse:
type: array
items:
$ref: '#/components/schemas/TenantCleanseFunctionConfiguration'
cacheProviderUri:
type: string
cachedColumnFamilies:
type: array
items:
type: string
cachingColumnFamilies:
type: array
items:
type: string
cacheUninstallingColumnFamilies:
type: array
items:
type: string
maxChangedObjects:
type: integer
format: int32
allowSkipReferenceObjectsUpdate:
type: boolean
preliminaryConsistencyCheckThreshold:
type: integer
format: int32
maxInteractionsToFetchPerEntity:
type: integer
format: int32
maxFetchSizeForOneHopRow:
type: integer
format: int32
maxOneHopTotalFetchSize:
type: integer
format: int32
lifecycleActionsService:
type: string
objectsInTreeLimit:
type: integer
format: int32
traverseStepLimit:
type: integer
format: int32
awsAccessKey:
type: string
awsSecretKey:
type: string
awsReltioExternalId:
type: string
awsReltioRole:
type: string
awsRoleExternalId:
type: string
awsIAMExternalRole:
type: string
awsRegion:
type: string
failoverRegions:
type: array
items:
type: string
tenantBasedRole:
type: boolean
loggingConfig:
$ref: '#/components/schemas/LoggingConfig'
rdmConfig:
$ref: '#/components/schemas/RDMConfig'
ignoreMultipleContributorsError:
type: boolean
logRequestsConfig:
$ref: '#/components/schemas/LogRequestsConfig'
maxTaskPartsCount:
type: integer
format: int32
ownerEmails:
type: array
items:
type: string
maxRequestsPerNode:
type: integer
format: int32
maxRequestsPerCluster:
type: integer
format: int32
updateAttributesEntitiesBatchSize:
type: integer
format: int32
useEntityLinksCF:
type: boolean
resolveEntityLinksUsingEntityLinksCF:
type: boolean
maxLookupsCacheSize:
type: integer
format: int32
permanentLookupsStore:
type: boolean
useActivityLogInTasks:
type: boolean
gdprComplianceRequired:
type: boolean
dataProtectionTaskTimeWaitThreshold:
type: integer
format: int32
dataLoaderConfig:
$ref: '#/components/schemas/DataLoaderConfig'
exportConfig:
$ref: '#/components/schemas/ExportConfig'
creditsConfig:
$ref: '#/components/schemas/CreditsConfig'
graphConfig:
$ref: '#/components/schemas/TenantGraphConfiguration'
requestGroups:
type: array
items:
$ref: '#/components/schemas/RequestGroupConfig'
requestGroupsCache:
type: object
additionalProperties:
type: string
dataModelerConstraints:
$ref: '#/components/schemas/DataModelerConstraints'
isProcessingWithNegativeCreditsBalance:
type: boolean
enforceAsyncThrottling:
type: boolean
enforceInternalThrottling:
type: boolean
enforceSyncThrottling:
type: boolean
enforcePriorityThrottling:
type: boolean
updateAttributeUpdateDatesOnActualChanges:
type: boolean
alwaysFillStartEndObjectCrosswalks:
type: boolean
maxHistoryBufferSize:
type: integer
format: int32
userPreferencesCacheEnabled:
type: boolean
physicalConfigValidationEnabled:
type: boolean
businessConfigValidationEnabled:
type: boolean
strategiesWithNewBehaviour:
type: array
items:
type: string
updatedTime:
type: integer
format: int64
version:
type: string
createdTime:
type: integer
format: int64
createdBy:
type: string
updatedBy:
type: string
suspendable:
type: boolean
monitoring:
$ref: '#/components/schemas/TenantMonitoringConfiguration'
activityLogConfig:
$ref: '#/components/schemas/ActivityLogConfig'
enableNestedPartialOverride:
type: boolean
enableReferencePartialOverride:
type: boolean
collapseNonOvNestedsWhenMatchOvOnlyEnabled:
type: boolean
enableTenantPerRoleSecurity:
type: boolean
eventsSizeLimit:
type: integer
format: int64
immutableRefAttrsByDefault:
type: boolean
connectRelationsToDefaultCrosswalk:
type: boolean
optionalParameters:
$ref: '#/components/schemas/OptionalParameters'
historyCache:
$ref: '#/components/schemas/HistoryCache'
maxPeriodicTasksPerTenant:
type: integer
format: int32
allowIgnoreLocks:
type: boolean
allowSkipRefChecks:
type: boolean
maintenance:
type: boolean
cloudType:
type: string
maxEntitiesToLoadForLimitedGraph:
type: integer
format: int32
dataPipelineConfig:
$ref: '#/components/schemas/DataPipelineConfig'
groupingConfig:
$ref: '#/components/schemas/GroupingConfig'
lcaConfig:
$ref: '#/components/schemas/LcaConfig'
fileStorageConfigs:
$ref: '#/components/schemas/File storage configuration'
applyDcrWithoutPermissions:
type: boolean
overridePrevValueStatus:
type: boolean
restOperationsCacheConfig:
$ref: '#/components/schemas/TenantRestOperationsCacheConfig'
predicateAPIConfig:
$ref: '#/components/schemas/PredicateAPIConfig'
mcpConfig:
$ref: '#/components/schemas/MCPConfig'
agentsConfig:
$ref: '#/components/schemas/AgentsConfig'
contributorCrosswalkSingleSourceUpdateMode:
type: boolean
systemEventsEnabled:
type: boolean
newWinnerElectedOnOriginDetachmentEnabled:
type: boolean
segmentationConfiguration:
$ref: '#/components/schemas/SegmentationConfiguration'
consolidatedProfilesLimit:
type: integer
format: int64
CustomerDatabaseConfigService:
type: object
properties:
dao:
$ref: '#/components/schemas/ICustomerDatabaseConfigDAO'
objectMapper:
$ref: '#/components/schemas/ObjectMapper'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
ConfigOverrides:
type: object
properties:
_overrides:
type: object
additionalProperties:
$ref: '#/components/schemas/MutableConfigOverride'
_defaultInclusion:
$ref: '#/components/schemas/Value'
_defaultSetterInfo:
$ref: '#/components/schemas/Value'
_visibilityChecker:
$ref: '#/components/schemas/VisibilityCheckerObject'
_defaultMergeable:
type: boolean
_defaultLeniency:
type: boolean
SupplierBusinessObjectsService:
type: object
CharacterEscapes:
type: object
StaticOVSearchFilterFactory:
type: object
properties:
indexMetadataProvider:
$ref: '#/components/schemas/FunctionTenantIdMappingMetadataWrapper'
CreditsConfig:
type: object
properties:
primary:
$ref: '#/components/schemas/ThrottlingStorageTypeConfig'
matching:
$ref: '#/components/schemas/ThrottlingStorageTypeConfig'
WritableByteChannel:
type: object
GeoLocationAttribute:
type: object
properties:
latitude:
type: string
description: Geo location latitude
example: '37.52802455433206'
longitude:
type: string
description: Geo location longitude
example: '-122.26282991454705'
LifeCycleRestClientFactory:
type: object
StreamingConfig:
type: object
properties:
streamingEnabled:
type: boolean
streamingAPIEnabled:
type: boolean
jmsBrokerUrl:
type: string
jmsUser:
type: string
jmsPassword:
type: string
jmsDestinationType:
type: string
enum:
- Queue
- Topic
- Both
jmsDestinationPrefix:
type: string
eventsTimeToLive:
type: integer
format: int64
jmsEventsFilteringFields:
uniqueItems: true
type: array
items:
type: string
relationEventsFilteringFields:
uniqueItems: true
type: array
items:
type: string
jmsIncludeMergeTime:
type: boolean
analyzeOvChanges:
type: boolean
emptyStartEndRelationCrosswalks:
type: boolean
largeObjectsSupport:
type: boolean
skipPayload:
type: boolean
payloadType:
type: string
enum:
- SNAPSHOT
- DELTAS
- SNAPSHOT_WITH_DELTA
messagingConfig:
$ref: '#/components/schemas/MessagingConfig'
ovOnly:
type: boolean
ignoreReferenceUpdateEvents:
type: boolean
skipEnddatedRefAttributes:
type: boolean
Keys:
type: object
properties:
hasNext:
type: boolean
map:
$ref: '#/components/schemas/IdentityMapObjectObject'
nextIndex:
type: integer
format: int32
currentIndex:
type: integer
format: int32
Attribute:
required:
- name
- type
type: object
properties:
uri:
type: string
description: >-
The path used to reach an attribute configuration.
Format:
configuration/{objectType}/attributes/{AttributeName}
example: configuration/entityTypes/Organization/attributes/Name
label:
type: string
description: Name of the attribute how to display it in Reltio UI
example: Organization Name
columnName:
type: string
description: Name of the attribute in the underlying database
example: PurchaseAmt
name:
type: string
description: >-
Name of the attribute used by Data API. Should be exactly the same
as the last part of uri
example: Name
description:
type: string
description: Description of the attribute
example: Name of the Organization
type:
type: string
description: Type of attribute from the configuration.
example: String
enum:
- String
- StringNotTokenized
- Long
- Int
- Number
- Float
- Boolean
- Date
- Timestamp
- Blob
- URL
- Blog URL
- Image URL
- SSN
- Id card (Passport)
- SIC-code
- NAICS-code
- Email domains
- Ticker symbol
- CIK id
- Stock exchange
- GeoLocation
- Nested
- Reference
valueType:
type: string
lookupCode:
type: string
description: Lookup code
example: rdm/lookupTypes/Country
dependentLookupAttributes:
type: string
description: Dependent lookup attributes
example: >-
configuration/entityTypes/Organization/attributes/TypeCode,
configuration/entityTypes/Organization/attributes/SubTypeCode
resolveLookupCode:
type: boolean
description: Resolve lookup and use a canonical code as the attribute value
example: false
hidden:
type: boolean
description: >-
It allows marking an attribute as hidden. The hidden attributes will
be present in the response only when the sendHidden option is
used in the request. This flag can be used by applications to
determine when to display characteristics of attributes. For
example, the Reltio UI does not display attributes marked as hidden
example: false
important:
type: boolean
description: >-
Deprecated - do not use. Marks the attributes that are
important in the UI with a bold font or asterisks
example: false
system:
type: boolean
description: >-
Marker that the attribute is system. System attributes cannot be
changed during configuration inheritance
example: false
required:
type: boolean
description: >-
Specifies whether at least one value for the attribute required or
not
example: false
dataLabelPattern:
type: string
faceted:
type: boolean
description: >-
If true, this attribute will be displayed in the +More
list on the Search page when the entity is selected
example: false
searchable:
type: boolean
description: >-
If true, this attribute will be displayed in the Advanced
Search page when the entity is selected
example: false
maxOccurs:
minimum: 1
type: integer
description: Maximum number of values to display at Reltio UI
format: int32
example: 5
autoGenerated:
type: boolean
description: >-
If true, the value of attribute will be auto-generated. By
default, false
example: false
generator:
type: string
description: The generator name (if autoGenetated is true
example: SequentialGenerator
autoGenerationPattern:
type: string
description: >-
Pattern for autogenerated value. {value} will be substituted by
generated value
example: ID_{value}
generateIfEmpty:
type: boolean
description: >-
If true, the value will be generated even if it wasn't sent.
By default, false
example: false
generateIfNotEmpty:
type: boolean
description: >-
If true, the value will be generated if it was sent. By
default, true
example: true
generatedValueUniqueForCrosswalk:
type: boolean
description: >-
If true, existing value by crosswalk will be reused instead
of generating a new one. By default, false
example: false
autoGenerationNestedPattern:
type: object
additionalProperties:
type: string
description: Used to specify auto-generated patterns for sub-attributes
example: '{"Type": "UID", "Value": "ID_{value}"}'
values:
type: array
description: List of possible values for the attribute
example: Value1, Value2, Value3
items:
type: string
referencedAttributeURIs:
type: array
description: >-
A Reference attribute does not have its own attributes. It is using
attributes of a relationship and referenced entity. In this
property, an array of relationship and referenced entity URIs is the
set that will be used as part of the reference attribute
example: >-
configuration/relationTypes/HasAddress/attributes/AddressType,
configuration/entityTypes/Location/attributes/City
items:
type: string
immutableForSources:
uniqueItems: true
type: array
description: >-
Used to define an array of source systems (URIs and ids can be used)
for which it is not possible to change the value of sub-attributes
that came from the referenced entity (you still can change values
from the relation)
example: configuration/sources/Source1, configuration/sources/Source2
items:
type: string
immutableExceptForSources:
uniqueItems: true
type: array
description: >-
Defines a list of sources that will ignore the immutable parameter.
As a result, attribute values that come from one of defined sources
will anyway change the reference object
example: configuration/sources/Source3, configuration/sources/Source4
items:
type: string
immutable:
type: boolean
description: >-
Defines the Immutable Reference Attributes. This parameter overrides
the immutableRefAttrsByDefault parameter from the tenant
configuration for this particular attribute
example: false
doNotOverrideForSourceURIs:
type: array
description: >-
In case of profile override, if the reference attribute is not
provided in a request, then the existing reference attributes from
sources (specified in this parameter) will not be deleted. You will
need to delete relationships that are no longer needed
example: configuration/sources/Source5, configuration/sources/Source6
items:
type: string
keyAttributeURIs:
type: array
description: >-
Array of sub-attribute uris whose values are compared by Exact
logic:- false: even if one value is NULL
- if an
existing value is NOT exactly the same as the value that was
sent
example: >-
configuration/entityTypes/Organization/attributes/Address/attributes/AddressType
items:
type: string
keyAttributeURIsExactOrNull:
type: array
description: >-
Array of sub-attribute uris whose values are compared by Exact Or
NULL logic:- true: if even one value is NULL
- false: if
an existing value is NOT exactly the same as the value that was
sent
example: >-
configuration/entityTypes/Organization/attributes/Address/attributes/AddressType
items:
type: string
keyAttributeURIsExactOrAllNull:
type: array
description: >-
Array of sub-attribute uris whose values are compared by Exact or
All NULL logic:- true: if an existing value is exactly the
same as the value that was sent (NULL is considered as a
value)
example: >-
configuration/entityTypes/Organization/attributes/Address/attributes/AddressType
items:
type: string
keyAttributeURIsIgnoreCase:
type: boolean
description: >-
Is used along with other keyAttributeURIs. By enabling this flag, it
makes comparison case insensitive
example: false
matchFieldURIs:
type: array
description: >-
Is used to define match rules for merging nested
attributes:- Merge if all matchFields are the same, but there
are some other different sub-attributes
- Do not merge
attributes having all the same fields if not all of matchFields are
defined. The reason is there is not enough information to consider
these attributes equal
example: >-
configuration/entityTypes/Individual/attributes/Education/University,
configuration/entityTypes/Individual/attributes/Education/Degree
items:
type: string
matchFieldURIsExactOrNull:
type: array
description: >-
Is used to define match rules for merging nested
attributes:- Merge if all matchFields are the same or missing
in any nested attribute, but there are some other different
sub-attributes
example: >-
configuration/entityTypes/Individual/attributes/Education/GPA,
configuration/entityTypes/Individual/attributes/Education/Graduated
items:
type: string
matchFieldURIsExactOrAllNull:
type: array
description: >-
Is used to define match rules for merging nested
attributes:- Merge if all matchFields are the same or are
missing in both nested attributes, but there are some other
different sub-attributes
- Do not merge attributes having all
the same fields if some of matchFields are defined only in one
attribute
example: >-
configuration/entityTypes/Individual/attributes/Education/YearOfGraduation,
configuration/entityTypes/Individual/attributes/Education/YearsInProgram
items:
type: string
matchFieldURIsIgnoreCase:
type: boolean
description: >-
Is used along with other matchFieldURIs for merging nested
attributes. By enabling this flag, it makes comparison case
insensitive
example: false
matchOvOnly:
type: boolean
description: >-
Is used to define match rules for merging nested attributes.
Specifies whether non-OV values of sub-attributes would be
considered when merging different values of the nested
attribute
example: false
singleValue:
type: boolean
description: >-
If true, then only one value can appear in the attribute in the
entity. If you specify several different values (possibly from
different sources), then all these values will be combined into one
nested attribute value (with different values for sub-attributes)
example: false
singleValueByCrosswalk:
type: boolean
description: >-
If true, then only one value for a particular source can appear in
the attribute in the entity. If you specify several different values
(from the same source), then all these values will be combined into
one nested attribute value (with different values for
sub-attributes). In case of partial override, such nested attribute
from the request body will not substitute whole value for the "data
provider" crosswalk, but it will override (partially) sub-attributes
inside the value
example: false
singleValueByCrosswalkSources:
$ref: '#/components/schemas/SingleValueByCrosswalkSources'
referencedEntityTypeURI:
type: string
description: >-
The URI of entity type or role that is referenced from an entity
though relationshipTypeURI
example: configuration/entityTypes/Location
relationshipTypeURI:
type: string
description: >-
A Reference attribute does not have its own attributes. It is using
attributes of a relationship and referenced entity. In this
property, an array of relationship and referenced entity URIs is the
set that will be used as part of the reference attribute
example: configuration/relationTypes/HasAddress
referenceAttributeDirection:
type: string
description: >-
Specifies whether the reference attribute should appear in the
entity when a relationship of type relationshipTypeURI is present
example: both
enum:
- both
- parentToChild
- childToParent
relationshipLabelPattern:
type: string
description: >-
The pattern that is used to build the attribute relationship value
label. It can include static text as well as patterns-attributes in
curly brackets. With square brackets you can define conditional
label patterns: if an attribute used inside the brackets does not
exist, then all content inside the brackets will be skipped. If
relationshipLabelPatternis not specified, label is used
example: '{FirstName} {MiddleName} {LastName}[, {Credentials}]'
survivorshipStrategy:
type: string
description: Name of the survivorship strategy to be applied for the attribute
example: SRC_SYS
attributeOrdering:
$ref: '#/components/schemas/OrderingStrategy'
attributeMasking:
$ref: '#/components/schemas/masking'
attributes:
type: array
description: Array of possible nested attributes
items:
$ref: '#/components/schemas/Attribute'
dataLabelPatternHolder:
$ref: '#/components/schemas/LocalizablePatternHolder'
cardinality:
$ref: '#/components/schemas/Cardinality'
defaultValue:
type: string
description: Default value for the attribute
example: A value
skipInDataAccess:
type: boolean
description: Whether to skip the attribute in Reltio Analytics
example: false
customReltioId:
type: boolean
description: >-
Specifies if we should skip generation of the attribute value for
the ReltioId attribute and use value specified in a request body
example: false
vectorized:
type: boolean
description: >-
If true, the attribute will be vectorized and available for
semantic search filters. By default, false
example: false
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
enableNestedPartialOverride:
type: boolean
description: >-
This boolean value determine, whether this attribute can be partial
override or not. This has more priority than tenant config
enableNestedPartialOverride.
description: >-
In the Reltio Business Model configuration you can configure the
attributes within Entity Types, Relation Types, and Interaction
Types.
Reltio supports six types of attributes:
- Simple:
Attributes with atomic values.
- Enumerated: Simple attributes
with a predefined set of values.
- Lookup: Simple attributes with
a predefined set of values loaded from a JSON file and thus can be
easily changed.
- Nested: Non-atomic attributes that can have
simple or nested attributes. An example is the Education attribute that
consists of atomic simple attributes such as University, Year of
Graduation, and Degree.
- Reference: Non-atomic attributes that
reference properties of another entity object. An example is the Address
attribute which references the Location entity. Multiple objects can
reference the same object. Typically used to model a M:M
relationship.
PhysicalTenantConfigurationHistoryDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
marshaller:
$ref: '#/components/schemas/IMarshaller'
historyTOFactory:
$ref: >-
#/components/schemas/HistoryTOFactoryPhysicalConfigurationHistoryDataPhysicalConfigurationHistorySnapshotTO
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
CharBuffer:
type: object
properties:
mark:
type: integer
format: int32
position:
type: integer
format: int32
limit:
type: integer
format: int32
capacity:
type: integer
format: int32
address:
type: integer
format: int64
segment:
$ref: '#/components/schemas/MemorySegment'
hb:
type: array
items:
type: string
offset:
type: integer
format: int32
isReadOnly:
type: boolean
ThreadLocalPostponedChangesRelationTO:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
DeserializationConfig:
type: object
properties:
_mapperFeatures:
type: integer
format: int32
_base:
$ref: '#/components/schemas/BaseSettings'
_mixIns:
$ref: '#/components/schemas/SimpleMixInResolver'
_subtypeResolver:
$ref: '#/components/schemas/SubtypeResolver'
_rootName:
$ref: '#/components/schemas/PropertyName'
_attributes:
$ref: '#/components/schemas/ContextAttributes'
_rootNames:
$ref: '#/components/schemas/RootNameLookup'
_configOverrides:
$ref: '#/components/schemas/ConfigOverrides'
_problemHandlers:
$ref: '#/components/schemas/LinkedNodeDeserializationProblemHandler'
_nodeFactory:
$ref: '#/components/schemas/JsonNodeFactory'
_deserFeatures:
type: integer
format: int32
_parserFeatures:
type: integer
format: int32
_parserFeaturesToChange:
type: integer
format: int32
_formatReadFeatures:
type: integer
format: int32
_formatReadFeaturesToChange:
type: integer
format: int32
SchemalessInteractionService:
type: object
properties:
interactionsDAO:
$ref: '#/components/schemas/InteractionsDAO'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
metadataService:
$ref: '#/components/schemas/MetadataService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
PostRebuildMatchTableCheckTaskFactory:
type: object
properties:
matchHubService:
$ref: '#/components/schemas/MatchEventHubService'
hubService:
$ref: '#/components/schemas/CRUDEventHubService'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
consistencyService:
$ref: '#/components/schemas/ConsistencyService'
cloudStorageServiceFactory:
$ref: '#/components/schemas/CloudStorageServiceFactory'
marshaller:
$ref: '#/components/schemas/IMarshaller'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
tenantSkippedEventPublishMonitoringService:
$ref: '#/components/schemas/TenantSkippedEventPublishMonitoringService'
applicabilityEvaluator:
$ref: '#/components/schemas/MatchRuleApplicabilityEvaluator'
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
tenantsDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
metadataService:
$ref: '#/components/schemas/MetadataService'
unmergeEntitiesSplitter:
$ref: '#/components/schemas/UnmergeEntitiesSplitter'
cleanseService:
$ref: '#/components/schemas/CleanseService'
CleanseDictionaryConfiguration:
type: object
properties:
rdmConfig:
$ref: '#/components/schemas/RDMServiceDefinition'
hashCode:
type: integer
format: int32
ModelLoadedListener:
type: object
ConsumerCollectionRelationTO:
type: object
Generics:
type: object
properties:
kryo:
$ref: '#/components/schemas/Kryo'
genericTypesSize:
type: integer
format: int32
genericTypes:
type: array
items:
$ref: '#/components/schemas/GenericType'
depths:
type: array
items:
type: integer
format: int32
argumentsSize:
type: integer
format: int32
arguments:
type: array
items:
$ref: '#/components/schemas/Type'
ISystemDAOsFactory:
type: object
IFilterMatchGroup:
type: object
DataLoaderConfig:
type: object
properties:
udlCloud:
type: string
sourceType:
type: string
maxThreadsCount:
type: integer
format: int32
batchSize:
type: integer
format: int32
maxErrorsCount:
type: integer
format: int32
maxGroupingFilesSizeGb:
type: integer
format: int32
parallelJobsCount:
type: integer
format: int32
premiumSettings:
$ref: '#/components/schemas/PremiumSettings'
groupingEnabled:
type: boolean
maxActiveJobsCount:
type: integer
format: int32
TenantSearchConfiguration:
type: object
properties:
esHosts:
type: string
esClusterName:
type: string
numberOfShards:
type: integer
format: int32
numberOfRelationsShards:
type: integer
format: int32
numberOfActivitiesShards:
type: integer
format: int32
numberOfInteractionsShards:
type: integer
format: int32
waitForAllShards:
type: boolean
indexRequestTimeout:
type: integer
format: int32
numberOrReplicas:
type: integer
format: int32
maxNumberOfResults:
type: integer
format: int32
refreshIndexOnInserts:
type: boolean
indexRefreshInterval:
type: integer
format: int64
maxNumberOfIndexRequests:
type: integer
format: int32
maxNumberOfIndexRequestsPerCluster:
type: integer
format: int32
indexRelations:
type: boolean
indexActivityDelta:
type: boolean
separateMLMatchRulesInSearch:
type: boolean
indexDocumentSources:
type: boolean
indexOvStrategy:
type: string
enum:
- NONE
- STATIC
- GROUPS
indexOnlySearchableAttributes:
type: boolean
indexRDMLookups:
type: boolean
preserveCursor:
type: boolean
maxAttributeLength:
type: integer
format: int32
prefixSearchMaxExpansions:
type: integer
format: int32
bufferedIndexNames:
type: object
additionalProperties:
type: string
enableBufferedCluster:
type: boolean
indexExportCsvHeaders:
type: boolean
maxSearchFileLines:
type: integer
format: int32
defaultBoostFactor:
type: number
format: float
indexShardMonitoring:
type: boolean
prepareRelationIndex:
type: boolean
eventHubBackpressure:
type: boolean
bufferedIndexWithNoReplicas:
type: boolean
indexingErrorsMonitoring:
type: boolean
indexRelevanceScores:
type: boolean
indexWildcardTextFields:
type: boolean
stopIndexation:
type: boolean
queryBuilderAttributeList:
type: boolean
authentication:
$ref: '#/components/schemas/SearchAuthenticationConfig'
appendEqualsAnalyzedForContainsWordStartingWith:
type: boolean
backpressureVersion:
type: string
enum:
- V1
- V2
maxFilterClauses:
type: integer
format: int32
ovSecurityFilterFactoryVersion:
type: string
enum:
- V1
- V2
reindexTaskConfig:
$ref: '#/components/schemas/ReindexTaskConfig'
PeriodicTaskConfiguration:
type: object
properties:
maxThrottlingDelay:
type: integer
format: int64
throttlingDelayStep:
type: integer
format: int64
throttleThreshold:
type: number
format: double
unthrottleThreshold:
type: number
format: double
tasksReadingWaitPeriod:
type: integer
format: int64
maxTaskPartsCount:
type: integer
format: int32
ITenantDataAccess:
type: object
ITenantsDAO:
type: object
GenericTotalEstimator:
type: object
ISearchAuthenticationService:
type: object
IPeriodicTaskScheduler:
type: object
IReltioBusinessModelExternalInfoProvider:
type: object
IObjectChangesProcessorInteractionTO:
type: object
LifeCycleActionAzureFunctionClient:
type: object
properties:
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
azureFunctionAuthenticator:
$ref: '#/components/schemas/AzureFunctionAuthenticator'
configuration:
$ref: '#/components/schemas/Configuration'
httpClientCache:
$ref: '#/components/schemas/CacheIntegerApacheV5HttpClient'
httpClientName:
type: string
encryptionEngine:
$ref: '#/components/schemas/IEncryptionEngine'
IEntitiesDAO:
type: object
EncryptedAuthData:
type: object
properties:
awsAuth:
$ref: '#/components/schemas/AwsAuth'
cassandraAuth:
$ref: '#/components/schemas/CassandraAuth'
gcpAuth:
$ref: '#/components/schemas/GcpAuth'
Runnable:
type: object
IObjectChangesProcessorObjectTO:
type: object
RelationAnalyticsAttributesDAO:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
AttributeVerificationMappingConfig:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
verificationFunction:
type: string
description: Name of the verification function used for verifying attributes
resultingValuesSourceTypeUri:
type: string
description: >-
Specify the source type URI for writing response attributes. If
omitted, the input's source type will be used.
params:
type: object
additionalProperties:
type: object
description: Additional parameters required for the verification function
inputMapping:
type: array
description: List of input attribute mappings used for verification
items:
$ref: '#/components/schemas/AttributeVerificationMapping'
outputMapping:
type: array
description: List of output attribute mappings after verification
items:
$ref: '#/components/schemas/AttributeVerificationMapping'
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: Configuration of attribute verification mapping for Entity Types
OutputStreamWriter:
type: object
properties:
writeBuffer:
type: array
items:
type: string
lock:
type: object
se:
$ref: '#/components/schemas/StreamEncoder'
FunctionTenantIdMappingMetadataWrapper:
type: object
DeserializerCache:
type: object
properties:
_cachedDeserializers:
$ref: '#/components/schemas/LRUMapJavaTypeJsonDeserializerObject'
_incompleteDeserializers:
type: object
additionalProperties:
$ref: '#/components/schemas/JsonDeserializerObject'
ISegmentSearch:
type: object
Writer:
type: object
properties:
writeBuffer:
type: array
items:
type: string
lock:
type: object
WelfordSampleVarianceCalculator:
type: object
properties:
totalNumbers:
type: integer
format: int32
previousM:
type: number
format: double
lastM:
type: number
format: double
previousS:
type: number
format: double
lastS:
type: number
format: double
ObjectSizeLimitsConfig:
type: object
properties:
maxAttributeValues:
type: integer
format: int32
maxAttributeValueSize:
type: integer
format: int32
maxCrosswalks:
type: integer
format: int32
maxSubNestedAttributesPerEntity:
type: integer
format: int32
maxSubReferenceAttributesPerEntity:
type: integer
format: int32
maxReferenceCrosswalksPerEntity:
type: integer
format: int32
DefaultSerializerProvider:
type: object
properties:
_config:
$ref: '#/components/schemas/SerializationConfig'
_serializerFactory:
$ref: '#/components/schemas/SerializerFactory'
_serializerCache:
$ref: '#/components/schemas/SerializerCache'
_unknownTypeSerializer:
$ref: '#/components/schemas/JsonSerializerObject'
_keySerializer:
$ref: '#/components/schemas/JsonSerializerObject'
_nullValueSerializer:
$ref: '#/components/schemas/JsonSerializerObject'
_nullKeySerializer:
$ref: '#/components/schemas/JsonSerializerObject'
_knownSerializers:
$ref: '#/components/schemas/ReadOnlyClassToSerializerMap'
_dateFormat:
$ref: '#/components/schemas/DateFormat'
_stdNullValueSerializer:
type: boolean
PredicateTenantId:
type: object
Match IQ Configuration:
type: object
properties:
jobClusterType:
type: string
description: cluster type to use for tenant ml jobs
enum:
- dataproc
- databricks
storageProvider:
type: string
description: cloud storage provider to use for tenant ml jobs
dataStorageId:
type: string
description: DataStorage Id to use for this tenant
matchJobsLimit:
type: integer
description: >-
Number of match flow jobs that can be created. 'matchJobLimitType'
will determine if the limit is DAILY or CONSOLIDATED
format: int32
example: 10
mlAttributeComparatorsEnabled:
type: boolean
description: Enables using ML-based attribute-level comparators
activeModels:
type: integer
description: Number of active models under this tenant
format: int32
example: 10
modelsLimit:
type: integer
description: Number of models that can be created under this tenant
format: int32
example: 10
activeMatchJobs:
type: integer
description: >-
Number of active match flow jobs under this tenant. Type is
determined by 'matchJobLimitType'
format: int32
example: 10
vectorCandidateLookupsEnabled:
type: boolean
description: Enable candidate lookup from vector sources.
attributesLimit:
type: integer
description: >-
Number of attributes that can be selected while creating a model
flow
format: int32
example: 10
enabled:
type: boolean
description: >-
If disabled, all the controls will be disabled. Used by UI to
disable the UI
tenantId:
type: string
matchJobLimitType:
type: string
enum:
- DAILY
- CONSOLIDATED
featureToggles:
$ref: '#/components/schemas/Feature Toggles'
defaultSamplingConfig:
$ref: '#/components/schemas/Feature Generation Sampling Configuration'
fileStorageId:
type: string
llmComparator:
$ref: '#/components/schemas/LLM Comparator Configuration'
description: Match IQ configuration details
ApplicationContext:
type: object
TenantDataAccessDaoBuilderHelper:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
cachingMapService:
$ref: '#/components/schemas/ICachingMapService'
counterAccess:
$ref: '#/components/schemas/IOperationCounterAccess'
lockIgnoreTenantHandler:
$ref: '#/components/schemas/ILockIgnoreTenantHandler'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
lockerAccess:
$ref: '#/components/schemas/ILockerAccess'
matchLockerAccess:
$ref: '#/components/schemas/ILockerAccess'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
commitLogService:
$ref: '#/components/schemas/CommitLogService'
metricsCollectorFactory:
$ref: '#/components/schemas/ICassandraMetricsCollectorFactory'
dynamoDBMetricsCollectorFactory:
$ref: '#/components/schemas/IDynamoDBMetricsCollectorFactory'
spannerDBMetricsCollectorFactory:
$ref: '#/components/schemas/ISpannerMetricsCollectorFactory'
cosmosMetricsCollectorFactory:
$ref: '#/components/schemas/ICosmosMetricsCollectorFactory'
bigTableMetricsCollectorFactory:
$ref: '#/components/schemas/IBigTableMetricsCollectorFactory'
dynamoDBExternalCrosswalksLogServiceFactory:
$ref: '#/components/schemas/IDynamoDBExternalCrosswalksLogServiceFactory'
FastSerializationUtilsV3:
type: object
properties:
metadataService:
$ref: '#/components/schemas/IMetadataService'
categoriesServiceInterface:
$ref: '#/components/schemas/CategoriesServiceInterface'
freeSerializers:
type: array
items:
$ref: '#/components/schemas/Kryo'
IncrementalMatchConfiguration:
type: object
properties:
batchLimit:
type: integer
format: int32
dynamicBatchSizeEnabled:
type: boolean
skipOffCycleConsistencyUpdate:
type: boolean
useHardLocking:
type: boolean
maxGroupsSizeLimit:
type: integer
format: int32
enableTraceLogs:
type: boolean
skipEntitiesMatchesChangedEvents:
type: boolean
matchingTraceEnabled:
type: boolean
maxEventAttempts:
type: integer
format: int32
eventFailuresRatioThreshold:
type: integer
format: int32
embeddingsDependentMatchesFilterEnabled:
type: boolean
publishUpdateEventsOnRelatedEntities:
type: boolean
TenantInspections:
type: object
properties:
configuration:
$ref: '#/components/schemas/MatchingStatisticsStorageConfiguration'
inspections:
type: object
additionalProperties:
$ref: '#/components/schemas/SuboptimalRulesInspection'
ReadWriteLock:
type: object
OAuthInstanceService:
type: object
properties:
dao:
$ref: '#/components/schemas/IOAuthInstancesDAO'
listeners:
type: array
items:
$ref: '#/components/schemas/IOAuthInstanceListener'
lastUpdates:
type: object
additionalProperties:
$ref: '#/components/schemas/OAuthInstance'
mapper:
$ref: '#/components/schemas/ObjectMapper'
locker:
$ref: '#/components/schemas/ILockerString'
instances:
type: array
items:
$ref: '#/components/schemas/OAuthInstance'
instancesUUID:
type: string
format: uuid
sync:
type: object
TemplateDateFormatFactory:
type: object
IEntitySegmentationDAO:
type: object
KeyElementReferenceModule:
type: object
properties:
referent:
$ref: '#/components/schemas/Module'
queue:
$ref: '#/components/schemas/ReferenceQueueObject'
next:
$ref: '#/components/schemas/Reference'
cacheKey:
$ref: '#/components/schemas/CacheKey'
IActivityV2DAO:
type: object
ResourceBundleProvider:
type: object
ThreadContainer:
type: object
properties:
owner:
$ref: '#/components/schemas/Thread'
previous:
$ref: '#/components/schemas/StackableScope'
MatchTokensConfiguration:
type: object
properties:
tokensPerRuleLimit:
type: integer
format: int32
tokensPerOperandLimit:
type: integer
format: int32
CategoriesTreeService:
type: object
properties:
searchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
searchService:
$ref: '#/components/schemas/StorageSearch'
metadataService:
$ref: '#/components/schemas/MetadataService'
ICassandraMetricsCollectorFactory:
type: object
EntityAttributeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
CacheCacheKeyObjectFilterMatcher:
type: object
ILockerAccess:
type: object
ApiTaskSummaryService:
type: object
properties:
commonInfoRowConverter:
$ref: '#/components/schemas/ApiTaskCommonInfoRowConverter'
configuration:
$ref: '#/components/schemas/Configuration'
environmentName:
type: string
customerNameResolver:
$ref: '#/components/schemas/CustomerNameResolver'
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
monitoringBigQueryClientFactory:
$ref: '#/components/schemas/MonitoringBigQueryClientFactory'
executor:
$ref: '#/components/schemas/ThreadPoolExecutor'
enabled:
type: boolean
IteratorProviderResourceBundleProvider:
type: object
CPLimitsService:
type: object
properties:
cachedCPCounts:
type: object
additionalProperties:
$ref: '#/components/schemas/CachedCPCount'
hazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
environment:
type: string
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
entityFacetsService:
$ref: '#/components/schemas/EntityFacetsService'
metadataService:
$ref: '#/components/schemas/MetadataService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
globalCpLimit:
type: integer
format: int64
cpLimitReachedMapName:
type: string
creditLockTimeout:
type: integer
format: int32
ContinuationScope:
type: object
properties:
name:
type: string
LongAdder:
type: object
MatchRuleApplicabilityMetrics:
type: object
properties:
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
PlatformMetricsProviderService:
type: object
properties:
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
metricsProviderConfigurator:
$ref: '#/components/schemas/IMetricsProviderConfigurator'
enabled:
type: boolean
ICommitLogDAO:
type: object
MatchGroupsProvider:
type: object
FilterEqualsCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'equals' criteria
ObjectSearchRequestFactory:
type: object
properties:
commaPattern:
$ref: '#/components/schemas/Pattern'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
metadataService:
$ref: '#/components/schemas/MetadataService'
activityItemsTypeFilterModifier:
$ref: '#/components/schemas/ActivityItemsTypeFilterModifier'
relationshipTypeFilterModifier:
$ref: '#/components/schemas/RelationshipTypeFilterModifier'
entityTypeFilterModifier:
$ref: '#/components/schemas/EntityTypeFilterModifier'
interactionTypeFilterModifier:
$ref: '#/components/schemas/InteractionTypeFilterModifier'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
ovSecurityFilterFactoryProvider:
$ref: '#/components/schemas/OvSecurityFilterFactoryProvider'
ovFilterFactoryProvider:
$ref: '#/components/schemas/OvFilterFactoryProvider'
attributesLabelPatternCache:
$ref: '#/components/schemas/AttributesLabelPatternCache'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
storageSearch:
$ref: '#/components/schemas/StorageSearch'
joiner:
$ref: '#/components/schemas/Joiner'
entityAttributeFilterModifier:
$ref: '#/components/schemas/EntityAttributeFilterModifier'
relationAttributeFilterModifier:
$ref: '#/components/schemas/RelationAttributeFilterModifier'
defaultAppendEqualsAnalyzedForContainsWordStartingWith:
type: boolean
filterComplexityChecker:
$ref: '#/components/schemas/FilterComplexityChecker'
ExportQuotaConfig:
type: object
properties:
numberOfExports:
type: integer
format: int64
numberOfReadObjects:
type: integer
format: int64
InternalMatchCRUDConfiguration:
type: object
properties:
matchEventsEconomyConfiguration:
$ref: '#/components/schemas/MatchEventsEconomyConfiguration'
checkOvercollisionsOnWrite:
type: boolean
useHardLocking:
type: boolean
sendMatchTokens:
type: boolean
sendMatchTokensByRMT:
type: boolean
sendMatchDocument:
type: boolean
matchTokensConfiguration:
$ref: '#/components/schemas/MatchTokensConfiguration'
PermissionConfigCacheIPermissions:
type: object
properties:
timestampsCache:
$ref: '#/components/schemas/LoadingCacheTenantIdLong'
valuesCache:
type: object
additionalProperties:
$ref: '#/components/schemas/CacheRecordOptionCacheEntryIPermissions'
configStorage:
$ref: '#/components/schemas/IPermissionConfigStorage'
configApplier:
$ref: '#/components/schemas/IPermissionConfigApplyerIPermissions'
InteractionsService:
type: object
properties:
dao:
$ref: '#/components/schemas/InteractionsDAO'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
objectChangesProcessor:
$ref: '#/components/schemas/IObjectChangesProcessorInteractionTO'
postponedChangesThreadLocal:
$ref: '#/components/schemas/ThreadLocalPostponedChangesInteractionTO'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
searchService:
$ref: '#/components/schemas/StorageSearch'
customerDAOService:
$ref: '#/components/schemas/CustomerDAOService'
ObjectWrapper:
type: object
CassandraExecutor:
type: object
FieldHolder:
type: object
properties:
group:
$ref: '#/components/schemas/ThreadGroup'
task:
$ref: '#/components/schemas/Runnable'
stackSize:
type: integer
format: int64
priority:
type: integer
format: int32
daemon:
type: boolean
threadStatus:
type: integer
format: int32
TenantRestOperationsCacheConfig:
type: object
properties:
enabledHandlerMappings:
type: array
items:
$ref: '#/components/schemas/TenantHandlerMappingCacheConfig'
SimpleLockerString:
type: object
properties:
cachedLockPerId:
type: object
additionalProperties:
$ref: '#/components/schemas/ReentrantLock'
CRUDService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
groupService:
$ref: '#/components/schemas/GroupService'
interactionsService:
$ref: '#/components/schemas/InteractionsService'
graphService:
$ref: '#/components/schemas/GraphService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
configuration:
$ref: '#/components/schemas/Configuration'
metadataService:
$ref: '#/components/schemas/MetadataService'
permissionService:
$ref: '#/components/schemas/PermissionsService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
overwriteObjectService:
$ref: '#/components/schemas/IOverwriteObjectService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishService'
createOrUpdateObjectService:
$ref: '#/components/schemas/ICreateOrUpdateObjectService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationService'
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
mergeSplitService:
$ref: '#/components/schemas/IMergeSplitService'
allowOverrideCreatedTime:
type: boolean
allowConcurrentDeletion:
type: boolean
executorService:
$ref: '#/components/schemas/ExecutorService'
historyService:
$ref: '#/components/schemas/HistoryService'
mergeSplitServiceProvider:
$ref: '#/components/schemas/MergeSplitServiceProvider'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
KryoCustomizerProvider:
type: object
MatchGroupDigest:
type: object
properties:
marshaller:
$ref: '#/components/schemas/IMarshaller'
IIdGeneratorDAO:
type: object
MergeSplitService:
type: object
properties:
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
mergeTreeService:
$ref: '#/components/schemas/MergeTreeService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
mergeEntitiesService:
$ref: '#/components/schemas/MergeEntitiesService'
mergeRelationsService:
$ref: '#/components/schemas/MergeRelationsService'
splitService:
$ref: '#/components/schemas/SplitService'
crudService:
$ref: '#/components/schemas/CRUDService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
TrackableHazelcastInstance:
type: object
properties:
instance:
$ref: '#/components/schemas/HazelcastInstance'
tracker:
$ref: '#/components/schemas/ResourceTracker'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
CandidatesCollectorFactoryMatchGroupSpecification:
type: object
properties:
matchStorage:
$ref: '#/components/schemas/MatchStorage'
candidateSupplierManager:
$ref: '#/components/schemas/CandidateSupplierManager'
CacheStringString:
type: object
OutputDecorator:
type: object
LocalizedStringTO:
type: object
properties:
code:
type: string
values:
type: array
items:
$ref: '#/components/schemas/LocalizedValueTO'
localization:
type: object
additionalProperties:
type: string
SchemaProvider:
type: object
ConfigServiceProvider:
type: object
Kryo:
type: object
properties:
defaultSerializer:
$ref: '#/components/schemas/SerializerFactory'
defaultSerializers:
type: array
items:
$ref: '#/components/schemas/DefaultSerializerEntry'
lowPriorityDefaultSerializerCount:
type: integer
format: int32
classResolver:
$ref: '#/components/schemas/ClassResolver'
nextRegisterID:
type: integer
format: int32
classLoader:
$ref: '#/components/schemas/ClassLoader'
strategy:
$ref: '#/components/schemas/InstantiatorStrategy'
registrationRequired:
type: boolean
warnUnregisteredClasses:
type: boolean
depth:
type: integer
format: int32
maxDepth:
type: integer
format: int32
autoReset:
type: boolean
thread:
$ref: '#/components/schemas/Thread'
context:
$ref: '#/components/schemas/ObjectMap'
graphContext:
$ref: '#/components/schemas/ObjectMap'
referenceResolver:
$ref: '#/components/schemas/ReferenceResolver'
readReferenceIds:
$ref: '#/components/schemas/IntArray'
references:
type: boolean
copyReferences:
type: boolean
readObject:
type: object
copyDepth:
type: integer
format: int32
copyShallow:
type: boolean
originalToCopy:
$ref: '#/components/schemas/IdentityMap'
needsCopyReference:
type: object
generics:
$ref: '#/components/schemas/Generics'
NumberFormat:
type: object
properties:
groupingUsed:
type: boolean
maxIntegerDigits:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
minIntegerDigits:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
maxFractionDigits:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
minFractionDigits:
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
type: string
format: byte
parseIntegerOnly:
type: boolean
maximumIntegerDigits:
type: integer
format: int32
minimumIntegerDigits:
type: integer
format: int32
maximumFractionDigits:
type: integer
format: int32
minimumFractionDigits:
type: integer
format: int32
serialVersionOnStream:
type: integer
format: int32
IDynamoDBConfigurationProvider:
type: object
MatchingMigrationConfiguration:
type: object
properties:
tableNameMapping:
type: object
additionalProperties:
type: string
AnnotationIntrospector:
type: object
OAuthStateStoreService:
type: object
properties:
cachingMapService:
$ref: '#/components/schemas/ICachingMapService'
ConsistencyService:
type: object
properties:
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
versionService:
$ref: '#/components/schemas/VersionService'
mergeSplitService:
$ref: '#/components/schemas/MergeSplitService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
historyService:
$ref: '#/components/schemas/HistoryService'
internalMatchService:
$ref: '#/components/schemas/InternalMatchService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
marshaller:
$ref: '#/components/schemas/IMarshaller'
tenantSkippedEventPublishMonitoringService:
$ref: '#/components/schemas/TenantSkippedEventPublishMonitoringService'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
mergeTreeRecordParser:
$ref: '#/components/schemas/MergeTreeRecordParser'
createEventKey:
$ref: '#/components/schemas/FunctionReltioEventBaseObjectEventKey'
DynamoDBEncryptionKeyConfig:
type: object
properties:
region:
type: string
kmsCustomerKeyArn:
type: string
IReltioBusinessModelLocalizer:
type: object
IMarshaller:
type: object
ExportConfig:
type: object
properties:
paths:
type: array
items:
type: string
exportVersion:
type: string
enum:
- V1
- V1_5
- V2
fileCompression:
type: string
enum:
- NONE
- ZIP
- GZIP
storageType:
type: string
enum:
- S3
- GCS
- AZURE
- SNOWFLAKE
- LOCAL
- IN_MEMORY
- NONE
hiddenTasks:
$ref: '#/components/schemas/HiddenTasks'
analyticsClusterSizeFactor:
type: number
format: double
smartExport:
$ref: '#/components/schemas/SmartExportConfig'
writeManifest:
type: boolean
appendExtension:
type: boolean
skipPostprocessing:
type: boolean
batchSize:
type: integer
format: int32
alBatchSize:
type: integer
format: int32
parallelism:
type: integer
format: int32
populatorParallelism:
type: integer
format: int32
batchQueueSize:
type: integer
format: int32
quotaConfig:
$ref: '#/components/schemas/ExportQuotaConfig'
throttlingEnabled:
type: boolean
throttleThreshold:
type: number
format: double
unthrottleThreshold:
type: number
format: double
activeThrottling:
type: boolean
alDataMergeParticipantUseUriAsColumnName:
type: boolean
sparkS3Protocol:
type: string
enum:
- S3N
- S3A
emulateSparkOutput:
type: boolean
singleTaskFacade:
type: boolean
maxTaskPartsCount:
type: integer
format: int32
output:
$ref: '#/components/schemas/OutputConfig'
outputAsJsonArray:
type: boolean
partSize:
type: string
fileFormat:
type: string
enum:
- CSV
- JSON
dateFormat:
type: string
enum:
- TIMESTAMP
- READABLE
ICategoriesDAO:
type: object
CommitLogService:
type: object
properties:
hazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
environment:
type: string
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
statisticsAccess:
$ref: '#/components/schemas/IPlatformsStatisticsAccess'
rotationNumberCache:
type: object
additionalProperties:
type: integer
format: int32
listeners:
type: object
additionalProperties:
type: array
items:
type: string
format: uuid
semaphores:
$ref: '#/components/schemas/ISuspendableSemaphore'
HttpClientFactory:
type: object
ReltioMessagingEventsHubFactory:
type: object
Log:
type: object
TemplateNameFormat:
type: object
ReferenceResolver:
type: object
AccessChecker:
type: object
properties:
permissionsService:
$ref: '#/components/schemas/PermissionsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
OperationStatsService:
type: object
properties:
storage:
$ref: '#/components/schemas/OperationStatsStorage'
MatchDocumentsConverter:
type: object
ThreadLocalMap:
type: object
properties:
table:
type: array
items:
$ref: '#/components/schemas/Entry'
size:
type: integer
format: int32
threshold:
type: integer
format: int32
AuroraDBConfigMapping:
type: object
properties:
cluster:
type: string
awsRegion:
type: string
awsIAMRole:
type: string
secret:
type: string
host:
type: string
port:
type: integer
format: int32
hikariConfig:
type: object
additionalProperties:
type: integer
format: int32
database:
type: string
TenantGraphConfiguration:
type: object
properties:
enabled:
type: boolean
provider:
type: string
enum:
- neptune
- inmemory_tinkergraph
- inmemory_janusgraph
modelType:
type: string
enum:
- SINGLE_ATTRIBUTES
- MULTI_FLAT_ATTRIBUTES
- MULTI_NESTED_ATTRIBUTES
attributesCase:
type: string
enum:
- Original
- Upper
host:
type: string
port:
type: integer
format: int32
batchSize:
type: integer
format: int32
debug:
type: boolean
configAlias:
type: string
syncRequestTimeLimit:
type: integer
format: int32
totalLimit:
type: integer
format: int64
neptuneConfig:
$ref: '#/components/schemas/NeptuneGraphConfiguration'
EventProcessorStatusProvider:
type: object
Module:
type: object
PeriodicTaskFactoryProvider:
type: object
properties:
periodicTaskFactoryMap:
type: object
additionalProperties:
$ref: '#/components/schemas/IPeriodicTaskFactory'
CommonDynamoDBConfig:
type: object
properties:
globalTablesConfig:
$ref: '#/components/schemas/DynamoDBGlobalTablesConfig'
ICreditsService:
type: object
CassandraConcurrentExecutor:
type: object
properties:
lastTimeThreadPoolOverflow:
type: integer
format: int64
threadPoolOverflowLocker:
type: object
executor:
$ref: '#/components/schemas/CassandraExecutor'
apm:
$ref: '#/components/schemas/CassandraApmTracing'
SurvivorshipGroup:
required:
- isDefault
- mappingsList
- default
- mapping
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a survivorship group configuration
element
example: configuration/entityTypes/Individual/survivorshipGroups/default
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
sourcesUriOrder:
type: array
description: >-
Ordered list of sources. Used in SRC_SYS strategy as default list
for all SurvivorshipGroupMappings in current group
example: >-
['configuration/sources/ReltioCleanser', 'configuration/sources/FB',
'configuration/sources/Twitter']
items:
type: string
sourcesForOv:
uniqueItems: true
type: array
description: >-
Default list of sources which may be OV. The sources which aren't
included in this list will be ignored.Can be overridden in
survivorship group mapping for particular attribute
example: '[''configuration/sources/Reltio'', ''configuration/sources/FB'''
items:
type: string
roles:
type: array
description: >-
List of user roles for which this survivorshipGroup is applied to.
The list of roles can be specified to non default survivorshipGroup
only
example: '[''ROLE1'', ''ROLE2'']'
items:
type: string
default:
type: boolean
description: >-
Defines if the survivorshipGroup is flagged as default for
particular object type or not
example: true
mapping:
type: array
description: List of SurvivorshipGroupMapping
items:
$ref: '#/components/schemas/SurvivorshipGroupMapping'
description: >-
A survivorship group consolidates a set of survivorship
mapping.survivorshipGroup could be added to every type in the
configuration. Each survivorship group has mapping of attribute URIs to
survivorship strategies. One group for type could be set as default from
the API.An object type can have multiple survivorship groups: one of
them must be marked as default. A default group is used in most cases.
Other, non-default groups are applied for users with specific roles only
(roles are also defined in a group settings).
IMatchDAOsProvider:
type: object
JsonFactory:
type: object
properties:
_factoryFeatures:
type: integer
format: int32
_parserFeatures:
type: integer
format: int32
_generatorFeatures:
type: integer
format: int32
_objectCodec:
$ref: '#/components/schemas/ObjectCodec'
_characterEscapes:
$ref: '#/components/schemas/CharacterEscapes'
_inputDecorator:
$ref: '#/components/schemas/InputDecorator'
_outputDecorator:
$ref: '#/components/schemas/OutputDecorator'
_rootValueSeparator:
$ref: '#/components/schemas/SerializableString'
_maximumNonEscapedChar:
type: integer
format: int32
_quoteChar:
type: string
LoadingCacheCredentialsCacheKeyAWSCredentialsProvider:
type: object
ISpannerMetricsAdminCollectorFactory:
type: object
BufferedWriter:
type: object
properties:
writeBuffer:
type: array
items:
type: string
lock:
type: object
out:
$ref: '#/components/schemas/Writer'
cb:
type: array
items:
type: string
nChars:
type: integer
format: int32
nextChar:
type: integer
format: int32
maxChars:
type: integer
format: int32
IMergeSplitService:
type: object
MetadataModificationService:
type: object
properties:
metadataModificationManager:
$ref: '#/components/schemas/MetadataModificationManager'
ThreadGroup:
type: object
properties:
parent:
$ref: '#/components/schemas/ThreadGroup'
name:
type: string
maxPriority:
type: integer
format: int32
daemon:
type: boolean
ngroups:
type: integer
format: int32
groups:
type: array
items:
$ref: '#/components/schemas/ThreadGroup'
nweaks:
type: integer
format: int32
weaks:
type: array
items:
$ref: '#/components/schemas/WeakReferenceThreadGroup'
StorageStat:
type: object
properties:
columnsRead:
$ref: '#/components/schemas/AtomicLong'
columnsWritten:
$ref: '#/components/schemas/AtomicLong'
bytesRead:
$ref: '#/components/schemas/AtomicLong'
bytesWritten:
$ref: '#/components/schemas/AtomicLong'
rcu:
$ref: '#/components/schemas/AtomicDouble'
wcu:
$ref: '#/components/schemas/AtomicDouble'
IOperationStateProvider:
type: object
ExceptionLogHandler:
type: object
CategoriesDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
uriCategoriesCache:
type: object
additionalProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/ObjectTO'
crosswalkCategoriesCache:
type: object
additionalProperties:
type: object
additionalProperties:
$ref: '#/components/schemas/ObjectTO'
rootCategoriesCache:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/ObjectTO'
lastUpdateTimestampMap:
type: object
additionalProperties:
type: integer
format: int64
categoriesCacheTimestampsCache:
$ref: '#/components/schemas/LoadingCacheTenantIdLong'
masking:
type: object
properties:
regexPattern:
type: string
description: >-
Regular expression pattern to match substring of the value to be
masked
example: .*
maskMatched:
type: boolean
description: >-
Mask matched drives which part of value to mask: if true (default)
then matched substring is masked, if false then matched substring is
not masked, but the rest of the value is masked
example: false
description: >-
Attribute masking is configuration how whether attribute values should
be masked and which parts of value are masked
SplitService:
type: object
properties:
splitter:
$ref: '#/components/schemas/Splitter'
allContributorsSplitter:
$ref: '#/components/schemas/AllContributorsSplitter'
phantomSplitter:
$ref: '#/components/schemas/PhantomSplitter'
Cleanser:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
monitoringLog:
$ref: '#/components/schemas/Logger'
warningsLog:
$ref: '#/components/schemas/Logger'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
amazonS3ClientFactory:
$ref: '#/components/schemas/AmazonS3ClientFactory'
logJsonField:
$ref: '#/components/schemas/MessageFormat'
overwriteObjectService:
$ref: '#/components/schemas/OverwriteObjectService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
envLevelCleanseChainResolveLookup:
type: boolean
configuration:
$ref: '#/components/schemas/Configuration'
doAttrDeepCloneInCleanse:
type: boolean
marshaller:
$ref: '#/components/schemas/IMarshaller'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
idUtils:
$ref: '#/components/schemas/IDUtils'
KryoCustomizerProviderV3:
type: object
AutoGenerationService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
idGeneratorService:
$ref: '#/components/schemas/IdGeneratorService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
metadataService:
$ref: '#/components/schemas/MetadataService'
environmentName:
type: string
LoggerRepository:
type: object
IValidationAzureHubClientProvider:
type: object
Type:
type: object
PlatformLookupsDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
commonDataAccess:
$ref: '#/components/schemas/CommonDataAccess'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
dbLookupsDao:
$ref: '#/components/schemas/ISafeDaoHolderIDBLookupsDAO'
lookupCache:
$ref: '#/components/schemas/ILookupCache'
lookupsVersionUpdater:
$ref: '#/components/schemas/LookupsVersionUpdater'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
WeakReferenceCharsetDecoder:
type: object
properties:
referent:
$ref: '#/components/schemas/CharsetDecoder'
queue:
$ref: '#/components/schemas/ReferenceQueueObject'
next:
$ref: '#/components/schemas/Reference'
ITenantsStorage:
type: object
Principal:
type: object
ProtectionDomain:
type: object
properties:
codesource:
$ref: '#/components/schemas/CodeSource'
classloader:
$ref: '#/components/schemas/ClassLoader'
principals:
type: array
items:
$ref: '#/components/schemas/Principal'
permissions:
$ref: '#/components/schemas/PermissionCollection'
hasAllPerm:
type: boolean
staticPermissions:
type: boolean
key:
$ref: '#/components/schemas/Key'
ReltioAPIPlatform:
type: object
properties:
syslogLoggingService:
$ref: '#/components/schemas/SyslogLoggingService'
syncObject:
type: object
enableRDM:
type: boolean
enableRDMBasedCleanse:
type: boolean
enableHistory:
type: boolean
userRoleAccess:
$ref: '#/components/schemas/UserRoleAccess'
systemDataAccess:
$ref: '#/components/schemas/SystemDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
tenantFilteringService:
$ref: '#/components/schemas/TenantFilteringService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
interactionsService:
$ref: '#/components/schemas/InteractionsService'
customerDAOService:
$ref: '#/components/schemas/CustomerDAOService'
zeroCopyMetadataService:
$ref: '#/components/schemas/ZeroCopyMetadataService'
relationsService:
$ref: '#/components/schemas/RelationsService'
graphService:
$ref: '#/components/schemas/GraphService'
groupService:
$ref: '#/components/schemas/GroupService'
segmentService:
$ref: '#/components/schemas/SegmentService'
segmentSearchService:
$ref: '#/components/schemas/ISegmentSearch'
storageVectorService:
$ref: '#/components/schemas/IStorageVectorService'
embeddingsAPIClient:
$ref: '#/components/schemas/IEmbeddingsAPIClient'
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
metadataPermissionFilterService:
$ref: '#/components/schemas/MetadataPermissionFilterService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
materializedViewService:
$ref: '#/components/schemas/MaterializedViewService'
businessProcessDataService:
$ref: '#/components/schemas/BusinessProcessDataService'
historyService:
$ref: '#/components/schemas/HistoryService'
metadataModificationService:
$ref: '#/components/schemas/MetadataModificationService'
metricsProviderService:
$ref: '#/components/schemas/PlatformMetricsProviderService'
indexingErrorsMonitoringService:
$ref: '#/components/schemas/IndexingErrorsMonitoringService'
esClusterStatsFetcher:
$ref: '#/components/schemas/ESClusterStatsFetcher'
esIndexController:
$ref: '#/components/schemas/ESIndexController'
userPreferencesService:
$ref: '#/components/schemas/UserPreferencesService'
predicateQueryService:
$ref: '#/components/schemas/PredicateQueryService'
groupingService:
$ref: '#/components/schemas/IGroupingService'
entitySegmentationService:
$ref: '#/components/schemas/EntitySegmentationService'
schemalessInteractionService:
$ref: '#/components/schemas/SchemalessInteractionService'
interactionMemberResolverService:
$ref: '#/components/schemas/InteractionMemberResolverService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
searchService:
$ref: '#/components/schemas/StorageSearch'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
categoriesTreeService:
$ref: '#/components/schemas/CategoriesTreeService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
serializationUtils:
$ref: '#/components/schemas/FastSerializationUtils'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
readOnlyMatchingService:
$ref: '#/components/schemas/ReadOnlyMatchingService'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
suboptimalRulesDetectionService:
$ref: '#/components/schemas/SuboptimalRulesDetectionService'
suboptimalRulesActionStorage:
$ref: '#/components/schemas/SuboptimalRulesActionStorage'
suboptimalRulesActionService:
$ref: '#/components/schemas/SuboptimalRulesActionService'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/AtomicReferencePredefinedMatchGroupsSupplier'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
relationAnalyticsAttributesService:
$ref: '#/components/schemas/RelationAnalyticsAttributesService'
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
throttlingHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
metricsHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
migrationHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
matchHazelcastService:
$ref: '#/components/schemas/HazelcastService'
matchLockerAccess:
$ref: '#/components/schemas/ILockerAccess'
changeRequestService:
$ref: '#/components/schemas/ChangeRequestService'
objectsModificationService:
$ref: '#/components/schemas/ObjectsModificationService'
localizationService:
$ref: '#/components/schemas/LocalizationService'
lifecycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
platformRemoteTokenService:
$ref: '#/components/schemas/IPlatformRemoteTokenService'
rdmService:
$ref: '#/components/schemas/RDMService'
oAuthInstanceService:
$ref: '#/components/schemas/OAuthInstanceService'
interactionMappingService:
$ref: '#/components/schemas/InteractionMappingService'
interactionMappingServiceLock:
$ref: '#/components/schemas/Lock'
customerDatabaseConfigService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
customerDatabaseConfigServiceLock:
$ref: '#/components/schemas/Lock'
oAuthStateStoreService:
$ref: '#/components/schemas/OAuthStateStoreService'
oAuthStateStoreServiceLock:
$ref: '#/components/schemas/Lock'
snowflakeOAuthService:
$ref: '#/components/schemas/SnowflakeOAuthService'
snowflakeOAuthServiceLock:
$ref: '#/components/schemas/Lock'
idGeneratorService:
$ref: '#/components/schemas/IdGeneratorService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationService'
mailService:
$ref: '#/components/schemas/MailService'
operationStatsService:
$ref: '#/components/schemas/OperationStatsService'
creditsService:
$ref: '#/components/schemas/ICreditsService'
cpLimitsService:
$ref: '#/components/schemas/CPLimitsService'
kryoCustomizerProvider:
$ref: '#/components/schemas/KryoCustomizerProvider'
kryoCustomizerProviderV3:
$ref: '#/components/schemas/KryoCustomizerProviderV3'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
analyticsAttributesDAO:
$ref: '#/components/schemas/EntityAnalyticsAttributesDAO'
relationAnalyticsAttributesDAO:
$ref: '#/components/schemas/RelationAnalyticsAttributesDAO'
relationsDAO:
$ref: '#/components/schemas/RelationsDAO'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
shutdownHazelcast:
type: boolean
tokenProviderFactory:
$ref: '#/components/schemas/ITokenProviderFactory'
maxRequestBodySize:
type: integer
format: int64
maxObjectsPerPost:
type: integer
format: int32
externalMatchLimitDefault:
type: integer
format: int32
isShutdown:
type: boolean
isShutdownRequested:
type: boolean
commonDataAccess:
$ref: '#/components/schemas/CommonDataAccess'
backpressureHandler:
$ref: '#/components/schemas/IESBackpressureHandler'
esSearchLatencyTracker:
$ref: '#/components/schemas/ESSearchLatencyTracker'
validationAzureHubClientProvider:
$ref: '#/components/schemas/IValidationAzureHubClientProvider'
cleanseEncryptionEngine:
$ref: '#/components/schemas/IEncryptionEngine'
checkConnection:
type: boolean
platformType:
type: string
enum:
- OTHER
- API
- EXPORT
- VALIDATION
- DTSS
- IRS
- ANALYTICS
- ACTIVITY_LOG_V2
- MLMATCH
- READ_ONLY
shutdownFunctions:
type: array
items:
$ref: '#/components/schemas/Runnable'
healthCheckQuickExecutor:
$ref: '#/components/schemas/ThreadPoolExecutor'
configuration:
$ref: '#/components/schemas/Configuration'
mergeSplitServiceProvider:
$ref: '#/components/schemas/MergeSplitServiceProvider'
crudServiceProvider:
$ref: '#/components/schemas/CRUDServiceProvider'
lockIgnoreTenantHandler:
$ref: '#/components/schemas/ILockIgnoreTenantHandler'
metricsServiceFactory:
$ref: '#/components/schemas/MetricsServiceFactory'
metricsProviderConfigurator:
$ref: '#/components/schemas/IMetricsProviderConfigurator'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
gbtHistoryConfigurationProvider:
$ref: '#/components/schemas/IBigTableConfigurationProvider'
supportedConfigurationTypes:
uniqueItems: true
type: array
items:
type: string
enum:
- PLATFORM
- ACTIVITY_LOG
dynamoDBConfigurationProvider:
$ref: '#/components/schemas/IDynamoDBConfigurationProvider'
auroraDBConfigurationProvider:
$ref: '#/components/schemas/AuroraDBConfigurationProvider'
recentObjectChanges:
$ref: '#/components/schemas/IRecentObjectChanges'
metricsCollectorFactory:
$ref: '#/components/schemas/ICassandraMetricsCollectorFactory'
testMode:
type: boolean
bigQueryClientFactory:
$ref: '#/components/schemas/IBigQueryClientFactory'
notificationService:
$ref: '#/components/schemas/NotificationService'
lockerAccess:
$ref: '#/components/schemas/HazelcastLockerAccess'
candidateSupplierManager:
$ref: '#/components/schemas/CandidateSupplierManager'
credentialsProviderResolver:
$ref: '#/components/schemas/CredentialsProviderResolver'
entitySearchService:
$ref: '#/components/schemas/EntitySearchService'
entityFacetsService:
$ref: '#/components/schemas/EntityFacetsService'
customerDatabaseService:
$ref: '#/components/schemas/CustomerDatabaseService'
customerDatabaseServiceLock:
$ref: '#/components/schemas/Lock'
zeroCopyMetadataServiceLock:
$ref: '#/components/schemas/Lock'
segmentServiceLock:
$ref: '#/components/schemas/Lock'
eventProcessorsConfiguration:
$ref: '#/components/schemas/EventProcessorsConfiguration'
running:
type: boolean
lcaRestClientService:
$ref: '#/components/schemas/LifeCycleRestClientFactory'
amazonS3ClientFactory:
$ref: '#/components/schemas/AmazonS3ClientFactory'
awsLambdaClientFactory:
$ref: '#/components/schemas/AWSLambdaClientFactory'
messagingProvider:
$ref: '#/components/schemas/MessagingProviderHelper'
applicationContext:
$ref: '#/components/schemas/ApplicationContext'
googleCloudStorageClientFactory:
$ref: '#/components/schemas/GoogleCloudStorageClientFactory'
migrationEnableCallbacks:
type: array
items:
$ref: '#/components/schemas/Runnable'
firstHealthcheckPassed:
type: boolean
AWSSecretsManager:
type: object
SuboptimalRulesDetectionService:
type: object
properties:
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
matchingStatisticsStorage:
$ref: '#/components/schemas/ConfigurationAwareMatchingStatisticsStorage'
suboptimalRulesActionService:
$ref: '#/components/schemas/SuboptimalRulesActionService'
suboptimalRulesActionStorage:
$ref: '#/components/schemas/SuboptimalRulesActionStorage'
allTenantInspections:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantInspections'
scheduledExecutorService:
$ref: '#/components/schemas/ScheduledExecutorService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
inspectionPeriod:
type: integer
format: int64
resendNotificationsPeriod:
type: integer
format: int64
shutdown:
type: boolean
JMXBeanWrapper:
type: object
MatchAssetConverter:
type: object
TenantDataAccess:
type: object
properties:
isShutDown:
$ref: '#/components/schemas/AtomicBoolean'
syncObject:
type: object
dataExecutors:
type: object
additionalProperties:
$ref: '#/components/schemas/CassandraExecutor'
historyInfoExecutors:
type: object
additionalProperties:
$ref: '#/components/schemas/CassandraConcurrentExecutor'
historyDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IHistoryDAO'
historyMigrationDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IHistoryDAO'
entitiesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IEntitiesDAO'
relationsDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IRelationsDAO'
categoriesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/ICategoriesDAO'
graphsDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IGraphsDAO'
groupsDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IGroupsDAO'
userPreferencesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IUserPreferencesDAO'
analyticAttributesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IAnalyticAttributesDAOIEntityURI'
relationAnalyticAttributesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IAnalyticAttributesDAOIRelationURI'
workflowDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IWorkflowDAO'
initializerIdGenerator:
$ref: '#/components/schemas/TenantInitializerIdGenerator'
tenantIdToInitializers:
$ref: >-
#/components/schemas/TableTenantIdTenantInitializerIdTenantInitializer
activityDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IActivityDAO'
activityV2DAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IActivityV2DAO'
interactionsDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IInteractionsDAO'
matchStorageDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IMatchStorageDAO'
backgroundMatchStorageDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IMatchStorageDAO'
commonAssetsDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/ICommonAssetsDAO'
commitLogDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/ICommitLogDAO'
predicateQueryDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IPredicateQueryDAO'
groupingDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IGroupingDAO'
entitySegmentationDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IEntitySegmentationDAO'
segmentDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/ISegmentDAO'
hierarchyKeyspaceDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IHierarchyKeyspaceDAOs'
entitiesMetadataDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IEntitiesMetadataDAO'
potentialMatchesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IPotentialMatchesDAO'
backgroundPotentialMatchesDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/IPotentialMatchesDAO'
tenantConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantConfiguration'
tenantsDataListeners:
type: array
items:
$ref: '#/components/schemas/TenantsDataListener'
matchProvider:
$ref: '#/components/schemas/IMatchDAOsProvider'
healthCheckExecutor:
$ref: '#/components/schemas/ThreadPoolExecutor'
healthCheckQuickExecutor:
$ref: '#/components/schemas/ThreadPoolExecutor'
systemDataAccess:
$ref: '#/components/schemas/SystemDataAccess'
commonDataAccess:
$ref: '#/components/schemas/CommonDataAccess'
lockerAccess:
$ref: '#/components/schemas/ILockerAccess'
idsStorage:
$ref: '#/components/schemas/IIdsStorage'
dataKeyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
matchKeyFactory:
$ref: '#/components/schemas/CassandraKeyFactory'
loadTenantExecutor:
$ref: '#/components/schemas/ThreadPoolExecutor'
allTenantsInPlatform:
type: array
items:
$ref: '#/components/schemas/TenantId'
tenantsRunningInThisPlatform:
type: array
items:
$ref: '#/components/schemas/TenantId'
allFilteredTenants:
type: array
items:
$ref: '#/components/schemas/TenantId'
failedToStart:
type: object
additionalProperties:
$ref: '#/components/schemas/PairLongString'
lockIgnoreTenantHandler:
$ref: '#/components/schemas/ILockIgnoreTenantHandler'
initialLoad:
$ref: '#/components/schemas/AtomicBoolean'
initialLoadTenantSet:
uniqueItems: true
type: array
items:
type: string
tenantsStorage:
$ref: '#/components/schemas/TenantsStorage'
lookupsDAO:
$ref: '#/components/schemas/ILookupsDAO'
platformLookupsDAO:
$ref: '#/components/schemas/PlatformLookupsDAO'
localizationDAO:
$ref: '#/components/schemas/ILocalizationDAO'
statisticsStorage:
$ref: '#/components/schemas/StatisticsStorage'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
spannerDBMetricsAdminCollectorFactory:
$ref: '#/components/schemas/ISpannerMetricsAdminCollectorFactory'
tenantDataAccessParametersProvider:
$ref: '#/components/schemas/ITenantDataAccessParametersProvider'
lastUpdateTime:
type: integer
format: int64
syslogLoggingService:
$ref: '#/components/schemas/SyslogLoggingService'
tenantFilteringService:
$ref: '#/components/schemas/AbstractTenantFilteringService'
cleanseDictionaryServiceFactoryProvider:
$ref: '#/components/schemas/ICleanseDictionaryServiceFactoryProvider'
testMode:
type: boolean
gbtHistoryConfigurationProvider:
$ref: '#/components/schemas/IBigTableConfigurationProvider'
supportedConfigurationTypes:
uniqueItems: true
type: array
items:
type: string
enum:
- PLATFORM
- ACTIVITY_LOG
historyEnabled:
type: boolean
premiumMode:
type: boolean
dynamoDBConfigurationProvider:
$ref: '#/components/schemas/IDynamoDBConfigurationProvider'
auroraDBConfigurationProvider:
$ref: '#/components/schemas/AuroraDBConfigurationProvider'
cassandraDefaultPropertyProvider:
$ref: '#/components/schemas/ICassandraDefaultPropertyProvider'
commitLogService:
$ref: '#/components/schemas/CommitLogService'
tenantStartupRetries:
type: integer
format: int32
tenantsCountToStartup:
type: integer
format: int32
baseAwsRoleArn:
type: string
almsMigrationConfig:
$ref: '#/components/schemas/Configuration'
slowlyInitializedTenants:
uniqueItems: true
type: array
items:
type: string
credentialsProviderResolver:
$ref: '#/components/schemas/CredentialsProviderResolver'
daoBuilderHelper:
$ref: '#/components/schemas/TenantDataAccessDaoBuilderHelper'
MutableStorageStat:
type: object
properties:
columnsRead:
$ref: '#/components/schemas/AtomicLong'
columnsWritten:
$ref: '#/components/schemas/AtomicLong'
bytesRead:
$ref: '#/components/schemas/AtomicLong'
bytesWritten:
$ref: '#/components/schemas/AtomicLong'
rcu:
$ref: '#/components/schemas/AtomicDouble'
wcu:
$ref: '#/components/schemas/AtomicDouble'
FunctionCheckedFileOutputStream:
type: object
SerializableString:
type: object
FilterLessCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'less' criteria
InteractionSecretsManagerService:
type: object
properties:
secretsManagerService:
$ref: '#/components/schemas/SecretsManagerService'
DataPipelineTypeConfig:
type: object
properties:
enabled:
type: boolean
description: >-
Specifies whether the Data Pipeline Hub should proceed with the
current type. By default, false
example: true
attributes:
uniqueItems: true
type: array
description: >-
Specifies the list of attributes uris for Data Pipeline Hub export.
If not specified, then all available attributes will be exported.If
specified, then only specified attributes will be exported.
example: >-
[ "configuration/entityTypes/Individual/attributes/FirstName",
"configuration/entityTypes/Individual/attributes/LastName"]
items:
type: string
description: Configuration of Data Pipeline filtering for Entity/Relation Types
VisibilityCheckerObject:
type: object
FunctionTenantIdIEntitiesMetadataDAO:
type: object
UnclassifiedInteractionType:
required:
- attributes
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify an interaction type configuration
element
example: configuration/interactionTypes/Unclassified
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for which
object should be considered as active. Inactiveness for object means
that it won't appear in any search results by default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}'
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type. One
group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on the
defined expression
items:
$ref: '#/components/schemas/ruleBasedAttributes'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
groupKeyAttributeUris:
type: array
description: >-
List of URIs for attributes that can be used as group key for this
interaction type. These attributes are used to group interactions of
this type together. For example, if the group key is
'configuration/interactionTypes/Booking/attributes/BookingId', then
all interactions of this type will be grouped by the value of the
BookingId attribute of the Booking interaction type
example: '[''configuration/interactionTypes/Booking/attributes/BookingId'']'
items:
type: string
memberTypes:
type: array
description: >-
A collection of possible member types. Examples can be: Participant,
Organizer
items:
$ref: '#/components/schemas/InteractionMemberType'
ignoreUniqueness:
type: boolean
description: >-
If true, Data Access API (part of the Analytics Spark SDK)
and Compaction (application of Analytics Jobs REST API) will not
perform uniqueness resolution (de-duplication) for interactions of
this type. If false (default), regular uniqueness resolution
is performed
example: true
hasMembers:
type: boolean
description: >-
Specifies whether the interaction type has members (true, default)
or is "memberless" (false). If an interaction type is marked as
"memberless", then Data Access API (part of the Analytics Spark SDK)
and Data Import (application of Analytics Jobs REST API) will skip
the step of joining interactions with members.
To avoid
validation errors, keep in mind that:- If true, members
must be provided in the mapping and/or data file
- If
false, members must not be provided in the mapping and/or
data file
example: true
description: >-
Interactions are lightweight objects that represent any kind of
interaction or transaction.
As a broad term, interaction stands for
an event that occurs at a particular moment such as a retail purchase,
or a measurement. It can also represent a fact in a period of time such
as a sales figure for the month of June
IActivityDAO:
type: object
ThreadLocalMapClassObjectMapper:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
MatchInfoProvider:
type: object
properties:
potentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
matchScoreCalculator:
$ref: '#/components/schemas/MatchGroupsScoreCalculator'
compiledMatchGroupsCache:
$ref: '#/components/schemas/CompiledMatchGroupsCache'
platform:
$ref: '#/components/schemas/ReltioPlatform'
CassandraApmTracing:
type: object
properties:
apmTablesBlacklist:
uniqueItems: true
type: array
items:
type: string
dbName:
type: string
databaseInstance:
type: string
dbHost:
type: string
dbPort:
type: string
ICassandraDataKeyFactory:
type: object
WaitingForQueueChecker:
type: object
properties:
crudEventHubService:
$ref: '#/components/schemas/CRUDEventHubService'
matchEventHubService:
$ref: '#/components/schemas/MatchEventHubService'
queueWaitingThreshold:
type: integer
format: int32
AuroraDBConfigurationProvider:
type: object
properties:
environmentName:
type: string
auroraAccessAllowed:
type: boolean
JsonSerializerObject:
type: object
SnowflakeOAuthService:
type: object
properties:
configService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
secretsManager:
$ref: '#/components/schemas/InteractionSecretsManagerService'
stateStore:
$ref: '#/components/schemas/OAuthStateStoreService'
oauthCallbackUrl:
type: string
environmentName:
type: string
AttributeVerificationMapping:
required:
- attribute
- verificationAttribute
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attribute:
type: string
description: Specifies the URI of an attribute in the entity
example: >-
configuration/entityTypes/Individual/attributes/Email/attributes/Email
verificationAttribute:
type: string
description: >-
Specifies the name of the attribute's which verification client uses
to make request to verification API.
example: Email
mandatory:
type: boolean
description: >-
Specifies whether the value is required for the cleanse
function.
- If the entity has no such value, then the
entity is not passed to the cleanse function. This may be
omitted.
- The default value is false
example: true
IOAuthInstancesDAO:
type: object
PropertyNamingStrategy:
type: object
UnmergeEntitiesSplitter:
type: object
properties:
detailOperationLogger:
$ref: '#/components/schemas/Logger'
logger:
$ref: '#/components/schemas/Logger'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
mergeTreeService:
$ref: '#/components/schemas/MergeTreeService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
crudService:
$ref: '#/components/schemas/CRUDService'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationServiceObjectObject'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
useCassandraTransactions:
type: boolean
mergeTreeRecordParser:
$ref: '#/components/schemas/MergeTreeRecordParser'
marshaller:
$ref: '#/components/schemas/IMarshaller'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
ThreadLocalPostponedChangesInteractionTO:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
CleanseInfoElement:
required:
- mapping
type: object
properties:
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
cleanseFunction:
type: string
description: Indicates the name of the cleanse function.
example: PhoneCleanserFn
resultingValuesSourceTypeUri:
type: string
description: >-
Specifies the source type of a crosswalk for cleansed values. If not
specified, then the dataProvider=true crosswalk is used for
the cleansed values.If specified, then values that belong to the
crosswalk of this type are not used as input data for a cleanse
function
example: configuration/sources/ReltioCleanser
proceedOnSuccess:
type: boolean
description: >-
Specifies whether the cleansing should proceed with the next element
in the chain, if the current cleansing was successful. By default,
true
example: true
proceedOnFailure:
type: boolean
description: >-
Specifies whether the cleansing should proceed with the next element
in the chain, if the current cleansing was not successful. By
default, true
example: true
mapping:
$ref: '#/components/schemas/CleanseAttributeMappings'
params:
type: object
additionalProperties:
type: object
description: Key-value parameters mapping which is specific for cleanse function
removeOldCleanseResultsOnFailure:
type: boolean
description: >-
If set to true, in case of failure cleanse result old cleansed data
will be removed
example: true
filter:
type: string
description: >-
Filter expression to evaluate before constructing cleanse inputs. If
the filter does not match, cleanse inputs will not be created. The
filter is evaluated using ObjectFilterMatcher with AttributesTO
context.
example: in('attributes.Country', 'US,IN')
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: Cleanse info that describes the way how to proceed the cleanse function
TenantEncryptionConfiguration:
type: object
properties:
awsEncryptionConfig:
$ref: '#/components/schemas/AwsEncryptionConfig'
MatcherMatchGroupSpecification:
type: object
properties:
matchStorage:
$ref: '#/components/schemas/MatchStorage'
commonAssetsStorage:
$ref: '#/components/schemas/CommonAssetsStorage'
tokenFactory:
$ref: '#/components/schemas/MatchTokenFactory'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
matchingStatisticsStorage:
$ref: '#/components/schemas/MatchingStatisticsStorage'
ignoreMatchMethodApplicability:
type: boolean
candidatesCollectorFactory:
$ref: >-
#/components/schemas/CandidatesCollectorFactoryMatchGroupSpecification
compactingExceptionLogger:
$ref: '#/components/schemas/CompactingExceptionLogger'
MatchServiceAccess:
type: object
properties:
cache:
type: object
additionalProperties:
$ref: '#/components/schemas/IMatchService'
destroyStarted:
type: boolean
applicationContext:
$ref: '#/components/schemas/ApplicationContext'
ICleanseService:
type: object
TypeParser:
type: object
properties:
_factory:
$ref: '#/components/schemas/TypeFactory'
CosmosDBConfig:
type: object
properties:
databaseId:
type: string
databaseThroughputConfig:
$ref: '#/components/schemas/CosmosThroughputConfig'
containerConfigs:
type: array
items:
$ref: '#/components/schemas/CosmosContainerConfig'
warmupThroughputMultiplier:
type: integer
format: int32
contentResponseOnWriteEnabled:
type: boolean
shardCount:
type: integer
format: int32
oneHopWriteStrategy:
type: string
Formatter:
type: object
properties:
a:
$ref: '#/components/schemas/Appendable'
l:
$ref: '#/components/schemas/Locale'
lastException:
$ref: '#/components/schemas/IOException'
IAnalyticAttributesDAOIEntityURI:
type: object
ISpannerMetricsCollectorFactory:
type: object
SingleValueByCrosswalkSources:
type: object
properties:
include:
type: array
description: >-
Specifies the exact sources for which the singleValueByCrosswalk
rule will be applied. Other sources will be ignored
example: configuration/sources/Source1, configuration/sources/Source2
items:
type: string
exclude:
type: array
description: >-
Specifies the exact sources for which the singleValueByCrosswalk
rule will be ignored. For other sources it will be applied
example: configuration/sources/Source3, configuration/sources/Source4
items:
type: string
description: >-
If the singleValueByCrosswalk property is true, you can additionally
specify for which sources to use or ignore the singleValueByCrosswalk
rule.
Attributes:- include-array of Sources: specifies the
exact sources for which the singleValueByCrosswalk rule will be applied.
Other sources will be ignored.
- exclude-array of Sources:
specifies the exact sources for which the singleValueByCrosswalk rule
will be ignored. For other sources it will be applied.
Both
parameters are optional and can be used separately or in combination
IHierarchyKeyspaceDAOs:
type: object
ReferenceObject:
type: object
properties:
referent:
type: object
next:
$ref: '#/components/schemas/Reference'
SupplierIMergeSplitService:
type: object
ObjectMap:
type: object
properties:
size:
type: integer
format: int32
keyTable:
type: array
items:
type: object
valueTable:
type: array
items:
type: object
capacity:
type: integer
format: int32
stashSize:
type: integer
format: int32
loadFactor:
type: number
format: float
hashShift:
type: integer
format: int32
mask:
type: integer
format: int32
threshold:
type: integer
format: int32
stashCapacity:
type: integer
format: int32
pushIterations:
type: integer
format: int32
bigTable:
type: boolean
IPermissionConfigApplyerIPermissions:
type: object
InstantiatorStrategy:
type: object
Splitter:
type: object
properties:
detailOperationLogger:
$ref: '#/components/schemas/Logger'
logger:
$ref: '#/components/schemas/Logger'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
mergeTreeService:
$ref: '#/components/schemas/MergeTreeService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
crudService:
$ref: '#/components/schemas/CRUDService'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationServiceObjectObject'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
useCassandraTransactions:
type: boolean
mergeTreeRecordParser:
$ref: '#/components/schemas/MergeTreeRecordParser'
marshaller:
$ref: '#/components/schemas/IMarshaller'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
IAzureQueuesAutoScalingService:
type: object
RelationsHistoryDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
tenantsDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
SystemDataAccess:
type: object
properties:
config:
$ref: '#/components/schemas/Configuration'
cassandraDefaultPropertyProvider:
$ref: '#/components/schemas/ICassandraDefaultPropertyProvider'
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
platformsAccess:
$ref: '#/components/schemas/IPlatformsAccess'
daos:
$ref: '#/components/schemas/ISystemDAOsFactory'
platformType:
type: string
enum:
- OTHER
- API
- EXPORT
- VALIDATION
- DTSS
- IRS
- ANALYTICS
- ACTIVITY_LOG_V2
- MLMATCH
- READ_ONLY
GroupsDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
GroupingConfig:
type: object
properties:
enabled:
type: boolean
messagingName:
type: string
version:
type: string
RequestGroupConfig:
type: object
properties:
virtualConfigName:
type: string
pattern:
type: string
regex:
type: object
properties:
pattern:
type: string
flags:
type: integer
format: int32
$ref: '#/components/schemas/Pattern'
maxRequestsPerCluster:
type: integer
format: int32
primary:
$ref: '#/components/schemas/ThrottlingStorageTypeGroupConfig'
matching:
$ref: '#/components/schemas/ThrottlingStorageTypeGroupConfig'
ICachingMapService:
type: object
IMetadataStorage:
type: object
DeserializationProblemHandler:
type: object
CleanseAttributeMapping:
required:
- attribute
- cleanseAttribute
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a cleanse attribute mapping
configuration element
example: configuration/entityTypes/Location/cleanse/mappings/address
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attribute:
type: string
description: Specifies the URI of an attribute in the entity
example: >-
configuration/entityTypes/Individual/attributes/Address/attributes/AddressInput
cleanseAttribute:
type: string
description: >-
Specifies the name of the attribute's value inside
CleanseInputs (the key of the Map)
If you
want to collect nested and sub-attributes together, then specify the
name of the nested attribute as a prefix in the
cleanseAttribute parameter, separated by a dot
example: Address
mandatory:
type: boolean
description: >-
Specifies whether the value is required for the cleanse
function.
- If the entity has no such value, then the
entity is not passed to the cleanse function. This may be
omitted.
- The default value is false
example: true
allValues:
type: boolean
description: >-
Specifies whether all values of the attributes are passed to the
cleanse function or just a single (OV) value.
- If
allValues is equal to true, then the value of the
Map is of type List. This may be
omitted.
- The default value is false
example: true
cleanseLookupInputStrategy:
type: string
description: Strategy for resolving lookup values in cleanse input
example: LOOKUP_CODE
enum:
- LOOKUP_CODE
- LOOKUP_VALUE
- RAW_VALUE
description: Define mapping between Cleanse Function attributes and Entity attributes
IDynamoDBExternalCrosswalksLogServiceFactory:
type: object
PermissionsService:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
configManager:
$ref: '#/components/schemas/PermissionConfigManagerIPermissions'
userRoleAccess:
$ref: '#/components/schemas/UserRoleAccess'
TenantMonitoringConfiguration:
type: object
properties:
cassandraOperations:
type: boolean
periodicTasks:
type: boolean
exportTasks:
type: boolean
activityAnomalies:
type: boolean
matchAnomalies:
type: boolean
dataAnomalies:
type: boolean
eventQueue:
type: boolean
esOperations:
type: boolean
requests:
type: boolean
changedObjectsEnabled:
type: boolean
eventMonitoring:
$ref: '#/components/schemas/EventMonitoringConfiguration'
TenantStringsTO:
type: object
properties:
tenantId:
$ref: '#/components/schemas/TenantId'
version:
type: string
strings:
type: object
additionalProperties:
$ref: '#/components/schemas/LocalizedStringTO'
timestamp:
type: integer
format: int64
CRUDEventHubService:
type: object
properties:
platform:
$ref: '#/components/schemas/ReltioAPIPlatform'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
configuration:
$ref: '#/components/schemas/Configuration'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
lifecycleProcessor:
$ref: '#/components/schemas/ReltioLifecycleProcessor'
processorStatusProvider:
$ref: '#/components/schemas/EventProcessorStatusProvider'
eventsHubFactory:
$ref: '#/components/schemas/ReltioMessagingEventsHubFactory'
tenantConfigurations:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantConfiguration'
eventsHub:
$ref: '#/components/schemas/EventHubCRUDServiceEvent'
running:
type: boolean
currentCollectorBatch:
type: integer
format: int32
threadCount:
type: integer
format: int32
immediateHubStatisticsStorage:
$ref: '#/components/schemas/ImmediateHubStatisticsStorage'
sequentialEmptyCountThreshold:
type: integer
format: int64
sequentialEmptyTimerThreshold:
type: integer
format: int64
lockLeaseTime:
type: integer
format: int64
legacyResourcesCleanupDelay:
type: integer
format: int64
listener:
$ref: '#/components/schemas/ResourceLifecycleListener'
crudService:
$ref: '#/components/schemas/CRUDService'
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
CommonWorkflowDataConverter:
type: object
properties:
businessProcessToCassandraConverter:
$ref: '#/components/schemas/CommonBusinessProcessToCassandraConverter'
changeRequestToCassandraConverter:
$ref: '#/components/schemas/CommonChangeRequestToCassandraConverter'
DynamoDBConfigMapping:
type: object
properties:
endpoint:
type: string
awsRegion:
type: string
awsIAMExternalRole:
type: string
awsBackupIAMRole:
type: string
accountId:
type: string
tableSuffix:
type: string
defaultTableProperties:
$ref: '#/components/schemas/DynamoDBProperties'
daoVersion:
type: string
pointInTimeRecovery:
type: boolean
environmentName:
type: string
ttl:
type: string
baseAwsRoleArn:
type: string
IPermissionsProvider:
type: object
DefaultSerializerEntry:
type: object
properties:
serializerFactory:
$ref: '#/components/schemas/SerializerFactory'
SearchResultFetcher:
type: object
properties:
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
activityLogService:
$ref: '#/components/schemas/IActivityLogService'
TenantMatchGroupsCache:
type: object
properties:
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
matchGroupsFilter:
$ref: '#/components/schemas/IFilterMatchGroup'
cache:
$ref: >-
#/components/schemas/LoadingCacheTenantIdMapEntityTypeURIEntityTypeMatchGroups
IPeriodicTaskService:
type: object
RelationsDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
relationAnalyticsAttributesDAO:
$ref: '#/components/schemas/RelationAnalyticsAttributesDAO'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
metadataService:
$ref: '#/components/schemas/MetadataService'
StatisticsStorage:
type: object
MatchEventsEconomyConfiguration:
type: object
properties:
triggerOnChangedDocumentsOnly:
type: boolean
CassandraExecutorWorkflowDataConverter:
type: object
properties:
cassandraWriter:
$ref: '#/components/schemas/CassandraWriter'
CRUDServiceProvider:
type: object
properties:
crudServiceAtomicReference:
$ref: '#/components/schemas/AtomicReferenceICRUDService'
MatchStorage:
type: object
SupplierIteratorMapStringObject:
type: object
CredentialsProviderFactory:
type: object
properties:
baseCredentialsProvider:
$ref: '#/components/schemas/ReltioAWSCredentialsProvider'
MetadataModificationManager:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
matchGroupDigest:
$ref: '#/components/schemas/FunctionMatchGroupString'
TemplateLookupStrategy:
type: object
ThreadLocalPostponedChangesEntityTO:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
SimpleAttributeValueTOSerializer:
type: object
RDMService:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
lookupsDAO:
$ref: '#/components/schemas/ILookupsDAO'
clientsPool:
$ref: '#/components/schemas/ClientsPool'
tenantDAOs:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantLookupsAccess'
rdmPublishErrorsEnabled:
type: boolean
transcodeTimeoutInMs:
type: integer
format: int64
BusinessObjectsService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
materializedViewService:
$ref: '#/components/schemas/MaterializedViewService'
businessProcessDataService:
$ref: '#/components/schemas/BusinessProcessDataService'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
mergeSplitServiceProvider:
$ref: '#/components/schemas/SupplierIMergeSplitService'
metricsCollector:
$ref: '#/components/schemas/IBusinessObjectsServiceMetricCollector'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceObject'
metadataPermissionFilterService:
$ref: '#/components/schemas/MetadataPermissionFilterService'
ClientsPool:
type: object
properties:
pool:
type: object
additionalProperties:
$ref: '#/components/schemas/IRestRDMClient'
httpClientFactory:
$ref: '#/components/schemas/HttpClientFactory'
oAuthInstanceService:
$ref: '#/components/schemas/OAuthInstanceService'
settings:
$ref: '#/components/schemas/ClientsPoolSettings'
transcodingErrorsTrackerResolver:
$ref: '#/components/schemas/ITranscodingErrorsTrackerResolver'
targetSourceResolver:
$ref: '#/components/schemas/ITargetSourceResolver'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
circuitBreakerCallback:
$ref: '#/components/schemas/CircuitBreakerCallback'
userAccessTokenProvider:
$ref: '#/components/schemas/ITenantAuthorizationTokenProvider'
rdmUserRoleAccess:
$ref: '#/components/schemas/UserRoleAccess'
tokenProviderFactory:
$ref: '#/components/schemas/ITokenProviderFactory'
ConfigurableListableBeanFactory:
type: object
IIdsStorage:
type: object
TemplateClassResolver:
type: object
MergeSplitServiceProvider:
type: object
properties:
mergeSplitServiceAtomicReference:
$ref: '#/components/schemas/AtomicReferenceIMergeSplitService'
CleanseInfoSequence:
required:
- sequence
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a cleanse info sequence configuration
element
example: configuration/entityTypes/Location/cleanse/infos/default
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
useInCleansing:
type: boolean
description: >-
Specifies whether the cleanse info is automatically used to cleanse
the updated or created entity
example: true
sequence:
type: array
description: >-
Specifies a list of cleansing chains that are applied one by one
during the cleansing
items:
$ref: '#/components/schemas/CleanseInfoChain'
nestedAttributeToCleanse:
type: string
description: Nested attribute URI to be cleansed
example: configuration/entityTypes/Individual/attributes/Email
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: >-
Specification of the format in which the input and output mappings are
configured for data cleanse
MCPConfig:
type: object
properties:
enabled:
type: boolean
description: Enables/disables MCP for the tenant
example: true
description: MCP Configuration
LoadingCacheTenantIdMatchAttributesOfTenant:
type: object
CommonChangeRequestToCassandraConverter:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
Entry:
type: object
properties:
key:
type: object
value:
type: object
CosmosCredentialsConfig:
type: object
properties:
vaultUrl:
type: string
applicationId:
type: string
azureTenantId:
type: string
masterKeyId:
type: string
TemplateCache:
type: object
properties:
templateLoader:
$ref: '#/components/schemas/TemplateLoader'
storage:
$ref: '#/components/schemas/CacheStorage'
templateLookupStrategy:
$ref: '#/components/schemas/TemplateLookupStrategy'
templateNameFormat:
$ref: '#/components/schemas/TemplateNameFormat'
templateConfigurations:
$ref: '#/components/schemas/TemplateConfigurationFactory'
isStorageConcurrent:
type: boolean
updateDelay:
type: integer
format: int64
localizedLookup:
type: boolean
config:
$ref: '#/components/schemas/Configuration'
ClassResolver:
type: object
HistoryService:
type: object
properties:
commonHistoryDAO:
$ref: '#/components/schemas/CommonHistoryDAO'
entitiesHistoryDAO:
$ref: '#/components/schemas/EntitiesHistoryDAO'
relationsHistoryDAO:
$ref: '#/components/schemas/RelationsHistoryDAO'
configurationHistoryDAO:
$ref: '#/components/schemas/ConfigurationHistoryDAO'
l3ConfigurationHistoryDAO:
$ref: '#/components/schemas/L3ConfigurationHistoryDAO'
physicalTenantConfigurationHistoryDAO:
$ref: '#/components/schemas/PhysicalTenantConfigurationHistoryDAO'
StreamingService:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
tenantsService:
$ref: '#/components/schemas/TenantsConfigurationService'
providerHelper:
$ref: '#/components/schemas/MessagingProviderHelper'
marshaller:
$ref: '#/components/schemas/IMarshaller'
executor:
$ref: '#/components/schemas/ExecutorService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
environment:
type: string
enabled:
type: boolean
destPrefixesToCheckTags:
uniqueItems: true
type: array
items:
type: string
status:
type: string
enum:
- STARTED
- STOPPED
- NOT_ENABLED
running:
type: boolean
GroupService:
type: object
properties:
dao:
$ref: '#/components/schemas/GroupsDAO'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
objectChangesProcessor:
$ref: '#/components/schemas/IObjectChangesProcessorObjectTO'
postponedChangesThreadLocal:
$ref: '#/components/schemas/ThreadLocalPostponedChangesObjectTO'
groupsDAO:
$ref: '#/components/schemas/GroupsDAO'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
InjectableValues:
type: object
AtomicReferencePredefinedMatchGroupsSupplier:
type: object
properties:
value:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
SegmentDAO:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
ICassandraDefaultPropertyProvider:
type: object
ILookupCache:
type: object
InternalMatchService:
type: object
properties:
readOnlyMatchingService:
$ref: '#/components/schemas/ReadOnlyMatchingService'
explainMatchService:
$ref: '#/components/schemas/ExplainMatchService'
maxRetryAttempts:
type: integer
format: int32
retryInterval:
type: integer
format: int32
writableMatchingService:
$ref: '#/components/schemas/WritableMatchingService'
reltioAPIPlatform:
$ref: '#/components/schemas/ReltioAPIPlatform'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
compiledMatchGroupsCache:
$ref: '#/components/schemas/CompiledMatchGroupsCache'
hubService:
$ref: '#/components/schemas/CRUDEventHubService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
entityEmbeddingsProvider:
$ref: '#/components/schemas/EntityEmbeddingsProvider'
tenantMatchGroupsWithVectorLookupCache:
$ref: '#/components/schemas/TenantMatchGroupsCache'
applicabilityEvaluator:
$ref: '#/components/schemas/MatchRuleApplicabilityEvaluator'
initialized:
type: boolean
processor:
$ref: '#/components/schemas/InternalMatchCRUDServiceEventsProcessor'
ReadOnlyPotentialMatchesService:
type: object
properties:
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchGroupsConverter:
$ref: '#/components/schemas/MatchGroupsConverter'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
matchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
CosmosIndexingConfig:
type: object
properties:
indexingMode:
type: string
includedPaths:
type: array
items:
type: string
excludedPaths:
type: array
items:
type: string
isAutomatic:
type: boolean
TenantVectorConfiguration:
type: object
properties:
enableVectorIndexing:
type: boolean
description: >-
Whether the vector indexation should be enabled for this tenant
(default: true)
example: true
indexingBatchSize:
type: integer
description: 'Indexing Batch Size (default: 200)'
format: int32
example: 100
numShards:
type: integer
description: 'Shards are horizontal slices of a vector collection (default: 1)'
format: int32
example: 100
matchDocsFetchBatchSize:
type: integer
description: ' match docs from DB fetch batch size (default: 1000)'
format: int32
example: 1000
vectorIndexStrategy:
type: string
description: Vector index type to use
example: MEMORY_OPTIMIZED_DEFAULT
enum:
- HIGH_PERFORMANCE
- MEMORY_OPTIMIZED_DEFAULT
- MEMORY_OPTIMIZED_LARGE
- DISK_OPTIMIZED
embeddingConfiguration:
$ref: '#/components/schemas/EmbeddingConfiguration'
description: Vector configuration object model
DynamoDBGlobalTablesConfig:
type: object
properties:
replicaMap:
type: object
additionalProperties:
$ref: '#/components/schemas/DynamoDBReplicaConfig'
activeReplica:
type: string
IRelationsDAO:
type: object
FunctionTenantIdIEntitySegmentationDAO:
type: object
LRUMapJavaTypeJsonDeserializerObject:
type: object
HazelcastCounterFactory:
type: object
properties:
COUNTERS_CAPTION:
type: string
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
TenantAdminController:
type: object
properties:
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
hubService:
$ref: '#/components/schemas/CRUDEventHubService'
matchHubService:
$ref: '#/components/schemas/MatchEventHubService'
searchService:
$ref: '#/components/schemas/SearchService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
crudService:
$ref: '#/components/schemas/CRUDService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
platform:
$ref: '#/components/schemas/ReltioAPIPlatform'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
periodicTaskService:
$ref: '#/components/schemas/IPeriodicTaskService'
httpServletRequest:
$ref: '#/components/schemas/HttpServletRequest'
reltioPermissionManager:
$ref: '#/components/schemas/ReltioPermissionManager'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
currentUser:
$ref: '#/components/schemas/UserDetails'
streamingService:
$ref: '#/components/schemas/StreamingService'
crudHub:
$ref: '#/components/schemas/CRUDEventHubService'
matchHub:
$ref: '#/components/schemas/MatchEventHubService'
azureQueuesAutoScalingService:
$ref: '#/components/schemas/IAzureQueuesAutoScalingService'
configuration:
$ref: '#/components/schemas/Configuration'
esSnapshotService:
$ref: '#/components/schemas/IEsSnapshotService'
segmentationConfigurationService:
$ref: '#/components/schemas/SegmentationConfigurationService'
segmentationCommonService:
$ref: '#/components/schemas/SegmentationCommonService'
Version:
required:
- name
type: object
properties:
versionId:
type: string
description: The id of the created version.
example: 0ABlgGQ
name:
type: string
description: The name of the version.
example: Version 1
status:
type: string
description: The status of the version.
example: ACTIVE
effectiveStartDate:
type: string
description: Start effective date of the version.
format: date
example: 2025-01-01T00:00:00.000+0000
effectiveEndDate:
type: string
description: End effective date of the version.
format: date
example: 2025-12-31T00:00:00.000+0000
description:
type: string
description: Text description of the version.
example: This version is a draft.
context:
type: string
description: An additional description field for providing context.
example: This is a part of wider activity for next year hierarchies.
description: Describes a hierarchy version.
DynamoDBCapacityMode:
type: object
properties:
type:
type: string
enum:
- AUTO_SCALING
- PROVISIONED
- ON_DEMAND
minReadCapacity:
type: integer
format: int32
maxReadCapacity:
type: integer
format: int32
readTargetUtilization:
type: number
format: double
minWriteCapacity:
type: integer
format: int32
maxWriteCapacity:
type: integer
format: int32
writeTargetUtilization:
type: number
format: double
readCapacity:
type: integer
format: int64
writeCapacity:
type: integer
format: int64
manualScalingEnabled:
type: boolean
manualScalingStepPercent:
type: integer
format: int32
ObjectMapper:
type: object
properties:
_jsonFactory:
$ref: '#/components/schemas/JsonFactory'
_typeFactory:
$ref: '#/components/schemas/TypeFactory'
_injectableValues:
$ref: '#/components/schemas/InjectableValues'
_subtypeResolver:
$ref: '#/components/schemas/SubtypeResolver'
_configOverrides:
$ref: '#/components/schemas/ConfigOverrides'
_mixIns:
$ref: '#/components/schemas/SimpleMixInResolver'
_serializationConfig:
$ref: '#/components/schemas/SerializationConfig'
_serializerProvider:
$ref: '#/components/schemas/DefaultSerializerProvider'
_serializerFactory:
$ref: '#/components/schemas/SerializerFactory'
_deserializationConfig:
$ref: '#/components/schemas/DeserializationConfig'
_deserializationContext:
$ref: '#/components/schemas/DefaultDeserializationContext'
_registeredModuleTypes:
uniqueItems: true
type: array
items:
type: object
_rootDeserializers:
type: object
additionalProperties:
$ref: '#/components/schemas/JsonDeserializerObject'
ICRUDService:
type: object
LinkedNodeDeserializationProblemHandler:
type: object
properties:
value:
$ref: '#/components/schemas/DeserializationProblemHandler'
next:
$ref: '#/components/schemas/LinkedNodeDeserializationProblemHandler'
ScheduledExecutorService:
type: object
EntitiesMergeTreeDAO:
type: object
properties:
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
IOverwriteObjectService:
type: object
BusinessProcessDataService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessProcessDataDAO:
$ref: '#/components/schemas/BusinessProcessDataDAO'
AmazonS3ClientFactory:
type: object
properties:
defaultAwsCredentials:
$ref: '#/components/schemas/AWSCredentials'
defaultAwsRoleArn:
type: string
defaultRegion:
type: string
defaultUseSsl:
type: boolean
credentialsProviderResolver:
$ref: '#/components/schemas/CredentialsProviderResolver'
Duration:
type: object
properties:
length:
type: integer
format: int64
timeUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
SuboptimalRulesDetectionServiceConfiguration:
type: object
properties:
enabled:
type: boolean
sendEmailAlerts:
type: boolean
disableRuleWhenDetected:
type: boolean
runAnalysis:
type: boolean
inspections:
type: array
items:
$ref: '#/components/schemas/SuboptimalRulesInspectionConfiguration'
MergeEntitiesService:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
detailOperationLogger:
$ref: '#/components/schemas/Logger'
cleanseDictionaryServiceFactoryProvider:
$ref: '#/components/schemas/ICleanseDictionaryServiceFactoryProvider'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/PredefinedMatchGroupsSupplier'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
relationsService:
$ref: '#/components/schemas/RelationsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
crudService:
$ref: '#/components/schemas/CRUDService'
useCassandraTransactions:
type: boolean
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
mergeRelationsService:
$ref: '#/components/schemas/MergeRelationsService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
changeRequestService:
$ref: '#/components/schemas/ChangeRequestService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
mergeTreeOptimizationService:
$ref: '#/components/schemas/MergeTreeOptimizationService'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
UnmergeConfiguration:
type: object
properties:
unmergeMergeLoopDetectionEnabled:
type: boolean
unmergeMergeLoopDetectionWindow:
type: string
unmergeMergeLoopDetectionThreshold:
type: integer
format: int32
unmergeMergeLoopDetectionVerifyMatch:
type: boolean
unmergeHandlerForceReloadEntity:
type: boolean
cleanseBatchSize:
type: integer
format: int32
esUsageThreshold:
type: number
format: double
enableContributorsByDeltaOptimization:
type: boolean
CassandraWriter:
type: object
properties:
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsStorage:
$ref: '#/components/schemas/ITenantsStorage'
ITokenProviderFactory:
type: object
FilterNotInCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: List of the values to compare with
example: John,Bob,Joe
description: Defines 'not in' criteria
TenantHandlerMappingCacheConfig:
type: object
properties:
httpMethod:
type: string
handlerMapping:
type: string
DestinationActivity:
type: object
properties:
id:
type: string
activity:
type: object
additionalProperties:
$ref: '#/components/schemas/ActivityCount'
lastFiveErrors:
type: array
items:
$ref: '#/components/schemas/ErrorSummary'
Appendable:
type: object
AbstractPeriodicTask:
type: object
properties:
operationStats:
$ref: '#/components/schemas/OperationStats'
taskLogger:
$ref: '#/components/schemas/TaskLoggerWrapper'
periodicTaskTO:
$ref: '#/components/schemas/PeriodicTaskTO'
objectTypes:
type: array
items:
$ref: '#/components/schemas/AbstractTypeWithAttributesAbstractTypeURI'
tenantId:
$ref: '#/components/schemas/TenantId'
shutdown:
type: boolean
finishing:
type: boolean
finishedAndFlushed:
type: boolean
globalMaxThrottlingDelay:
type: integer
format: int64
globalThrottlingDelayStep:
type: integer
format: int64
taskMaxThrottlingDelay:
type: integer
format: int64
taskThrottlingDelayStep:
type: integer
format: int64
numberOfProcessedObjects:
$ref: '#/components/schemas/AtomicLong'
numberOfProcessedObjectsChanged:
$ref: '#/components/schemas/AtomicLong'
numberOfReadObjects:
$ref: '#/components/schemas/AtomicLong'
numberOfReadObjectsChanged:
$ref: '#/components/schemas/AtomicLong'
statsByRequestType:
type: object
additionalProperties:
$ref: '#/components/schemas/MutableStorageStat'
runnerThreadId:
type: integer
format: int64
forceCleansing:
type: boolean
executeLCA:
type: boolean
hasPublishErrors:
type: boolean
numberOfFailedToPublishEvents:
type: integer
format: int64
taskHidden:
type: boolean
NestedAttributeHandler:
type: object
properties:
idUtils:
$ref: '#/components/schemas/IDUtils'
Configurable:
type: object
properties:
parent:
$ref: '#/components/schemas/Configurable'
properties:
type: object
additionalProperties:
type: string
customAttributes:
type: object
additionalProperties:
type: object
locale:
$ref: '#/components/schemas/Locale'
numberFormat:
type: string
timeFormat:
type: string
dateFormat:
type: string
dateTimeFormat:
type: string
timeZone:
$ref: '#/components/schemas/TimeZone'
sqlDataAndTimeTimeZone:
$ref: '#/components/schemas/TimeZone'
sqlDataAndTimeTimeZoneSet:
type: boolean
booleanFormat:
type: string
trueStringValue:
type: string
falseStringValue:
type: string
classicCompatible:
type: integer
format: int32
templateExceptionHandler:
$ref: '#/components/schemas/TemplateExceptionHandler'
attemptExceptionReporter:
$ref: '#/components/schemas/AttemptExceptionReporter'
arithmeticEngine:
$ref: '#/components/schemas/ArithmeticEngine'
objectWrapper:
$ref: '#/components/schemas/ObjectWrapper'
outputEncoding:
type: string
outputEncodingSet:
type: boolean
urlEscapingCharset:
type: string
urlEscapingCharsetSet:
type: boolean
autoFlush:
type: boolean
showErrorTips:
type: boolean
newBuiltinClassResolver:
$ref: '#/components/schemas/TemplateClassResolver'
apiBuiltinEnabled:
type: boolean
truncateBuiltinAlgorithm:
$ref: '#/components/schemas/TruncateBuiltinAlgorithm'
logTemplateExceptions:
type: boolean
wrapUncheckedExceptions:
type: boolean
customDateFormats:
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateDateFormatFactory'
customNumberFormats:
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateNumberFormatFactory'
autoImports:
type: object
additionalProperties:
type: string
autoIncludes:
type: array
items:
type: string
lazyImports:
type: boolean
lazyAutoImports:
type: boolean
lazyAutoImportsSet:
type: boolean
IRecentObjectChanges:
type: object
AWSCredentials:
type: object
GoogleFunctionAuthenticator:
type: object
properties:
credentialsProvider:
$ref: '#/components/schemas/GoogleCredentialsProvider'
FilterProvider:
type: object
AWSCredentialsManager:
type: object
properties:
cache:
$ref: >-
#/components/schemas/LoadingCacheCredentialsCacheKeyAWSCredentialsProvider
IObjectChangesProcessorRelationTO:
type: object
PureHazelcastService:
type: object
properties:
clientStateMonitoringExecutor:
$ref: '#/components/schemas/ScheduledExecutorService'
clusterNamespace:
type: string
configuration:
$ref: '#/components/schemas/Configuration'
token:
type: string
hazelcastConfig:
$ref: '#/components/schemas/HazelcastConfig'
hazelcastInstance:
$ref: '#/components/schemas/TrackableHazelcastInstance'
backupHazelcastInstance:
$ref: '#/components/schemas/TrackableHazelcastInstance'
primaryHazelcastClientInitializedOnce:
type: boolean
backupHazelcastClientInitializedOnce:
type: boolean
shutdown:
type: boolean
shutdownLock:
$ref: '#/components/schemas/Lock'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
clientStateMetricProvider:
$ref: '#/components/schemas/ICommonMultipleMetricsProvider'
clientProvider:
$ref: '#/components/schemas/IHazelcastInstanceProviderClientConfig'
primaryHazelcastClientListeners:
type: array
items:
$ref: '#/components/schemas/LifecycleListener'
backupHazelcastClientListeners:
type: array
items:
$ref: '#/components/schemas/LifecycleListener'
primaryHazelcastInstanceState:
$ref: '#/components/schemas/HazelcastInstanceState'
backupHazelcastInstanceState:
$ref: '#/components/schemas/HazelcastInstanceState'
SyslogLoggingService:
type: object
properties:
LOG_LEVEL:
type: string
systemLoggers:
type: object
additionalProperties:
$ref: '#/components/schemas/Logger'
SuboptimalRulesActionGBQStorage:
type: object
properties:
bigQueryClient:
$ref: '#/components/schemas/IBigQueryClient'
actionsTable:
$ref: '#/components/schemas/TableId'
schemaProvider:
$ref: '#/components/schemas/SchemaProvider'
marshaller:
$ref: '#/components/schemas/IMarshaller'
hostNameHolder:
$ref: '#/components/schemas/IHostNameHolder'
StatisticDefinition:
type: object
properties:
enabled:
type: boolean
name:
type: string
type:
type: string
disableRule:
type: boolean
parameters:
type: object
additionalProperties:
type: object
IHostNameHolder:
type: object
EventQueueProcessorsParams:
type: object
properties:
defaultProcessorsParams:
$ref: '#/components/schemas/EventQueueProcessorGroupParams'
separateProcessorsParams:
type: object
additionalProperties:
$ref: '#/components/schemas/EventQueueProcessorGroupParams'
ICommonAssetsDAO:
type: object
RDMConfig:
type: object
properties:
serviceUri:
type: string
oauthInstance:
type: string
rdmTenants:
type: array
items:
$ref: '#/components/schemas/RDMTenant'
cached:
type: boolean
cache:
$ref: '#/components/schemas/RDMCache'
publishRDMErrors:
type: boolean
multiParentTranscoding:
type: boolean
includeDisabledLookups:
type: boolean
transcodeByEndDatedCrosswalks:
type: boolean
dcrHierarchyTranscoding:
type: boolean
enableUserSecuritySupport:
type: boolean
TenantConfigurationProvider:
type: object
SuboptimalRulesActionService:
type: object
RDMTenant:
type: object
properties:
rdmTenantId:
type: string
lookupTypes:
type: array
items:
type: string
EventQueueProcessorGroupParams:
type: object
properties:
disabled:
type: boolean
debug:
type: boolean
maxThreadsPerCluster:
type: integer
format: int32
eventsBatchSize:
type: integer
format: int32
maxThreadsPerNode:
type: integer
format: int32
maxAckTimeoutSec:
type: integer
format: int32
retryDelaySec:
type: integer
format: int32
maxRetries:
type: integer
format: int32
downscaleWhenThrottled:
type: boolean
defaultAckTimeoutSec:
type: integer
format: int32
PremiumSettings:
type: object
properties:
enabled:
type: boolean
maxThreadsCount:
type: integer
format: int32
usePremiumCluster:
type: boolean
HistoryTOFactoryReltioBusinessModelConfigurationHistorySnapshotTO:
type: object
InteractionTypeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
EntitySegmentationService:
type: object
properties:
entitySegmentationDAOProvider:
$ref: '#/components/schemas/FunctionTenantIdIEntitySegmentationDAO'
entitiesMetadataDAOProvider:
$ref: '#/components/schemas/FunctionTenantIdIEntitiesMetadataDAO'
metadataService:
$ref: '#/components/schemas/IMetadataService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
DynamoDBReplicaConfig:
type: object
properties:
region:
type: string
AtomicReferenceListTenantConfiguration:
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/TenantConfiguration'
ExecutorService:
type: object
TenantMatchingConfiguration:
type: object
properties:
strategy:
type: string
resolveLookupStrategy:
type: string
generateMatchTokensMapping:
type: boolean
generateTokensForExactOrAllNull:
type: boolean
generateSuspectByNegativeRules:
type: boolean
rebuildMatchTableTaskVersion:
type: string
rebuildMatchTableConfiguration:
$ref: '#/components/schemas/RebuildMatchTableConfiguration'
rebuildMatchTableV2Configuration:
$ref: '#/components/schemas/RebuildMatchTableV2Configuration'
stripDiacritics:
type: boolean
hashTokens:
type: boolean
tokenCollisionsLimit:
type: integer
format: int32
externalMatchEntitiesLimit:
type: integer
format: int32
minimumNotAMatchThreshold:
type: number
format: double
cleanseDictionaryConfiguration:
$ref: '#/components/schemas/CleanseDictionaryConfiguration'
suboptimalRulesDetectionServiceConfiguration:
$ref: '#/components/schemas/SuboptimalRulesDetectionServiceConfiguration'
incrementalMatchConfiguration:
$ref: '#/components/schemas/IncrementalMatchConfiguration'
migrationDataStorageId:
type: string
backgroundRebuildMode:
type: boolean
postRebuildMatchTablesCheck:
type: boolean
internalMatchCRUDConfiguration:
$ref: '#/components/schemas/InternalMatchCRUDConfiguration'
notMatchConfiguration:
$ref: '#/components/schemas/NotMatchConfiguration'
asMatchConfiguration:
$ref: '#/components/schemas/AsMatchConfiguration'
mlMatchConfiguration:
$ref: '#/components/schemas/Match IQ Configuration'
migrateTokensToHashed:
type: boolean
comparatorBatchSize:
type: integer
format: int32
matchingMigrationConfiguration:
$ref: '#/components/schemas/MatchingMigrationConfiguration'
unmergeConfiguration:
$ref: '#/components/schemas/UnmergeConfiguration'
matchAssetsConfiguration:
$ref: '#/components/schemas/MatchAssetsConfiguration'
bulkOperationPairsLimit:
type: integer
format: int32
HistoryTOFactoryPhysicalConfigurationHistoryDataPhysicalConfigurationHistorySnapshotTO:
type: object
TypeModifier:
type: object
RootNameLookup:
type: object
LocalizationService:
type: object
properties:
platform:
$ref: '#/components/schemas/ReltioPlatform'
syncObject:
type: object
cache:
type: object
additionalProperties:
$ref: '#/components/schemas/TenantStringsTO'
versions:
type: array
items:
$ref: '#/components/schemas/I18NVersion'
versionsUUID:
type: string
format: uuid
SurrogateCrosswalkConfig:
required:
- attributeUris
- enforce
- sourceUri
- attributes
- source
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
enforce:
type: boolean
description: >-
Specifies whether the value of the crosswalk should always be
calculated (true) or not (false)
generationLogic:
type: string
description: Specifies generation logic for surrogate crosswalks.
example: ovOnly
enum:
- ovOnly
- useFirstNonOvWhenOvMissing
- generateUidWhenOvMissing
- generateUidWhenOvAndNonOvMissing
- generateUidWhenAllOvMissing
source:
type: string
description: URI of source configuration element
attributes:
type: array
description: >-
List of attributes URIs. Operation values (OV) of those attributes
used to calculate value of surrogate crosswalk
items:
type: string
description: >-
Configuration of surrogate crosswalk definitions for particular source
system that do not provide value
ObjectIdResolver:
type: object
ChangeRequestDAO:
type: object
properties:
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
operation:
$ref: '#/components/schemas/IOperationStateProvider'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
marshaller:
$ref: '#/components/schemas/IMarshaller'
defaultSourceTypeNameProvider:
$ref: '#/components/schemas/DefaultSourceTypeNameProvider'
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
IOvSecurityFilterFactory:
type: object
DatabaseDAOStrategy:
type: object
IEventPublishService:
type: object
CosmosClientConfigMapping:
type: object
properties:
endpoint:
type: string
key:
type: string
credentials:
$ref: '#/components/schemas/CosmosCredentialsConfig'
consistencyLevel:
type: string
preferredRegions:
type: array
items:
type: string
dbConfig:
$ref: '#/components/schemas/CosmosDBConfig'
telemetry:
$ref: '#/components/schemas/CosmosTelemetryConfiguration'
throttlingRetryMaxWaitTimeMs:
type: integer
format: int64
throttlingRetryMaxAttempts:
type: integer
format: int32
PredicateAPIConfig:
type: object
properties:
enabled:
type: boolean
description: Enables/disables Predicate Query API for the tenant
example: true
consistency:
type: string
enum:
- eventual
- strong
description: Predicate Query API Configuration
LoadingCacheEntityTypeKeyEntityTypeMatchGroups:
type: object
IMatchActionTypeEvaluator:
type: object
ISplitActivityJoiner:
type: object
IMetadataService:
type: object
OvFilterFactoryProvider:
type: object
properties:
noneFactory:
$ref: '#/components/schemas/NoneOVSearchRequestFilterFactory'
staticFactory:
$ref: '#/components/schemas/StaticOVSearchFilterFactory'
groupsFactory:
$ref: '#/components/schemas/GroupsOVSearchFilterFactory'
LoadingCacheTenantIdLong:
type: object
CommonAssetsService:
type: object
properties:
converter:
$ref: '#/components/schemas/MatchAssetConverter'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
metadataServiceFactory:
$ref: '#/components/schemas/MetadataServiceFactory'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
metadataService:
$ref: '#/components/schemas/MetadataService'
commonAssetsMetrics:
$ref: '#/components/schemas/CommonAssetsMetrics'
LinkedNodeJavaType:
type: object
properties:
value:
$ref: '#/components/schemas/JavaType'
next:
$ref: '#/components/schemas/LinkedNodeJavaType'
DataMigrationConfig:
type: object
properties:
migrationDataStorageId:
type: string
commitLogStorageId:
type: string
tableNameMapping:
type: object
additionalProperties:
type: string
tags:
type: object
additionalProperties:
type: string
daoTypes:
type: array
items:
type: string
enum:
- ENTITIES
- RELATIONS
- INTERACTIONS
- ANALYTIC_ATTRIBUTES
- RELATION_ANALYTIC_ATTRIBUTES
- USER_PREFERENCES
- WORKFLOW
- CATEGORIES
- GROUPS
- GRAPHS
- ACTIVITY_LOG
- ACTIVITY_V2
- COMMIT_LOG
- ENTITY_SEGMENTATION
- PREDICATE_QUERY
- SEGMENTS
- MATCH_STORAGE
- POTENTIAL_MATCHES
- COMMON_ASSETS
- GROUPING
- HISTORY
- HIERARCHY
IAutoScalingProtector:
type: object
AwsBackupConfig:
type: object
properties:
encryptionType:
type: string
enum:
- KMS_AWS
- KMS_CUSTOMER
- KMS_RELTIO
kmsCustomerKeyMap:
type: object
additionalProperties:
$ref: '#/components/schemas/DynamoDBEncryptionKeyConfig'
EntityEmbeddingsProvider:
type: object
properties:
reltioAPIPlatform:
$ref: '#/components/schemas/ReltioAPIPlatform'
syncObject:
type: object
entityEmbeddingsConverter:
$ref: '#/components/schemas/EntityEmbeddingsConverter'
OptionCacheEntryIPermissions:
type: object
IBigQueryClient:
type: object
CustomerDatabaseService:
type: object
properties:
secretsManagerService:
$ref: '#/components/schemas/InteractionSecretsManagerService'
strategyRegistry:
$ref: '#/components/schemas/DatabaseDAOStrategyRegistry'
EventHubMatchServiceEventEntityURI:
type: object
IESBackpressureHandler:
type: object
CassandraKeyFactory:
type: object
ICosmosMetricsCollectorFactory:
type: object
Worker:
type: object
properties:
state:
type: integer
format: int32
thread:
$ref: '#/components/schemas/Thread'
firstTask:
$ref: '#/components/schemas/Runnable'
completedTasks:
type: integer
format: int64
RebuildMatchTableConfiguration:
type: object
properties:
batchSize:
type: integer
format: int32
corruptedObjectMaxWriteAttempts:
type: integer
format: int32
enableVectorCandidateLookups:
type: boolean
ReferenceQueueObject:
type: object
properties:
head:
$ref: '#/components/schemas/ReferenceObject'
queueLength:
type: integer
format: int64
lock:
$ref: '#/components/schemas/ReentrantLock'
notEmpty:
$ref: '#/components/schemas/Condition'
ModelUpdateListener:
type: object
GenericType:
type: object
properties:
type:
$ref: '#/components/schemas/Type'
arguments:
type: array
items:
$ref: '#/components/schemas/GenericType'
IDBLayerConverterObjectObjectObjectObject:
type: object
MergeTreeOptimizationService:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
ISuspendableSemaphore:
type: object
ruleBasedAttributesControlFunction:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
expression:
type: string
description: Expression on which fields has to be shown
example: >-
listEquals(attributes.Country.value, 'abc', 'def') and
listEquals(attributes.State.value, 'abc', 'def')
showAttributeURI:
type: array
description: List of attributes to be shown based on the expression
example: >-
[
"configuration/entityTypes/Organization12/attributes/LegalBusinessName"
]
items:
type: string
MergeTreeRecordParser:
type: object
AzureQueueConfig:
type: object
properties:
namespace:
type: string
DateFormat:
type: object
properties:
calendar:
type: string
format: date-time
numberFormat:
$ref: '#/components/schemas/NumberFormat'
CircuitBreakerRegistry:
type: object
AzureFunctionAuthenticator:
type: object
properties:
tokenProvider:
$ref: '#/components/schemas/AzureTokenProvider'
FilterNotEqualsCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'not equal' criteria
JsonDeserializerObject:
type: object
Locale:
type: object
ThreadFactory:
type: object
BytesTracker:
type: object
properties:
bytesRead:
$ref: '#/components/schemas/AtomicLong'
bytesWritten:
$ref: '#/components/schemas/AtomicLong'
CleanseInfoChain:
required:
- chain
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
chain:
type: array
description: >-
List of cleanse functions that are applied one by one depending on
the proceedOnSuccess or proceedOnError parameters
items:
$ref: '#/components/schemas/CleanseInfoElement'
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: Chain of cleanse functions that are applied one by one
ILocalizationDAO:
type: object
UserPreferencesDAO:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
IOperationWrapper:
type: object
EntitiesHistoryDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
tenantsDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
historyMarshaller:
$ref: '#/components/schemas/IMarshaller'
IPlatformsInfo:
type: object
PeriodicTasksService:
type: object
properties:
periodicTaskDAO:
$ref: '#/components/schemas/IPeriodicTaskDAO'
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
platformsAccess:
$ref: '#/components/schemas/IPlatformsAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
taskFactoryProvider:
$ref: '#/components/schemas/PeriodicTaskFactoryProvider'
reltioPlatform:
$ref: '#/components/schemas/ReltioPlatform'
operationStatsService:
$ref: '#/components/schemas/OperationStatsService'
autoScalingProtector:
$ref: '#/components/schemas/IAutoScalingProtector'
tenantOperationsProcessor:
$ref: '#/components/schemas/TenantCreditsOperationsProcessor'
throttlingListener:
$ref: '#/components/schemas/PeriodicTaskThrottlingListener'
periodicThreadsCount:
type: integer
format: int32
periodicTasksExecutorThreads:
type: array
items:
$ref: '#/components/schemas/PeriodicTasksExecutorThread'
schedulerLock:
type: object
lastCheckedCassandraChangeVersion:
type: string
lastForceCheckTime:
type: integer
format: int64
executePeriodicTasks:
type: boolean
isInitialized:
type: boolean
stopped:
type: boolean
running:
type: boolean
throttlingHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
globalPtConfig:
$ref: '#/components/schemas/PeriodicTaskConfiguration'
scheduler:
$ref: '#/components/schemas/IPeriodicTaskScheduler'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
recoverDeadNodesLockName:
type: string
fixTasksLockName:
type: string
lockApplyingTaskCount:
type: integer
format: int32
rebuildMatchTableTaskFactory:
$ref: '#/components/schemas/RebuildMatchTableTaskFactory'
postRebuildMatchTableCheckTaskFactory:
$ref: '#/components/schemas/PostRebuildMatchTableCheckTaskFactory'
migrateCassandraHistoryTaskFactory:
$ref: '#/components/schemas/MigrateCassandraHistoryTaskFactory'
taskFactories:
type: array
items:
$ref: '#/components/schemas/IPeriodicTaskFactoryObject'
reltioPermissionManager:
$ref: '#/components/schemas/ReltioPermissionManager'
crudEventHubService:
$ref: '#/components/schemas/CRUDEventHubService'
matchEventHubService:
$ref: '#/components/schemas/MatchEventHubService'
mailService:
$ref: '#/components/schemas/MailService'
cloudStorageServiceFactory:
$ref: '#/components/schemas/CloudStorageServiceFactory'
apiTaskSummaryService:
$ref: '#/components/schemas/ApiTaskSummaryService'
entityTotalEstimator:
$ref: '#/components/schemas/GenericTotalEstimator'
waitingForQueueChecker:
$ref: '#/components/schemas/WaitingForQueueChecker'
isUpdateScheduledTaskRunning:
$ref: '#/components/schemas/AtomicBoolean'
UserDetails:
type: object
AccessControlContext:
type: object
properties:
context:
type: array
items:
$ref: '#/components/schemas/ProtectionDomain'
isPrivileged:
type: boolean
isAuthorized:
type: boolean
privilegedContext:
$ref: '#/components/schemas/AccessControlContext'
combiner:
$ref: '#/components/schemas/DomainCombiner'
permissions:
type: array
items:
$ref: '#/components/schemas/Permission'
parent:
$ref: '#/components/schemas/AccessControlContext'
isWrapped:
type: boolean
isLimited:
type: boolean
limitedContext:
type: array
items:
$ref: '#/components/schemas/ProtectionDomain'
IPlatformRemoteTokenService:
type: object
IHazelcastInstanceProviderClientConfig:
type: object
GeneratorsFactory:
type: object
properties:
idGeneratorService:
$ref: '#/components/schemas/IdGeneratorService'
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
locker:
$ref: '#/components/schemas/ILockerString'
FilterLessOrEqualCriteria:
required:
- uri
- value
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Exact value to compare with
example: John
description: Defines 'less or equal' criteria
LongLocksMonitoringService:
type: object
properties:
enabled:
type: boolean
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
threadDumpProducer:
$ref: '#/components/schemas/MonitoringThreadDumpProducer'
hostName:
type: string
platformId:
type: string
platformsAccess:
$ref: '#/components/schemas/IPlatformsAccess'
mapName:
type: string
mapArchiveName:
type: string
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
operationsMonitoringService:
$ref: '#/components/schemas/IOperationsMonitoringService'
lastCleanUpTimestamp:
type: integer
format: int64
absentLocks:
type: object
additionalProperties:
type: integer
format: int64
TruncateBuiltinAlgorithm:
type: object
UserPreferencesService:
type: object
properties:
userPreferencesDAO:
$ref: '#/components/schemas/UserPreferencesDAO'
userPreferencesCache:
$ref: >-
#/components/schemas/AsyncLoadingCacheUserPrefCacheKeyMapStringListString
TenantInitializerIdGenerator:
type: object
properties:
counter:
$ref: '#/components/schemas/AtomicLong'
ReltioPlatform:
type: object
properties:
syslogLoggingService:
$ref: '#/components/schemas/SyslogLoggingService'
syncObject:
type: object
enableRDM:
type: boolean
enableRDMBasedCleanse:
type: boolean
enableHistory:
type: boolean
userRoleAccess:
$ref: '#/components/schemas/UserRoleAccess'
systemDataAccess:
$ref: '#/components/schemas/SystemDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
tenantFilteringService:
$ref: '#/components/schemas/TenantFilteringService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
interactionsService:
$ref: '#/components/schemas/InteractionsService'
customerDAOService:
$ref: '#/components/schemas/CustomerDAOService'
zeroCopyMetadataService:
$ref: '#/components/schemas/ZeroCopyMetadataService'
relationsService:
$ref: '#/components/schemas/RelationsService'
graphService:
$ref: '#/components/schemas/GraphService'
groupService:
$ref: '#/components/schemas/GroupService'
segmentService:
$ref: '#/components/schemas/SegmentService'
segmentSearchService:
$ref: '#/components/schemas/ISegmentSearch'
storageVectorService:
$ref: '#/components/schemas/IStorageVectorService'
embeddingsAPIClient:
$ref: '#/components/schemas/IEmbeddingsAPIClient'
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
metadataPermissionFilterService:
$ref: '#/components/schemas/MetadataPermissionFilterService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
materializedViewService:
$ref: '#/components/schemas/MaterializedViewService'
businessProcessDataService:
$ref: '#/components/schemas/BusinessProcessDataService'
historyService:
$ref: '#/components/schemas/HistoryService'
metadataModificationService:
$ref: '#/components/schemas/MetadataModificationService'
metricsProviderService:
$ref: '#/components/schemas/PlatformMetricsProviderService'
indexingErrorsMonitoringService:
$ref: '#/components/schemas/IndexingErrorsMonitoringService'
esClusterStatsFetcher:
$ref: '#/components/schemas/ESClusterStatsFetcher'
esIndexController:
$ref: '#/components/schemas/ESIndexController'
userPreferencesService:
$ref: '#/components/schemas/UserPreferencesService'
predicateQueryService:
$ref: '#/components/schemas/PredicateQueryService'
groupingService:
$ref: '#/components/schemas/IGroupingService'
entitySegmentationService:
$ref: '#/components/schemas/EntitySegmentationService'
schemalessInteractionService:
$ref: '#/components/schemas/SchemalessInteractionService'
interactionMemberResolverService:
$ref: '#/components/schemas/InteractionMemberResolverService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
searchService:
$ref: '#/components/schemas/StorageSearch'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
categoriesTreeService:
$ref: '#/components/schemas/CategoriesTreeService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
serializationUtils:
$ref: '#/components/schemas/FastSerializationUtils'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
readOnlyMatchingService:
$ref: '#/components/schemas/ReadOnlyMatchingService'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
suboptimalRulesDetectionService:
$ref: '#/components/schemas/SuboptimalRulesDetectionService'
suboptimalRulesActionStorage:
$ref: '#/components/schemas/SuboptimalRulesActionStorage'
suboptimalRulesActionService:
$ref: '#/components/schemas/SuboptimalRulesActionService'
predefinedMatchGroupsSupplier:
$ref: '#/components/schemas/AtomicReferencePredefinedMatchGroupsSupplier'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
relationAnalyticsAttributesService:
$ref: '#/components/schemas/RelationAnalyticsAttributesService'
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
throttlingHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
metricsHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
migrationHazelcastService:
$ref: '#/components/schemas/PureHazelcastService'
matchHazelcastService:
$ref: '#/components/schemas/HazelcastService'
matchLockerAccess:
$ref: '#/components/schemas/ILockerAccess'
changeRequestService:
$ref: '#/components/schemas/ChangeRequestService'
objectsModificationService:
$ref: '#/components/schemas/ObjectsModificationService'
localizationService:
$ref: '#/components/schemas/LocalizationService'
lifecycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
platformRemoteTokenService:
$ref: '#/components/schemas/IPlatformRemoteTokenService'
rdmService:
$ref: '#/components/schemas/RDMService'
oAuthInstanceService:
$ref: '#/components/schemas/OAuthInstanceService'
interactionMappingService:
$ref: '#/components/schemas/InteractionMappingService'
interactionMappingServiceLock:
$ref: '#/components/schemas/Lock'
customerDatabaseConfigService:
$ref: '#/components/schemas/CustomerDatabaseConfigService'
customerDatabaseConfigServiceLock:
$ref: '#/components/schemas/Lock'
oAuthStateStoreService:
$ref: '#/components/schemas/OAuthStateStoreService'
oAuthStateStoreServiceLock:
$ref: '#/components/schemas/Lock'
snowflakeOAuthService:
$ref: '#/components/schemas/SnowflakeOAuthService'
snowflakeOAuthServiceLock:
$ref: '#/components/schemas/Lock'
idGeneratorService:
$ref: '#/components/schemas/IdGeneratorService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationService'
mailService:
$ref: '#/components/schemas/MailService'
operationStatsService:
$ref: '#/components/schemas/OperationStatsService'
creditsService:
$ref: '#/components/schemas/ICreditsService'
cpLimitsService:
$ref: '#/components/schemas/CPLimitsService'
kryoCustomizerProvider:
$ref: '#/components/schemas/KryoCustomizerProvider'
kryoCustomizerProviderV3:
$ref: '#/components/schemas/KryoCustomizerProviderV3'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
analyticsAttributesDAO:
$ref: '#/components/schemas/EntityAnalyticsAttributesDAO'
relationAnalyticsAttributesDAO:
$ref: '#/components/schemas/RelationAnalyticsAttributesDAO'
relationsDAO:
$ref: '#/components/schemas/RelationsDAO'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
shutdownHazelcast:
type: boolean
tokenProviderFactory:
$ref: '#/components/schemas/ITokenProviderFactory'
maxRequestBodySize:
type: integer
format: int64
maxObjectsPerPost:
type: integer
format: int32
externalMatchLimitDefault:
type: integer
format: int32
isShutdown:
type: boolean
isShutdownRequested:
type: boolean
commonDataAccess:
$ref: '#/components/schemas/CommonDataAccess'
backpressureHandler:
$ref: '#/components/schemas/IESBackpressureHandler'
esSearchLatencyTracker:
$ref: '#/components/schemas/ESSearchLatencyTracker'
validationAzureHubClientProvider:
$ref: '#/components/schemas/IValidationAzureHubClientProvider'
cleanseEncryptionEngine:
$ref: '#/components/schemas/IEncryptionEngine'
checkConnection:
type: boolean
platformType:
type: string
enum:
- OTHER
- API
- EXPORT
- VALIDATION
- DTSS
- IRS
- ANALYTICS
- ACTIVITY_LOG_V2
- MLMATCH
- READ_ONLY
shutdownFunctions:
type: array
items:
$ref: '#/components/schemas/Runnable'
healthCheckQuickExecutor:
$ref: '#/components/schemas/ThreadPoolExecutor'
configuration:
$ref: '#/components/schemas/Configuration'
mergeSplitServiceProvider:
$ref: '#/components/schemas/MergeSplitServiceProvider'
crudServiceProvider:
$ref: '#/components/schemas/CRUDServiceProvider'
lockIgnoreTenantHandler:
$ref: '#/components/schemas/ILockIgnoreTenantHandler'
metricsServiceFactory:
$ref: '#/components/schemas/MetricsServiceFactory'
metricsProviderConfigurator:
$ref: '#/components/schemas/IMetricsProviderConfigurator'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
gbtHistoryConfigurationProvider:
$ref: '#/components/schemas/IBigTableConfigurationProvider'
supportedConfigurationTypes:
uniqueItems: true
type: array
items:
type: string
enum:
- PLATFORM
- ACTIVITY_LOG
dynamoDBConfigurationProvider:
$ref: '#/components/schemas/IDynamoDBConfigurationProvider'
auroraDBConfigurationProvider:
$ref: '#/components/schemas/AuroraDBConfigurationProvider'
recentObjectChanges:
$ref: '#/components/schemas/IRecentObjectChanges'
metricsCollectorFactory:
$ref: '#/components/schemas/ICassandraMetricsCollectorFactory'
testMode:
type: boolean
bigQueryClientFactory:
$ref: '#/components/schemas/IBigQueryClientFactory'
notificationService:
$ref: '#/components/schemas/NotificationService'
lockerAccess:
$ref: '#/components/schemas/HazelcastLockerAccess'
candidateSupplierManager:
$ref: '#/components/schemas/CandidateSupplierManager'
credentialsProviderResolver:
$ref: '#/components/schemas/CredentialsProviderResolver'
entitySearchService:
$ref: '#/components/schemas/EntitySearchService'
entityFacetsService:
$ref: '#/components/schemas/EntityFacetsService'
customerDatabaseService:
$ref: '#/components/schemas/CustomerDatabaseService'
customerDatabaseServiceLock:
$ref: '#/components/schemas/Lock'
zeroCopyMetadataServiceLock:
$ref: '#/components/schemas/Lock'
segmentServiceLock:
$ref: '#/components/schemas/Lock'
SerializationConfig:
type: object
properties:
_mapperFeatures:
type: integer
format: int32
_base:
$ref: '#/components/schemas/BaseSettings'
_mixIns:
$ref: '#/components/schemas/SimpleMixInResolver'
_subtypeResolver:
$ref: '#/components/schemas/SubtypeResolver'
_rootName:
$ref: '#/components/schemas/PropertyName'
_attributes:
$ref: '#/components/schemas/ContextAttributes'
_rootNames:
$ref: '#/components/schemas/RootNameLookup'
_configOverrides:
$ref: '#/components/schemas/ConfigOverrides'
_filterProvider:
$ref: '#/components/schemas/FilterProvider'
_defaultPrettyPrinter:
$ref: '#/components/schemas/PrettyPrinter'
_serFeatures:
type: integer
format: int32
_generatorFeatures:
type: integer
format: int32
_generatorFeaturesToChange:
type: integer
format: int32
_formatWriteFeatures:
type: integer
format: int32
_formatWriteFeaturesToChange:
type: integer
format: int32
ISafeDaoHolderIDBPlatformStatisticsDAO:
type: object
EntitySearchService:
type: object
properties:
reltioAPIPlatform:
$ref: '#/components/schemas/ReltioPlatform'
searchResultFetcher:
$ref: '#/components/schemas/SearchResultFetcher'
staticOVSearchFilterFactory:
$ref: '#/components/schemas/StaticOVSearchFilterFactory'
groupsOVSearchFilterFactory:
$ref: '#/components/schemas/GroupsOVSearchFilterFactory'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
ResourceLifecycleListener:
type: object
ReportingConfig:
type: object
properties:
dataStudioConfig:
$ref: '#/components/schemas/DataStudioConfig'
OperationStats:
type: object
properties:
tenantId:
type: string
operationId:
type: string
operationType:
type: string
enum:
- ASYNC
- SYNC
- INTERNAL
statMap:
type: object
additionalProperties:
$ref: '#/components/schemas/StorageStat'
dbStatMap:
type: object
additionalProperties:
$ref: '#/components/schemas/StorageTracker'
statByRequestType:
type: object
additionalProperties:
$ref: '#/components/schemas/StorageStat'
serviceStats:
type: object
additionalProperties:
$ref: '#/components/schemas/ServiceStat'
isPaused:
type: boolean
esBytesTracker:
$ref: '#/components/schemas/BytesTracker'
CommonAssetsMetrics:
type: object
properties:
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
GcpAuth:
type: object
properties:
type:
type: string
projectId:
type: string
privateKeyId:
type: string
privateKey:
type: string
clientEmail:
type: string
clientId:
type: string
authUri:
type: string
tokenUri:
type: string
authProviderX509CertUrl:
type: string
clientX509CertUrl:
type: string
bucket:
type: string
OAuthValue:
type: object
properties:
temporaryAccess:
$ref: '#/components/schemas/AccessToken'
requestMetadata:
type: object
additionalProperties:
type: array
items:
type: string
Value:
type: object
properties:
_fieldVisibility:
type: string
enum:
- ANY
- NON_PRIVATE
- PROTECTED_AND_PUBLIC
- PUBLIC_ONLY
- NONE
- DEFAULT
_getterVisibility:
type: string
enum:
- ANY
- NON_PRIVATE
- PROTECTED_AND_PUBLIC
- PUBLIC_ONLY
- NONE
- DEFAULT
_isGetterVisibility:
type: string
enum:
- ANY
- NON_PRIVATE
- PROTECTED_AND_PUBLIC
- PUBLIC_ONLY
- NONE
- DEFAULT
_setterVisibility:
type: string
enum:
- ANY
- NON_PRIVATE
- PROTECTED_AND_PUBLIC
- PUBLIC_ONLY
- NONE
- DEFAULT
_creatorVisibility:
type: string
enum:
- ANY
- NON_PRIVATE
- PROTECTED_AND_PUBLIC
- PUBLIC_ONLY
- NONE
- DEFAULT
Throwable:
type: object
properties:
detailMessage:
type: string
cause:
$ref: '#/components/schemas/Throwable'
stackTrace:
type: array
items:
$ref: '#/components/schemas/StackTraceElement'
suppressedExceptions:
type: array
items:
$ref: '#/components/schemas/Throwable'
ITenantAuthorizationTokenProvider:
type: object
DynamoDBProperties:
type: object
properties:
initialReadCapacity:
type: integer
format: int64
initialWriteCapacity:
type: integer
format: int64
capacityMode:
$ref: '#/components/schemas/DynamoDBCapacityMode'
LcaConfig:
type: object
properties:
nativeTimeOut:
type: integer
description: Native LCA time out in milliseconds
format: int32
example: 1000
lambdaTimeOut:
type: integer
description: Lambda based LCA time out in milliseconds
format: int32
example: 1000
dvfTimeOut:
type: integer
description: DVF LCA time out in milliseconds
format: int32
example: 1000
gcpConfig:
$ref: '#/components/schemas/LcaGcpConfig'
azureConfig:
$ref: '#/components/schemas/LcaAzureConfig'
description: LCA timeout Configuration
AddressAutoCompleteMappingConfig:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
minSearchTextLen:
type: integer
description: Minimum length of text required to trigger address search
format: int32
providerOpts:
type: object
additionalProperties:
type: object
description: Additional provider-specific configuration options
inputMapping:
type: array
description: List of Input mappings
items:
$ref: '#/components/schemas/CleanseAttributeMapping'
outputMapping:
type: array
description: List of Output mappings
items:
$ref: '#/components/schemas/CleanseAttributeMapping'
description: >-
Configuration of address auto complete attribute mapping for Entity
Types
CandidateSupplierManager:
type: object
SegmentationConfiguration:
type: object
properties:
segmentationLimits:
$ref: '#/components/schemas/SegmentationLimits'
incrementalSegmentationEnabled:
type: boolean
FunctionTenantIdMatchOptions:
type: object
IEventPublishServiceObject:
type: object
ClientsPoolSettings:
type: object
properties:
cacheEnabled:
type: boolean
cacheSyncDelay:
type: integer
format: int64
httpConnectionPoolSize:
type: integer
format: int32
httpThreadPoolSize:
type: integer
format: int32
transcoderCacheAccessTTL:
type: integer
format: int64
transcoderCacheWriteTTL:
type: integer
format: int64
responseTimeoutMs:
type: integer
format: int64
rdmUpdatesBackupServiceUri:
type: string
TenantsConfigurationService:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
metadataService:
$ref: '#/components/schemas/MetadataService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishService'
historyService:
$ref: '#/components/schemas/HistoryService'
defaultValuesProvider:
$ref: '#/components/schemas/TenantsConfigurationDefaultValuesProvider'
searchAuthenticationService:
$ref: '#/components/schemas/ISearchAuthenticationService'
encryptionEngine:
$ref: '#/components/schemas/IEncryptionEngine'
cleanseEncryptEngine:
$ref: '#/components/schemas/IEncryptionEngine'
SearchAuthenticationConfig:
type: object
properties:
username:
type: string
password:
type: string
encryptedPassword:
type: string
MatchGroupsScoreCalculator:
type: object
I18NVersion:
type: object
properties:
tenantId:
$ref: '#/components/schemas/ITenantID'
version:
type: string
CacheRecordMapStringListString:
type: object
properties:
value:
type: object
additionalProperties:
type: array
items:
type: string
timestamp:
type: integer
format: int64
ResourceTracker:
type: object
properties:
instance:
$ref: '#/components/schemas/HazelcastInstance'
cache:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
type: string
ITenantFilterListener:
type: object
AtomicReferenceICRUDService:
type: object
properties:
value:
$ref: '#/components/schemas/ICRUDService'
JsonNodeFactory:
type: object
properties:
_cfgBigDecimalExact:
type: boolean
OrderingStrategy:
type: object
properties:
fieldURI:
type: string
description: Field URI for FieldBased ordering strategy
example: LUD
enum:
- LUD
- FieldBased
orderType:
type: string
description: Ordering direction
example: ASC
enum:
- ASC
- DESC
orderingStrategy:
type: string
description: Ordering Strategy name
example: LUD
enum:
- LUD
- FieldBased
description: >-
Attribute values ordering and attribute values survivorship are both
complex sorting strategies, but have different usage and configuration.
Both values ordering and attribute values survivorship results are
transient, they don't interfere with each other. Attribute survivorship
strategy results (OV values) are used by UI to customize which attribute
values to display to end user. Attribute values order in output is
determined by attribute ordering strategy
AtomicReferenceReadOnlyClassToSerializerMap:
type: object
properties:
value:
$ref: '#/components/schemas/ReadOnlyClassToSerializerMap'
DomainCombiner:
type: object
LoggingConfig:
type: object
properties:
sysLogServer:
type: string
sysLogFacility:
type: string
ActivityLogConfig:
type: object
properties:
ttl:
type: string
returnObjectLabelsInScan:
type: boolean
convertNullsToEmptyLabelsInCassandra:
type: boolean
fillStoredLabels:
type: boolean
joinSplitActivity:
type: boolean
longTermStorage:
$ref: '#/components/schemas/ActivityLogLongTermStorageConfig'
CosmosTelemetryConfiguration:
type: object
properties:
payloadSizeThreshold:
type: integer
format: int32
pointOperationLatencyThresholdMs:
type: integer
format: int64
nonPointOperationLatencyThresholdMs:
type: integer
format: int64
requestChargeThreshold:
type: number
format: float
OperationStatsStorage:
type: object
Configuration:
type: object
properties:
parent:
$ref: '#/components/schemas/Configurable'
properties:
type: object
additionalProperties:
type: string
customAttributes:
type: object
additionalProperties:
type: object
locale:
$ref: '#/components/schemas/Locale'
numberFormat:
type: string
timeFormat:
type: string
dateFormat:
type: string
dateTimeFormat:
type: string
timeZone:
$ref: '#/components/schemas/TimeZone'
sqlDataAndTimeTimeZone:
$ref: '#/components/schemas/TimeZone'
sqlDataAndTimeTimeZoneSet:
type: boolean
booleanFormat:
type: string
trueStringValue:
type: string
falseStringValue:
type: string
classicCompatible:
type: integer
format: int32
templateExceptionHandler:
$ref: '#/components/schemas/TemplateExceptionHandler'
attemptExceptionReporter:
$ref: '#/components/schemas/AttemptExceptionReporter'
arithmeticEngine:
$ref: '#/components/schemas/ArithmeticEngine'
objectWrapper:
$ref: '#/components/schemas/ObjectWrapper'
outputEncoding:
type: string
outputEncodingSet:
type: boolean
urlEscapingCharset:
type: string
urlEscapingCharsetSet:
type: boolean
autoFlush:
type: boolean
showErrorTips:
type: boolean
newBuiltinClassResolver:
$ref: '#/components/schemas/TemplateClassResolver'
apiBuiltinEnabled:
type: boolean
truncateBuiltinAlgorithm:
$ref: '#/components/schemas/TruncateBuiltinAlgorithm'
logTemplateExceptions:
type: boolean
wrapUncheckedExceptions:
type: boolean
customDateFormats:
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateDateFormatFactory'
customNumberFormats:
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateNumberFormatFactory'
autoImports:
type: object
additionalProperties:
type: string
autoIncludes:
type: array
items:
type: string
lazyImports:
type: boolean
lazyAutoImports:
type: boolean
lazyAutoImportsSet:
type: boolean
strictSyntax:
type: boolean
localizedLookup:
type: boolean
whitespaceStripping:
type: boolean
autoEscapingPolicy:
type: integer
format: int32
outputFormat:
$ref: '#/components/schemas/OutputFormat'
outputFormatExplicitlySet:
type: boolean
recognizeStandardFileExtensions:
type: boolean
registeredCustomOutputFormats:
type: object
additionalProperties:
$ref: '#/components/schemas/OutputFormat'
incompatibleImprovements:
$ref: '#/components/schemas/Version'
tagSyntax:
type: integer
format: int32
interpolationSyntax:
type: integer
format: int32
namingConvention:
type: integer
format: int32
tabSize:
type: integer
format: int32
fallbackOnNullLoopVariable:
type: boolean
preventStrippings:
type: boolean
cache:
$ref: '#/components/schemas/TemplateCache'
templateLoaderExplicitlySet:
type: boolean
templateLookupStrategyExplicitlySet:
type: boolean
templateNameFormatExplicitlySet:
type: boolean
cacheStorageExplicitlySet:
type: boolean
objectWrapperExplicitlySet:
type: boolean
templateExceptionHandlerExplicitlySet:
type: boolean
attemptExceptionReporterExplicitlySet:
type: boolean
logTemplateExceptionsExplicitlySet:
type: boolean
wrapUncheckedExceptionsExplicitlySet:
type: boolean
localeExplicitlySet:
type: boolean
defaultEncodingExplicitlySet:
type: boolean
timeZoneExplicitlySet:
type: boolean
sharedVariables:
type: object
additionalProperties:
type: object
rewrappableSharedVariables:
type: object
additionalProperties:
type: object
defaultEncoding:
type: string
localeToCharsetMap:
type: object
additionalProperties:
type: object
OutputStream:
type: object
MatchRuleApplicabilityEvaluator:
type: object
properties:
platform:
$ref: '#/components/schemas/ReltioAPIPlatform'
filterCache:
$ref: '#/components/schemas/CacheCacheKeyObjectFilterMatcher'
samplingStrategy:
$ref: '#/components/schemas/ExceptionLogSamplingStrategy'
metrics:
$ref: '#/components/schemas/MatchRuleApplicabilityMetrics'
CommonDataAccess:
type: object
properties:
isShutDown:
$ref: '#/components/schemas/AtomicBoolean'
sync:
type: object
dbLookupsDAO:
$ref: '#/components/schemas/ISafeDaoHolderIDBLookupsDAO'
dbPlatformStatisticsDAO:
$ref: '#/components/schemas/ISafeDaoHolderIDBPlatformStatisticsDAO'
platformsStatisticsAccess:
$ref: '#/components/schemas/IPlatformsStatisticsAccess'
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
factory:
$ref: '#/components/schemas/ISystemDAOsFactory'
AndCondition:
required:
- operator
- uri
type: object
properties:
uri:
type: string
operator:
type: string
value:
type: string
or:
type: array
description: 'List of '
items:
$ref: '#/components/schemas/OrCondition'
and:
type: array
description: 'List of '
items:
$ref: '#/components/schemas/AndCondition'
MatchDeltaClustersEvaluatorFactory:
type: object
Permission:
type: object
properties:
name:
type: string
MatchingConfigurationFactorsCache:
type: object
properties:
cache:
$ref: >-
#/components/schemas/LoadingCacheCacheKeyMatchingConfigurationFactors
tenantMatchGroupsCache:
$ref: '#/components/schemas/TenantMatchGroupsCache'
factory:
$ref: '#/components/schemas/MatchingConfigurationFactorsFactory'
CsvConfig:
type: object
properties:
includeRelationActiveness:
type: boolean
includeRelationPinnedIgnored:
type: boolean
MatchingConfigurationFactorsFactory:
type: object
properties:
tenantMatchGroupsCache:
$ref: '#/components/schemas/TenantMatchGroupsCache'
LLM Comparator Configuration:
type: object
properties:
enabled:
type: boolean
description: If true, LLM comparators are enabled
description: Configuration for LLM-based comparator
TenantSearchBufferedConfiguration:
type: object
properties:
esHosts:
type: string
esClusterName:
type: string
numberOfShards:
type: integer
format: int32
numberOfRelationsShards:
type: integer
format: int32
numberOfActivitiesShards:
type: integer
format: int32
numberOfInteractionsShards:
type: integer
format: int32
waitForAllShards:
type: boolean
indexRequestTimeout:
type: integer
format: int32
numberOrReplicas:
type: integer
format: int32
maxNumberOfResults:
type: integer
format: int32
refreshIndexOnInserts:
type: boolean
indexRefreshInterval:
type: integer
format: int64
maxNumberOfIndexRequests:
type: integer
format: int32
maxNumberOfIndexRequestsPerCluster:
type: integer
format: int32
indexRelations:
type: boolean
indexActivityDelta:
type: boolean
separateMLMatchRulesInSearch:
type: boolean
indexDocumentSources:
type: boolean
indexOvStrategy:
type: string
enum:
- NONE
- STATIC
- GROUPS
indexOnlySearchableAttributes:
type: boolean
indexRDMLookups:
type: boolean
preserveCursor:
type: boolean
maxAttributeLength:
type: integer
format: int32
prefixSearchMaxExpansions:
type: integer
format: int32
bufferedIndexNames:
type: object
additionalProperties:
type: string
enableBufferedCluster:
type: boolean
indexExportCsvHeaders:
type: boolean
maxSearchFileLines:
type: integer
format: int32
defaultBoostFactor:
type: number
format: float
indexShardMonitoring:
type: boolean
prepareRelationIndex:
type: boolean
eventHubBackpressure:
type: boolean
bufferedIndexWithNoReplicas:
type: boolean
indexingErrorsMonitoring:
type: boolean
indexRelevanceScores:
type: boolean
indexWildcardTextFields:
type: boolean
stopIndexation:
type: boolean
queryBuilderAttributeList:
type: boolean
authentication:
$ref: '#/components/schemas/SearchAuthenticationConfig'
appendEqualsAnalyzedForContainsWordStartingWith:
type: boolean
backpressureVersion:
type: string
enum:
- V1
- V2
maxFilterClauses:
type: integer
format: int32
ovSecurityFilterFactoryVersion:
type: string
enum:
- V1
- V2
reindexTaskConfig:
$ref: '#/components/schemas/ReindexTaskConfig'
bufferedClusterConfig:
$ref: '#/components/schemas/TenantSearchConfiguration'
LoadingCacheCacheKeyMatchingConfigurationFactors:
type: object
AdapterConfig:
type: object
properties:
enabled:
type: boolean
dataFilteringEnabled:
type: boolean
name:
type: string
type:
type: string
enum:
- GBQ
- SNOWFLAKE
- DNB
- DELTALAKE
- DATASHARE_FABRIC
- DATASHARE_DATABRICKS
- DATASHARE_SNOWFLAKE
serializeInitialSourcesInCrosswalks:
type: boolean
evolveSchemas:
type: boolean
FilterComplexityChecker:
type: object
properties:
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
defaultMaxFilterClauses:
type: integer
format: int32
PublisherPool:
type: object
IRestRDMClient:
type: object
MutableConfigOverride:
type: object
properties:
_format:
$ref: '#/components/schemas/Value'
_include:
$ref: '#/components/schemas/Value'
_includeAsProperty:
$ref: '#/components/schemas/Value'
_ignorals:
$ref: '#/components/schemas/Value'
_setterInfo:
$ref: '#/components/schemas/Value'
_visibility:
$ref: '#/components/schemas/Value'
_isIgnoredType:
type: boolean
_mergeable:
type: boolean
IOAuthInstanceListener:
type: object
EventProcessorsConfiguration:
type: object
properties:
mergeByCrosswalkProcessorEnabled:
type: boolean
analyticsSyncProcessorEnabled:
type: boolean
entityHistoryProcessorEnabled:
type: boolean
entityMatchHistoryProcessorEnabled:
type: boolean
graphProcessorEnabled:
type: boolean
internalMatchCRUDProcessorEnabled:
type: boolean
eventStreamProcessorEnabled:
type: boolean
incrementalMatchProcessorEnabled:
type: boolean
matchEventStreamProcessorEnabled:
type: boolean
searchServiceProcessorsEnabled:
type: boolean
unmergeEntitiesEventProcessor:
type: boolean
predicateQueryProcessorEnabled:
type: boolean
groupingProcessorEnabled:
type: boolean
segmentationSearchProcessorEnabled:
type: boolean
vectorProcessorEnabled:
type: boolean
hierarchyCrudProcessorEnabled:
type: boolean
MessagingConfig:
type: object
properties:
destinations:
type: array
items:
$ref: '#/components/schemas/MessagingDestination'
AtomicBoolean:
type: object
properties:
value:
type: integer
format: int32
AtomicInteger:
type: object
properties:
value:
type: integer
format: int32
PolymorphicTypeValidator:
type: object
Key:
type: object
StackChunk:
type: object
properties:
parent:
$ref: '#/components/schemas/StackChunk'
size:
type: integer
format: int32
sp:
type: integer
format: int32
argsize:
type: integer
format: int32
TemplateConfigurationFactory:
type: object
properties:
cfg:
$ref: '#/components/schemas/Configuration'
StatisticsCollector:
type: object
properties:
lock:
$ref: '#/components/schemas/Lock'
logger:
$ref: '#/components/schemas/CommonStatsLoggerRecord'
logEntries:
type: object
additionalProperties:
$ref: '#/components/schemas/Record'
lastReportTime:
type: integer
format: int64
reportInterval:
type: integer
format: int64
loggers:
type: array
items:
$ref: '#/components/schemas/StatsLogger'
TenantsStorage:
type: object
properties:
lock:
$ref: '#/components/schemas/TenantsStorageLock'
marshaller:
$ref: '#/components/schemas/ObjectMapper'
lastUpdateTime:
type: integer
format: int64
configurations:
$ref: '#/components/schemas/AtomicReferenceListTenantConfiguration'
dao:
$ref: '#/components/schemas/ITenantsDAO'
numericIds:
type: object
additionalProperties:
type: integer
format: int32
LocalizedValueTO:
type: object
properties:
value:
type: string
language:
type: string
variants:
type: array
items:
type: string
IGroupingService:
type: object
CommonStatsLoggerRecord:
type: object
MatchGroupsConverter:
type: object
ObjectCodec:
type: object
Logger:
type: object
properties:
name:
type: string
level:
$ref: '#/components/schemas/Level'
parent:
$ref: '#/components/schemas/Category'
resourceBundle:
$ref: '#/components/schemas/ResourceBundle'
repository:
$ref: '#/components/schemas/LoggerRepository'
aai:
$ref: '#/components/schemas/AppenderAttachableImpl'
additive:
type: boolean
TenantCleanseFunctionConfiguration:
required:
- cleanseFunction
type: object
properties:
cleanseFunction:
type: string
description: Cleanse function name
example: PhoneCleanser1
type:
type: string
description: fully-qualified name of the class
example: com.reltio.plugin.cleanse.service.PhoneCleanser
module:
type: string
description: s3 location of the jar
example: reltio-modules/cleanse/custom-cleanse-functions-0.0.6.jar
options:
type: object
additionalProperties:
type: object
engineName:
type: string
description: Cleanse configuration object model
CrosswalkTO:
type: object
properties:
type:
type: string
description: Source system type
example: configuration/sources/SDS
value:
type: string
description: ID of a record in a source system
example: '10000007'
sourceTable:
type: string
description: Name of a table for a record in a source system
example: UserDataTable
url:
type: string
description: URL of crosswalk
example: http://example.com
createDate:
type: string
description: Create Date of crosswalk
format: date-time
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 997000000
year: 2017
monthValue: 10
dayOfMonth: 5
hour: 18
minute: 7
second: 32
month: OCTOBER
dayOfWeek: THURSDAY
dayOfYear: 278
updateDate:
type: string
description: Update Date of crosswalk
format: date-time
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 997000000
year: 2017
monthValue: 10
dayOfMonth: 5
hour: 18
minute: 7
second: 32
month: OCTOBER
dayOfWeek: THURSDAY
dayOfYear: 278
reltioLoadDate:
type: string
description: Load Date to "Reltio" of crosswalk
format: date-time
readOnly: true
example:
offset:
totalSeconds: 0
id: Z
rules:
fixedOffset: true
nano: 368000000
year: 2018
monthValue: 10
dayOfMonth: 15
hour: 5
minute: 26
second: 13
month: OCTOBER
dayOfWeek: MONDAY
dayOfYear: 288
deleteDate:
type: string
description: Delete Date of crosswalk
example: '2019-10-15T05:26:13.368Z'
crosswalkExternalInfo:
$ref: '#/components/schemas/CrosswalkExternalInfo'
singleAttributeUpdateDates:
type: object
additionalProperties:
type: string
description: >-
This field of crosswalk contains update date for specific
attributes.
readOnly: true
example: >-
{"{entities|relations}/khOIjHK/attributes/FirstName/JLKhIU":"2018-10-14T09:53:38.317Z","{entities|relations}/khOIjHK/attributes/LastName/LKJhLMk":"2018-10-14T09:53:38.317Z"}
attributes:
type: array
description: Set of attributes of this crosswalk
readOnly: true
example: |-
["{entities|relations}/khOIjHK/attributes/FirstName/JLKhIU",
"{entities|relations}/khOIjHK/attributes/LastName/LKJhLMk"]
items:
type: string
dataProvider:
type: boolean
description: >-
This field determines if this crosswalk is data provider. Default is
true
example: true
uri:
type: string
description: Unique URI of Crosswalk
readOnly: true
example: '{entities|relations}/Bco79gB/crosswalks/Q3hbdpb9'
description: Crosswalks of object
RelationAttributeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
CircuitBreakerCallback:
type: object
IS3HelperFactory:
type: object
InMemoryEntitiesSplitter:
type: object
ILookupsDAO:
type: object
GoogleCredentials:
type: object
properties:
expirationMargin:
$ref: '#/components/schemas/Duration'
refreshMargin:
$ref: '#/components/schemas/Duration'
lock:
type: object
value:
$ref: '#/components/schemas/OAuthValue'
source:
type: string
name:
type: string
universeDomain:
type: string
isExplicitUniverseDomain:
type: boolean
quotaProjectId:
type: string
PotentialMatchesDAO:
type: object
properties:
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
provider:
$ref: '#/components/schemas/IMatchDAOsProvider'
matchDeltaClustersEvaluatorFactory:
$ref: '#/components/schemas/MatchDeltaClustersEvaluatorFactory'
operationStateProvider:
$ref: '#/components/schemas/IOperationStateProvider'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
DataModelerConstraints:
type: object
properties:
maxAttributesCount:
type: integer
format: int32
maxReferenceAttributesCount:
type: integer
format: int32
maxPercentOfNestedAttributesCount:
type: integer
format: int32
maxNestedSubAttributesCount:
type: integer
format: int32
maxNestedAttributesDepth:
type: integer
format: int32
allowDataTypeOverRiding:
type: boolean
allowReferenceAttrsInNestedAttrs:
type: boolean
maxRelationshipTypeBetweenTwoEntitiesCount:
type: integer
format: int32
allowReferenceAttrsInRelationshipAttrs:
type: boolean
checkForMatchRuleAttrsInSurrogateCrosswalk:
type: boolean
surrogateKeyRequired:
type: boolean
ICommonMultipleMetricsProvider:
type: object
IdentityMap:
type: object
properties:
size:
type: integer
format: int32
keyTable:
type: array
items:
type: object
valueTable:
type: array
items:
type: object
capacity:
type: integer
format: int32
stashSize:
type: integer
format: int32
loadFactor:
type: number
format: float
hashShift:
type: integer
format: int32
mask:
type: integer
format: int32
threshold:
type: integer
format: int32
stashCapacity:
type: integer
format: int32
pushIterations:
type: integer
format: int32
bigTable:
type: boolean
entries:
$ref: '#/components/schemas/Entries'
values:
$ref: '#/components/schemas/Values'
keys:
$ref: '#/components/schemas/Keys'
IStorageVectorService:
type: object
SubtypeResolver:
type: object
DefaultSourceTypeNameProvider:
type: object
Charset:
type: object
properties:
name:
type: string
aliases:
type: array
items:
type: string
aliasSet:
uniqueItems: true
type: array
items:
type: string
ruleBasedAttributes:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
name:
type: string
description: Name of the rule
example: Rule 1
type:
type: string
description: Type of the rule, allowed value is conditional
example: Conditional
enum:
- Conditional
controlFunction:
$ref: '#/components/schemas/ruleBasedAttributesControlFunction'
IOException:
type: object
properties:
detailMessage:
type: string
cause:
$ref: '#/components/schemas/Throwable'
stackTrace:
type: array
items:
$ref: '#/components/schemas/StackTraceElement'
suppressedExceptions:
type: array
items:
$ref: '#/components/schemas/Throwable'
TenantId:
type: object
properties:
tenantId:
type: string
AWSLambdaClientProvider:
type: object
HistoryStorageConfigurator:
type: object
LoadingCacheEntryStringStringGoogleCredentials:
type: object
GoogleCloudStorageClientFactory:
type: object
properties:
credentials:
$ref: '#/components/schemas/GoogleCredentials'
configuration:
$ref: '#/components/schemas/Configuration'
LoadingCacheTokenCacheKeyCachedToken:
type: object
LoadingCacheStringIGenerator:
type: object
AtomicDouble:
type: object
HazelcastService:
type: object
properties:
clientStateMonitoringExecutor:
$ref: '#/components/schemas/ScheduledExecutorService'
clusterNamespace:
type: string
configuration:
$ref: '#/components/schemas/Configuration'
token:
type: string
hazelcastConfig:
$ref: '#/components/schemas/HazelcastConfig'
hazelcastInstance:
$ref: '#/components/schemas/TrackableHazelcastInstance'
backupHazelcastInstance:
$ref: '#/components/schemas/TrackableHazelcastInstance'
primaryHazelcastClientInitializedOnce:
type: boolean
backupHazelcastClientInitializedOnce:
type: boolean
shutdown:
type: boolean
shutdownLock:
$ref: '#/components/schemas/Lock'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
clientStateMetricProvider:
$ref: '#/components/schemas/ICommonMultipleMetricsProvider'
clientProvider:
$ref: '#/components/schemas/IHazelcastInstanceProviderClientConfig'
primaryHazelcastClientListeners:
type: array
items:
$ref: '#/components/schemas/LifecycleListener'
backupHazelcastClientListeners:
type: array
items:
$ref: '#/components/schemas/LifecycleListener'
primaryHazelcastInstanceState:
$ref: '#/components/schemas/HazelcastInstanceState'
backupHazelcastInstanceState:
$ref: '#/components/schemas/HazelcastInstanceState'
hazelcastLockerAccess:
$ref: '#/components/schemas/HazelcastLockerAccess'
hazelcastCounterFactory:
$ref: '#/components/schemas/HazelcastCounterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
platformsAccess:
$ref: '#/components/schemas/IPlatformsAccess'
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
currentUniquePlatformNodeKey:
type: string
longLocksMonitoringService:
$ref: '#/components/schemas/LongLocksMonitoringService'
InteractionsDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
AppenderAttachableImpl:
type: object
properties:
appenderList:
type: array
items:
$ref: '#/components/schemas/Appender'
SimpleMixInResolver:
type: object
properties:
_overrides:
$ref: '#/components/schemas/MixInResolver'
_localMixIns:
type: object
CleanseInfo:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
mappings:
type: array
description: >-
Contains information about the common input and output mappings for
the cleanse functions. These mappings may be used inside the cleanse
infos. Input mapping determines the attributes that are collected
from an entity of the cleanse function
items:
$ref: '#/components/schemas/CleanseAttributeMappings'
infos:
type: array
description: >-
Infos specify the format or manner in which the input and output
mappings are configured for data cleanse
items:
$ref: '#/components/schemas/CleanseInfoSequence'
addressAutoCompleteConfig:
$ref: '#/components/schemas/AddressAutoCompleteMappingConfig'
attributeVerificationConfig:
type: array
description: Attribute verification mapping configuration list
items:
$ref: '#/components/schemas/AttributeVerificationMappingConfig'
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: Configuration of Cleanse Functions for Entity Types
SegmentationLimits:
type: object
properties:
maxLiveSegments:
type: integer
format: int32
maxBatchJobsPerDay:
type: integer
format: int32
maxConcurrentRunningJobs:
type: integer
format: int32
maxNumberOfAttributesInRule:
type: integer
format: int32
PhantomSplitter:
type: object
properties:
detailOperationLogger:
$ref: '#/components/schemas/Logger'
logger:
$ref: '#/components/schemas/Logger'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
mergeTreeService:
$ref: '#/components/schemas/MergeTreeService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
crudService:
$ref: '#/components/schemas/CRUDService'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationServiceObjectObject'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
useCassandraTransactions:
type: boolean
mergeTreeRecordParser:
$ref: '#/components/schemas/MergeTreeRecordParser'
marshaller:
$ref: '#/components/schemas/IMarshaller'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
EntitiesService:
type: object
properties:
dao:
$ref: '#/components/schemas/EntitiesDAO'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
objectChangesProcessor:
$ref: '#/components/schemas/IObjectChangesProcessorEntityTO'
postponedChangesThreadLocal:
$ref: '#/components/schemas/ThreadLocalPostponedChangesEntityTO'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
entitySegmentationDAOProvider:
$ref: '#/components/schemas/FunctionTenantIdIEntitySegmentationDAO'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
Sync:
type: object
properties:
state:
type: integer
format: int32
IPeriodicTaskFactory:
type: object
EntityTypeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
WeakReferenceThreadGroup:
type: object
properties:
referent:
$ref: '#/components/schemas/ThreadGroup'
queue:
$ref: '#/components/schemas/ReferenceQueueObject'
next:
$ref: '#/components/schemas/Reference'
MemorySegment:
type: object
MessagingDestination:
type: object
properties:
type:
type: string
enum:
- topic
- queue
- exchange
provider:
type: string
name:
type: string
dtssQueue:
type: boolean
groupingQueue:
type: boolean
dataPipelineQueue:
type: boolean
systemEventsQueue:
type: boolean
enabled:
type: boolean
typeFilter:
type: array
items:
type: string
awsAccountId:
type: string
objectFilter:
type: string
format:
type: string
enum:
- JSON
- JSON_ZIP_BASE64
- KRYO
jmsEventsFilteringFields:
uniqueItems: true
type: array
items:
type: string
relationEventsFilteringFields:
uniqueItems: true
type: array
items:
type: string
skipPayload:
type: boolean
eventsTimeToLive:
type: integer
format: int64
jmsIncludeMergeTime:
type: boolean
analyzeOvChanges:
type: boolean
emptyStartEndRelationCrosswalks:
type: boolean
largeObjectsSupport:
type: boolean
payloadType:
type: string
enum:
- SNAPSHOT
- DELTAS
- SNAPSHOT_WITH_DELTA
ovOnly:
type: boolean
ignoreReferenceUpdateEvents:
type: boolean
AutoGenerationServiceObjectObject:
type: object
properties:
entitiesService:
$ref: '#/components/schemas/EntitiesService'
idGeneratorService:
$ref: '#/components/schemas/IdGeneratorService'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
metadataService:
$ref: '#/components/schemas/MetadataService'
environmentName:
type: string
LifeCycleActionsExtractor:
type: object
properties:
systemLifecycleService:
type: string
ReadOnlyClassToSerializerMap:
type: object
properties:
_buckets:
type: array
items:
$ref: '#/components/schemas/Bucket'
_size:
type: integer
format: int32
_mask:
type: integer
format: int32
ESIndexController:
type: object
ResourceBundle:
type: object
properties:
parent:
$ref: '#/components/schemas/ResourceBundle'
locale:
$ref: '#/components/schemas/Locale'
name:
type: string
expired:
type: boolean
cacheKey:
$ref: '#/components/schemas/CacheKey'
keySet:
uniqueItems: true
type: array
items:
type: string
CassandraConfigMapping:
type: object
properties:
database:
type: string
keyspaceName:
type: string
tenantId:
type: string
localDataCenter:
type: string
host:
type: string
backupDataCenter:
type: string
clusterName:
type: string
replicationFactor:
type: integer
format: int32
cassandraVersion:
type: string
cassandraLogin:
type: string
cassandraPassword:
type: string
fetchBufferSize:
type: integer
format: int32
readConsistency:
type: string
writeConsistency:
type: string
executorFactory:
type: string
executorProtocolVersion:
type: string
maxInsertSizeInMb:
type: integer
format: int32
tableVersion:
type: string
ttl:
type: integer
format: int64
daoVersion:
type: string
hdsUri:
type: string
bigTableProjectId:
type: string
bigTableInstanceId:
type: string
bigTableClusterName:
type: string
bigTableZoneName:
type: string
smartConsistencyLevelEndTime:
type: integer
format: int64
MatchAssetsLowLevelConfiguration:
type: object
properties:
detailedTracing:
type: boolean
EntityAnalyticsAttributesDAO:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
ExceptionLogSamplingStrategy:
type: object
IDUtils:
type: object
AnalyticsAttributesService:
type: object
properties:
lookupsServiceInterface:
$ref: '#/components/schemas/LookupsServiceInterface'
analyticsAttributesDAO:
$ref: '#/components/schemas/EntityAnalyticsAttributesDAO'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
LifeCycleActionGoogleFunctionClient:
type: object
properties:
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
googleFunctionAuthenticator:
$ref: '#/components/schemas/GoogleFunctionAuthenticator'
configuration:
$ref: '#/components/schemas/Configuration'
httpClientCache:
$ref: '#/components/schemas/CacheIntegerApacheV5HttpClient'
httpClientName:
type: string
encryptionEngine:
$ref: '#/components/schemas/IEncryptionEngine'
LocalizablePatternHolder:
type: object
properties:
pattern:
type: string
localizer:
$ref: '#/components/schemas/IReltioBusinessModelLocalizer'
localizations:
type: object
additionalProperties:
type: string
TenantsConfigurationDefaultValuesProvider:
type: object
properties:
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
configuration:
$ref: '#/components/schemas/Configuration'
elasticsearchUserManagementService:
$ref: '#/components/schemas/IElasticsearchUserManagementService'
ConfigurationHistoryDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
marshaller:
$ref: '#/components/schemas/IMarshaller'
historyTOFactory:
$ref: >-
#/components/schemas/HistoryTOFactoryReltioBusinessModelConfigurationHistorySnapshotTO
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
historyStorageConfigurator:
$ref: '#/components/schemas/HistoryStorageConfigurator'
BiPredicateObjectThrowable:
type: object
Gbq:
type: object
properties:
ovOnly:
type: boolean
IGroupsDAO:
type: object
TenantEventQueuesConfiguration:
type: object
properties:
crud:
$ref: '#/components/schemas/TenantEventQueueProcessors'
match:
$ref: '#/components/schemas/TenantEventQueueProcessors'
InternalMatchCRUDServiceEventsProcessor:
type: object
properties:
internalMatchService:
$ref: '#/components/schemas/InternalMatchService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
matchingConfigurationFactorsCache:
$ref: '#/components/schemas/MatchingConfigurationFactorsCache'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
compactingExceptionLogger:
$ref: '#/components/schemas/CompactingExceptionLogger'
UncaughtExceptionHandler:
type: object
CacheStringInteger:
type: object
HazelcastLockHeartbeat:
type: object
properties:
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
isAliveCache:
$ref: '#/components/schemas/CacheStringPairBooleanLong'
cacheLocker:
$ref: '#/components/schemas/SimpleLockerString'
lastLockTimeTrack:
type: integer
format: int64
lock:
$ref: '#/components/schemas/Lock'
LifeCycleActionLambdaExecutor:
type: object
properties:
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
invoker:
$ref: '#/components/schemas/ResilientLambdaInvoker'
CrosswalkExternalInfo:
type: object
properties:
dtssInfo:
$ref: '#/components/schemas/DTSSInfo'
description: >-
Additional information of crosswalk. This information is filled by
Reltio services like DTSS.
SerializerFactory:
type: object
Continuation:
type: object
properties:
target:
$ref: '#/components/schemas/Runnable'
scope:
$ref: '#/components/schemas/ContinuationScope'
parent:
$ref: '#/components/schemas/Continuation'
child:
$ref: '#/components/schemas/Continuation'
tail:
$ref: '#/components/schemas/StackChunk'
done:
type: boolean
mounted:
type: boolean
yieldInfo:
type: object
preempted:
type: boolean
scopedValueCache:
type: array
items:
type: object
CharsetDecoder:
type: object
properties:
charset:
$ref: '#/components/schemas/Charset'
averageCharsPerByte:
type: number
format: float
maxCharsPerByte:
type: number
format: float
replacement:
type: string
malformedInputAction:
$ref: '#/components/schemas/CodingErrorAction'
unmappableCharacterAction:
$ref: '#/components/schemas/CodingErrorAction'
state:
type: integer
format: int32
MessageFormat:
type: object
properties:
locale:
$ref: '#/components/schemas/Locale'
pattern:
type: string
formats:
type: array
items:
$ref: '#/components/schemas/Format'
offsets:
type: array
items:
type: integer
format: int32
argumentNumbers:
type: array
items:
type: integer
format: int32
maxOffset:
type: integer
format: int32
IMailSender:
type: object
ILockerString:
type: object
MatchingStatisticsStorageConfiguration:
type: object
properties:
enabled:
type: boolean
namespace:
type: string
statistics:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/StatisticDefinition'
ActivityLogEventManager:
type: object
properties:
activityLogService:
$ref: '#/components/schemas/ActivityLogService'
ServiceStat:
type: object
properties:
totalTime:
$ref: '#/components/schemas/AtomicLong'
invocationsCount:
$ref: '#/components/schemas/AtomicInteger'
RetryPolicy:
type: object
properties:
delay:
$ref: '#/components/schemas/Duration'
delayFactor:
type: number
format: double
jitter:
$ref: '#/components/schemas/Duration'
jitterFactor:
type: number
format: double
maxDelay:
$ref: '#/components/schemas/Duration'
maxDuration:
$ref: '#/components/schemas/Duration'
maxRetries:
type: integer
format: int32
failuresChecked:
type: boolean
retryConditions:
type: array
items:
$ref: '#/components/schemas/BiPredicateObjectThrowable'
abortConditions:
type: array
items:
$ref: '#/components/schemas/BiPredicateObjectThrowable'
InteractionCassandraWriter:
type: object
properties:
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
SupplementalMatchingStructuresProviderImpl:
type: object
properties:
tenantConfigurationProvider:
$ref: '#/components/schemas/TenantConfigurationProvider'
compiledMatchGroupsCache:
$ref: '#/components/schemas/CompiledMatchGroupsCache'
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchTokenFactory:
$ref: '#/components/schemas/MatchTokenFactory'
RelationAnalyticsAttributesService:
type: object
properties:
relationAnalyticsAttributesDAO:
$ref: '#/components/schemas/RelationAnalyticsAttributesDAO'
AwsEncryptionConfig:
type: object
properties:
dynamoDBEncryptionConfig:
$ref: '#/components/schemas/DynamoDBEncryptionConfig'
awsBackupConfig:
$ref: '#/components/schemas/AwsBackupConfig'
EventPublishService:
type: object
properties:
publishingMemoryThreshold:
type: integer
format: int64
publishExecutor:
$ref: '#/components/schemas/ExecutorService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
applicationContext:
$ref: '#/components/schemas/ApplicationContext'
activityLogEventManager:
$ref: '#/components/schemas/ActivityLogEventManager'
crudHubService:
$ref: '#/components/schemas/CRUDEventHubService'
FunctionReltioEventBaseObjectEventKey:
type: object
ICustomerDatabaseConfigDAO:
type: object
IUserPreferencesDAO:
type: object
MatchExplainer:
type: object
properties:
matchStorage:
$ref: '#/components/schemas/MatchStorage'
tokenFactory:
$ref: '#/components/schemas/MatchTokenFactory'
matchActionTypeEvaluator:
$ref: '#/components/schemas/IMatchActionTypeEvaluator'
readOnlyMatchingServiceBase:
$ref: '#/components/schemas/ReadOnlyMatchingServiceBase'
ChangeRequestService:
type: object
properties:
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
objectTOSliceService:
$ref: '#/components/schemas/ObjectTOSliceService'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
lifeCycleActionsService:
$ref: '#/components/schemas/ILifeCycleActionsService'
metadataService:
$ref: '#/components/schemas/MetadataService'
objectsModificationService:
$ref: '#/components/schemas/ObjectsModificationService'
accessChecker:
$ref: '#/components/schemas/AccessChecker'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
tenantsInfoProvider:
$ref: '#/components/schemas/ITenantsInfoProvider'
mergeSplitServiceProvider:
$ref: '#/components/schemas/MergeSplitServiceProvider'
crudServiceProvider:
$ref: '#/components/schemas/CRUDServiceProvider'
ReltioPermissionManager:
type: object
HazelcastInstanceState:
type: object
properties:
lifecycleState:
type: string
enum:
- STARTING
- STARTED
- SHUTTING_DOWN
- SHUTDOWN
- MERGING
- MERGED
- MERGE_FAILED
- CLIENT_CONNECTED
- CLIENT_DISCONNECTED
- CLIENT_CHANGED_CLUSTER
connected:
type: boolean
name:
type: string
isAsync:
type: boolean
lastConnectionModeChange:
type: integer
format: int64
onShutdown:
$ref: '#/components/schemas/Runnable'
onShuttingDown:
$ref: '#/components/schemas/Runnable'
isTestMode:
type: boolean
ReentrantLock:
type: object
properties:
sync:
$ref: '#/components/schemas/Sync'
LifeCycleActionsService:
type: object
properties:
internalTokenValidity:
type: integer
format: int64
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
platformRemoteTokenService:
$ref: '#/components/schemas/IPlatformRemoteTokenService'
lambdaExecutor:
$ref: '#/components/schemas/LifeCycleActionLambdaExecutor'
lifeCycleRestClientFactory:
$ref: '#/components/schemas/LifeCycleRestClientFactory'
userRoleAccess:
$ref: '#/components/schemas/UserRoleAccess'
permissionsService:
$ref: '#/components/schemas/PermissionsService'
apiErrorFactory:
$ref: '#/components/schemas/APIErrorFactoryInterface'
lifecycleActionsExtractor:
$ref: '#/components/schemas/LifeCycleActionsExtractor'
configuration:
$ref: '#/components/schemas/Configuration'
executorService:
$ref: '#/components/schemas/ExecutorService'
authenticationProvider:
$ref: '#/components/schemas/IAuthenticationProvider'
objectMapperProvider:
$ref: '#/components/schemas/ObjectMapperProvider'
objectBatchSize:
type: integer
format: int32
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
lookupService:
$ref: '#/components/schemas/LookupsServiceInterface'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
eventPublishService:
$ref: '#/components/schemas/IEventPublishService'
defaultNativeLCATimeout:
type: integer
format: int32
lcaLoggingEnabledTenants:
uniqueItems: true
type: array
items:
type: string
googleFunctionClient:
$ref: '#/components/schemas/LifeCycleActionGoogleFunctionClient'
azureFunctionClient:
$ref: '#/components/schemas/LifeCycleActionAzureFunctionClient'
IDynamoDBMetricsCollectorFactory:
type: object
ITargetSourceResolver:
type: object
SurvivorshipGroupMapping:
required:
- attribute
- survivorshipStrategyString
- survivorshipStrategy
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attribute:
type: string
description: uri of attribute for which OV values are calculating
example: configuration/entityTypes/Individual/attributes/FirstName
sortAs:
type: string
description: >-
Defines type of data that will be used for calculation of min/max
value for MinMax OV strategy
example: int
enum:
- '[''number'''
- '''boolean'''
- '''dollar'''
- '''long'''
- '''int'''
- '''integer'''
- '''float'''
- '''double'''
- '''date'''
- '''time'''
- '''timestamp'''
- '''blob'''
- '''string'']'
sourcesUriOrder:
type: array
description: >-
Ordered list of sources. Used in SRC_SYS strategy and override such
parameter defined in current survivorship group
example: >-
['configuration/sources/ReltioCleanser', 'configuration/sources/FB',
'configuration/sources/Twitter']
items:
type: string
valuesPriorityOrder:
type: array
description: Ordered list of values. Used in ValuesPriorityOrder strategy
example: '[''Bart'', ''Donald'', ''Joe'']'
items:
type: string
lookupComparisonField:
type: string
description: >-
Single lookup resolution type. Used in ValueBasedPriority strategy
to determine which lookup value to use for comparison. Possible
values: lookupCode, lookupValue, lookupRawValue
example: lookupCode
enum:
- lookupCode
- lookupValue
- lookupRawValue
sourcesForOv:
uniqueItems: true
type: array
description: >-
List of sources which may be OV. The sources which aren't included
in this list will be ignored
example: '[''configuration/sources/Reltio'', ''configuration/sources/FB'''
items:
type: string
comparisonAttributeUri:
type: string
description: >-
Uri of simple attribute, child of nested/reference attribute, used
for comparison in MinValue, MaxValue, Frequency strategies only
example: configuration/entityTypes/Location/attributes/Zip/attributes/Zip4
comparisonAttributeOvOnly:
type: boolean
description: >-
Defines if only OV values of subnested attribute defined as
comparisonAttributeUri should be used. This setting is applicable in
MinValue, MaxValue, Frequency strategies only. If false, all values
are used for comparison, if true - only OV values are used. Default
is false
example: true
primaryAttributeUri:
type: string
description: >-
Uri of simple attribute, used in OtherAttributeWinnerCrosswalk
strategy.It gets all winner crosswalks from this primary attribute.
If the current value has any crosswalk as primary attribute's winner
crosswalks, all of them and all values provided by them become
winners
example: configuration/entityTypes/Location/attributes/AddressLine1
filter:
$ref: '#/components/schemas/SurvivorshipGroupMappingFilter'
fallbackStrategies:
type: array
description: >-
List of survivorship strategy mappings to be applied to current
attribute values if 'fallbackUsingCriteria' met condition
items:
$ref: '#/components/schemas/SurvivorshipGroupMapping'
fallbackUsingCriteria:
type: string
description: >-
Defines condition when 'fallbackStrategies' are applied to attribute
values
example: MORE_THAN_ONE
enum:
- '[''MORE_THAN_ONE'''
- '''ZERO_OR_MORE_THAN_ONE'''
- '''ZERO'']'
ignoreCase:
type: boolean
description: >-
If true, string comparisons are case-insensitive. Applicable to
strategies that compare string values (ValueBasedPriority,
Frequency, MinValue/MaxValue when sortAs='string'). Default is false
example: true
survivorshipStrategy:
type: string
description: Name of survivorship strategy used for calculation
example: SRC_SYS
description: >-
Allows to specify survivorship strategy used to calculate operation
value (OV) for particular attribute. Survivorship rules are defined for
object attributes by survivorship mappings. All rules are defined
separately for each attribute and are calculated independently of each
other
EntitiesDAO:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
metricsCollector:
$ref: '#/components/schemas/IDAOMetricsCollector'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
analyticsAttributesDAO:
$ref: '#/components/schemas/EntityAnalyticsAttributesDAO'
metadataService:
$ref: '#/components/schemas/MetadataService'
changeRequestDAO:
$ref: '#/components/schemas/ChangeRequestDAO'
ObjectTO:
type: object
properties:
type:
type: string
description: Type of Object
example: configuration/{entityTypes|relationTypes}/Object
crosswalks:
uniqueItems: true
type: array
description: Crosswalks of object
items:
$ref: '#/components/schemas/CrosswalkTO'
createdBy:
type: string
description: >-
Identifier of user created this object. This field is filled in
automatically.
readOnly: true
example: somebody@example.com
updatedBy:
type: string
description: >-
Identifier of user updated this object. This field is filled in
automatically.
readOnly: true
example: somebody@example.com
createdTime:
type: integer
description: >-
Time of creation of this object (Timestamp). This field is filled in
automatically.
format: int64
readOnly: true
example: 1599015741719
updatedTime:
type: integer
description: >-
Time of update of this object (Timestamp). This field is filled in
automatically.
format: int64
readOnly: true
example: 1599015741719
activenessStartInternalMap:
type: object
additionalProperties:
type: integer
format: int64
activenessEndInternalMap:
type: object
additionalProperties:
type: integer
format: int64
attributes:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of object
nullable: true
readOnly: false
writeOnly: false
extensions: {}
uri:
type: string
description: Unique identifier of Object
readOnly: true
example: '{entities|relations}/Bco79gB'
description: Base object model of EntityTO, RelationTO
discriminator:
propertyName: type
CategoriesService:
type: object
properties:
categoriesDAO:
$ref: '#/components/schemas/CategoriesDAO'
metadataService:
$ref: '#/components/schemas/MetadataService'
SurvivorshipGroupMappingFilter:
required:
- equals
type: object
properties:
equals:
type: array
description: List of 'equals' filtering criteria
items:
$ref: '#/components/schemas/FilterEqualsCriteria'
ne:
type: array
description: List of 'not equals' filtering criteria
items:
$ref: '#/components/schemas/FilterNotEqualsCriteria'
lt:
type: array
description: List of 'less' filtering criteria
items:
$ref: '#/components/schemas/FilterLessCriteria'
lte:
type: array
description: List of 'less or equals' filtering criteria
items:
$ref: '#/components/schemas/FilterLessOrEqualCriteria'
gt:
type: array
description: List of 'great' filtering criteria
items:
$ref: '#/components/schemas/FilterGreaterCriteria'
gte:
type: array
description: List of 'great or equal' filtering criteria
items:
$ref: '#/components/schemas/FilterGreaterOrEqualCriteria'
missing:
type: array
description: List of 'missing' filtering criteria
items:
$ref: '#/components/schemas/FilterMissingCriteria'
exists:
type: array
description: List of 'exists' filtering criteria
items:
$ref: '#/components/schemas/FilterExistsCriteria'
in:
type: array
description: List of 'in' filtering criteria
items:
$ref: '#/components/schemas/FilterInCriteria'
notIn:
type: array
description: List of 'not in' filtering criteria
items:
$ref: '#/components/schemas/FilterNotInCriteria'
or:
type: array
description: List of 'or condition' filtering criteria
items:
$ref: '#/components/schemas/OrCondition'
and:
type: array
description: List of 'and condition' filtering criteria
items:
$ref: '#/components/schemas/AndCondition'
discardIgnoredDeletedValues:
type: boolean
description: >-
Boolean value, specify true if you want to discard ignored and
end-dated crosswalk values
example: true
description: >-
Defines list of filtering rules applies to values set. The value should
meet all rules conditions in this list.In other words: each
FilterEqualsCriteria combined in the filter by 'AND'
CodeSource:
type: object
properties:
location:
type: string
format: url
IAnalyticAttributesDAOIRelationURI:
type: object
IMatchService:
type: object
ReltioBusinessModelReference:
type: object
AtomicReferenceIMergeSplitService:
type: object
properties:
value:
$ref: '#/components/schemas/IMergeSplitService'
Level:
type: object
IBusinessObjectsServiceMetricCollector:
type: object
GoogleCredentialsProvider:
type: object
properties:
credentialsCache:
$ref: '#/components/schemas/LoadingCacheEntryStringStringGoogleCredentials'
cloudPlatformScope:
type: string
gcpCredentialsLifetimeSeconds:
type: integer
format: int32
MetricsServiceFactory:
type: object
properties:
environment:
type: string
predefinedLabels:
type: object
additionalProperties:
type: string
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
ReadOnlyMatchingService:
type: object
properties:
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchGroupsConverter:
$ref: '#/components/schemas/MatchGroupsConverter'
matchStorage:
$ref: '#/components/schemas/MatchStorage'
commonAssetsStorage:
$ref: '#/components/schemas/CommonAssetsStorage'
matcher:
$ref: '#/components/schemas/MatcherMatchGroupSpecification'
optionsFunction:
$ref: '#/components/schemas/FunctionTenantIdMatchOptions'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
ignoreMatchMethodApplicability:
type: boolean
AllContributorsSplitter:
type: object
properties:
detailOperationLogger:
$ref: '#/components/schemas/Logger'
logger:
$ref: '#/components/schemas/Logger'
operationWrapper:
$ref: '#/components/schemas/IOperationWrapper'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
entitiesMergeTreeDAO:
$ref: '#/components/schemas/EntitiesMergeTreeDAO'
lifeCycleActionsService:
$ref: '#/components/schemas/LifeCycleActionsService'
mergeTreeService:
$ref: '#/components/schemas/MergeTreeService'
categoriesService:
$ref: '#/components/schemas/CategoriesService'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
analyticsAttributesService:
$ref: '#/components/schemas/AnalyticsAttributesService'
potentialMatchesService:
$ref: '#/components/schemas/PotentialMatchesService'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
crudService:
$ref: '#/components/schemas/CRUDService'
cleanseService:
$ref: '#/components/schemas/ICleanseService'
tenantsConfigurationService:
$ref: '#/components/schemas/TenantsConfigurationService'
relationsService:
$ref: '#/components/schemas/RelationsService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
autoGenerationService:
$ref: '#/components/schemas/AutoGenerationServiceObjectObject'
readOnlyPotentialMatchesService:
$ref: '#/components/schemas/ReadOnlyPotentialMatchesService'
potentialMatchesDAO:
$ref: '#/components/schemas/PotentialMatchesDAO'
matchInfoProvider:
$ref: '#/components/schemas/MatchInfoProvider'
useCassandraTransactions:
type: boolean
mergeTreeRecordParser:
$ref: '#/components/schemas/MergeTreeRecordParser'
marshaller:
$ref: '#/components/schemas/IMarshaller'
commonAssetsService:
$ref: '#/components/schemas/CommonAssetsService'
TenantEventQueueProcessors:
type: object
properties:
type:
type: string
enum:
- CRUD
- MATCH
- IRS_EM
- IRS_COM
- DATA_PIPELINE
- GROUPING
- ACTIVITY_LOG
timestamp:
type: integer
format: int64
defaultProcessors:
type: array
items:
type: string
processors:
type: object
additionalProperties:
type: array
items:
type: string
processorsParams:
$ref: '#/components/schemas/EventQueueProcessorsParams'
previous:
$ref: '#/components/schemas/TenantEventQueueProcessors'
batchTimeout:
type: integer
format: int64
projectId:
type: string
azureConfig:
$ref: '#/components/schemas/AzureQueueConfig'
MetadataService:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
metadataInheritor:
$ref: '#/components/schemas/MetadataInheritor'
metadataCache:
$ref: '#/components/schemas/MetadataCache'
metadataStorage:
$ref: '#/components/schemas/IMetadataStorage'
tenantFilteringService:
$ref: '#/components/schemas/AbstractTenantFilteringService'
tenantDataProvider:
$ref: '#/components/schemas/ITenantDataProvider'
externalInfoProvider:
$ref: '#/components/schemas/IReltioBusinessModelExternalInfoProvider'
modelUpdateListeners:
type: array
items:
$ref: '#/components/schemas/ModelUpdateListener'
modelLoadedListeners:
type: array
items:
$ref: '#/components/schemas/ModelLoadedListener'
modelUpdater:
$ref: '#/components/schemas/ScheduledExecutorService'
globalLastModifiedDate:
type: integer
format: int64
globalLastModifiedDateLoadTime:
type: integer
format: int64
globalLastModifiedDateIsUpdating:
type: boolean
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
matchingConfigurationCache:
$ref: '#/components/schemas/MatchingConfigurationCache'
unclassifiedInteractions:
type: object
additionalProperties:
$ref: '#/components/schemas/UnclassifiedInteractionType'
FunctionTenantIdIndexOvStrategy:
type: object
ContextAttributes:
type: object
SupplierRemoteEventSerializationHelperCRUDServiceEvent:
type: object
IOperationsMonitoringService:
type: object
ThreadLocalStringBuilderWriter:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
MetricsCollector:
type: object
properties:
activityMap:
type: object
additionalProperties:
$ref: '#/components/schemas/DestinationActivity'
connectErrors:
type: array
items:
$ref: '#/components/schemas/ErrorSummary'
lastError:
$ref: '#/components/schemas/AtomicLong'
Pattern:
type: object
properties:
pattern:
type: string
flags:
type: integer
format: int32
ObjectTOSliceService:
type: object
properties:
generateNewAttributeIds:
type: boolean
Reference:
type: object
properties:
referent:
type: object
next:
$ref: '#/components/schemas/Reference'
ReltioLifecycleProcessor:
type: object
properties:
logger:
$ref: '#/components/schemas/Log'
concurrentStartupForPhases:
type: object
additionalProperties:
type: integer
format: int64
timeoutsForShutdownPhases:
type: object
additionalProperties:
type: integer
format: int64
timeoutPerShutdownPhase:
type: integer
format: int64
running:
type: boolean
beanFactory:
$ref: '#/components/schemas/ConfigurableListableBeanFactory'
stoppedBeans:
uniqueItems: true
type: array
items:
type: string
cracResource:
type: object
parent:
$ref: '#/components/schemas/ConfigurableListableBeanFactory'
Thread:
type: object
properties:
eetop:
type: integer
format: int64
tid:
type: integer
format: int64
name:
type: string
interrupted:
type: boolean
contextClassLoader:
$ref: '#/components/schemas/ClassLoader'
inheritedAccessControlContext:
$ref: '#/components/schemas/AccessControlContext'
holder:
$ref: '#/components/schemas/FieldHolder'
threadLocals:
$ref: '#/components/schemas/ThreadLocalMap'
inheritableThreadLocals:
$ref: '#/components/schemas/ThreadLocalMap'
scopedValueBindings:
type: object
interruptLock:
type: object
parkBlocker:
type: object
nioBlocker:
$ref: '#/components/schemas/Interruptible'
cont:
$ref: '#/components/schemas/Continuation'
uncaughtExceptionHandler:
$ref: '#/components/schemas/UncaughtExceptionHandler'
threadLocalRandomSeed:
type: integer
format: int64
threadLocalRandomProbe:
type: integer
format: int32
threadLocalRandomSecondarySeed:
type: integer
format: int32
container:
$ref: '#/components/schemas/ThreadContainer'
headStackableScopes:
$ref: '#/components/schemas/StackableScope'
GraphService:
type: object
properties:
dao:
$ref: '#/components/schemas/GraphsDAO'
lookupsService:
$ref: '#/components/schemas/LookupsServiceInterface'
tenantsConfigurationService:
$ref: '#/components/schemas/ITenantsInfoProvider'
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
objectChangesProcessor:
$ref: '#/components/schemas/IObjectChangesProcessorObjectTO'
postponedChangesThreadLocal:
$ref: '#/components/schemas/ThreadLocalPostponedChangesObjectTO'
graphsDAO:
$ref: '#/components/schemas/GraphsDAO'
logger:
$ref: '#/components/schemas/Logger'
userPreferencesService:
$ref: '#/components/schemas/UserPreferencesService'
relationsService:
$ref: '#/components/schemas/RelationsService'
entitiesService:
$ref: '#/components/schemas/EntitiesService'
metadataService:
$ref: '#/components/schemas/MetadataService'
businessObjectsService:
$ref: '#/components/schemas/BusinessObjectsService'
groupService:
$ref: '#/components/schemas/GroupService'
marshaller:
$ref: '#/components/schemas/IMarshaller'
maxEntitiesToLoadForLimitedGraphDefault:
type: integer
format: int32
configuration:
$ref: '#/components/schemas/Configuration'
searchService:
$ref: '#/components/schemas/StorageSearch'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
StorageSearch:
type: object
ActivityCount:
type: object
properties:
consumed:
$ref: '#/components/schemas/LongAdder'
failedConsume:
$ref: '#/components/schemas/LongAdder'
published:
$ref: '#/components/schemas/LongAdder'
retryPublish:
$ref: '#/components/schemas/LongAdder'
failedPublish:
$ref: '#/components/schemas/LongAdder'
failedSerialize:
$ref: '#/components/schemas/LongAdder'
failedDeserialize:
$ref: '#/components/schemas/LongAdder'
maxWaitTime:
$ref: '#/components/schemas/LongAdder'
maxProcessTime:
$ref: '#/components/schemas/LongAdder'
totalWaitTime:
$ref: '#/components/schemas/LongAdder'
totalProcessTime:
$ref: '#/components/schemas/LongAdder'
totalProcessed:
$ref: '#/components/schemas/LongAdder'
totalPublishTime:
$ref: '#/components/schemas/LongAdder'
totalConsumeTime:
$ref: '#/components/schemas/LongAdder'
bytesSent:
$ref: '#/components/schemas/LongAdder'
bytesReceived:
$ref: '#/components/schemas/LongAdder'
batchesPublished:
$ref: '#/components/schemas/LongAdder'
batchesConsumed:
$ref: '#/components/schemas/LongAdder'
ReferenceAttributeValueTOSerializer:
type: object
ThreadLocalObjectMapper:
type: object
properties:
threadLocalHashCode:
type: integer
format: int32
MetadataServiceFactory:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
eventPublishService:
$ref: '#/components/schemas/EventPublishService'
metadataService:
$ref: '#/components/schemas/MetadataService'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
TenantsDataListener:
type: object
CategoriesServiceInterface:
type: object
AttributeVerificationConfig:
type: object
properties:
attributes:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeConfig'
IBigTableMetricsCollectorFactory:
type: object
HazelcastLockerAccess:
type: object
properties:
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
lockers:
type: object
additionalProperties:
$ref: '#/components/schemas/ILocker'
maxBlockTime:
type: integer
format: int64
environment:
type: string
lockVersion:
type: string
enum:
- LOCK_PER_KEY
- UNION_LOCK_FOR_KEYS
- LOCKS_V8
- NO_LOCKS
hazelcastConfig:
$ref: '#/components/schemas/HazelcastConfig'
hazelcastLockHeartbeat:
$ref: '#/components/schemas/HazelcastLockHeartbeat'
lockDetailedLoggingEnabled:
type: boolean
platformsInfo:
$ref: '#/components/schemas/IPlatformsInfo'
platformsSupplier:
$ref: '#/components/schemas/SupplierIPlatformsInfo'
FilterExistsCriteria:
required:
- uri
type: object
properties:
uri:
type: string
description: uri of attribute
example: configuration/entityTypes/Individual/attributes/FirstName
description: Defines 'exists' criteria
RelationshipTypeFilterModifier:
type: object
properties:
metadataService:
$ref: '#/components/schemas/MetadataService'
CassandraAuth:
type: object
properties:
user:
type: string
password:
type: string
DefaultDeserializationContext:
type: object
properties:
_cache:
$ref: '#/components/schemas/DeserializerCache'
_factory:
$ref: '#/components/schemas/DeserializerFactory'
_config:
$ref: '#/components/schemas/DeserializationConfig'
_featureFlags:
type: integer
format: int32
_injectableValues:
$ref: '#/components/schemas/InjectableValues'
_currentType:
$ref: '#/components/schemas/LinkedNodeJavaType'
_objectIdResolvers:
type: array
items:
$ref: '#/components/schemas/ObjectIdResolver'
AgentsConfig:
type: object
properties:
aiEnabled:
type: boolean
description: Enables/disables Agents for the tenant
example: true
agentFlowEnabled:
type: boolean
description: Enables/disables paid Agents for the tenant
example: true
traceEnabled:
type: boolean
description: Enables/disables tracing for Agents
example: true
description: Agents Configuration
IUnmarshallOptions:
type: object
ESClusterStatsFetcher:
type: object
ActivityLogService:
type: object
properties:
dao:
$ref: '#/components/schemas/ActivityDAO'
eventPublishService:
$ref: '#/components/schemas/IEventPublishServiceReltioEventBaseObject'
objectLabelFetcher:
$ref: '#/components/schemas/IObjectLabelFetcher'
activityLogEventPublisher:
$ref: '#/components/schemas/IActivityLogEventPublisher'
marshaller:
$ref: '#/components/schemas/IMarshaller'
activitySplitter:
$ref: '#/components/schemas/IActivitySplitter'
splitActivityJoiner:
$ref: '#/components/schemas/ISplitActivityJoiner'
tenantDataAccess:
$ref: '#/components/schemas/ITenantDataAccess'
defaultFillStoredLabels:
type: boolean
AccessToken:
type: object
properties:
tokenValue:
type: string
expirationTimeMillis:
type: integer
format: int64
scopes:
type: array
items:
type: string
SearchService:
type: object
properties:
reltioAPIPlatform:
$ref: '#/components/schemas/ReltioPlatform'
searchResultFetcher:
$ref: '#/components/schemas/SearchResultFetcher'
staticOVSearchFilterFactory:
$ref: '#/components/schemas/StaticOVSearchFilterFactory'
groupsOVSearchFilterFactory:
$ref: '#/components/schemas/GroupsOVSearchFilterFactory'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
IInteractionsDAO:
type: object
IDAOMetricsCollector:
type: object
HiddenTasks:
type: object
properties:
enabled:
type: boolean
dataSource:
type: string
path:
type: string
email:
type: string
maxSize:
type: integer
format: int64
clusterSize:
type: integer
format: int32
runInParallel:
type: boolean
CommonBusinessProcessToCassandraConverter:
type: object
properties:
logger:
$ref: '#/components/schemas/Logger'
StackableScope:
type: object
properties:
owner:
$ref: '#/components/schemas/Thread'
previous:
$ref: '#/components/schemas/StackableScope'
ReadOnlyMatchingServiceBase:
type: object
properties:
matchDocumentsConverter:
$ref: '#/components/schemas/MatchDocumentsConverter'
matchGroupsConverter:
$ref: '#/components/schemas/MatchGroupsConverter'
matchStorage:
$ref: '#/components/schemas/MatchStorage'
commonAssetsStorage:
$ref: '#/components/schemas/CommonAssetsStorage'
matcher:
$ref: '#/components/schemas/MatcherMatchGroupSpecification'
optionsFunction:
$ref: '#/components/schemas/FunctionTenantIdMatchOptions'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
ignoreMatchMethodApplicability:
type: boolean
TemplateLoader:
type: object
MemoryUsageService:
type: object
properties:
memoryUsageRedThreshold:
type: number
format: double
memoryUsageYellowThreshold:
type: number
format: double
threadStackAverageSizeInBytes:
type: integer
format: int64
useRssCriteria:
type: boolean
jmxBeanWrapper:
$ref: '#/components/schemas/JMXBeanWrapper'
runtimeWrapper:
$ref: '#/components/schemas/RuntimeWrapper'
containerMemoryLimit:
type: integer
format: int64
SupplierICleanseDictionaryServiceFactoryProvider:
type: object
TablePropertiesConfigMapping:
type: object
properties:
entitiesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
entitiesCompressedCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
entityMergeTreeCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
externalCrosswalkCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
relationsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
relationsOneHopsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
relationMergeTreeCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
relationsCompressedCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
externalRelationCrosswalkCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
businessProcessesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
changeRequestsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
changeRequestIndexCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
userPreferencesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
matchCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
matchDocumentsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
potentialMatchesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
autoMatchesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
notMatchCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
autoNotMatchesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
manuallyMarkedAsMatchCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
entityMatchesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
newInteractionsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
entityToInteractionsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
analyticsAttributesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
relationAnalyticsAttributesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
activitiesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
activitiesV2CF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
graphsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
categoriesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
categoryLinksCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
commonAssetsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
matchAssetsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
performanceIndexesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupingEntityAttributesCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupingEntityDocumentsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupingEntityToGroupsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupingMatchDocumentsCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
groupingMatchTokensCF:
$ref: '#/components/schemas/TablePropertiesConfiguration'
ISegmentAnalyticsAttributeUpdater:
type: object
ProviderResourceBundleProvider:
type: object
IActivitySplitter:
type: object
VectorizedAttributesProvider:
type: object
TableId:
type: object
properties:
project:
type: string
dataset:
type: string
table:
type: string
IndexingErrorsMonitoringService:
type: object
properties:
entries:
$ref: '#/components/schemas/CacheStringString'
enable:
type: boolean
Category:
type: object
properties:
name:
type: string
level:
$ref: '#/components/schemas/Level'
parent:
$ref: '#/components/schemas/Category'
resourceBundle:
$ref: '#/components/schemas/ResourceBundle'
repository:
$ref: '#/components/schemas/LoggerRepository'
aai:
$ref: '#/components/schemas/AppenderAttachableImpl'
additive:
type: boolean
CompactingExceptionLogger:
type: object
properties:
handlers:
type: array
items:
$ref: '#/components/schemas/ExceptionLogHandler'
CodingErrorAction:
type: object
properties:
name:
type: string
MatchTokenFactory:
type: object
properties:
matchingStatisticsStorage:
$ref: '#/components/schemas/MatchingStatisticsStorage'
AbstractSearchService:
type: object
properties:
reltioAPIPlatform:
$ref: '#/components/schemas/ReltioPlatform'
searchResultFetcher:
$ref: '#/components/schemas/SearchResultFetcher'
staticOVSearchFilterFactory:
$ref: '#/components/schemas/StaticOVSearchFilterFactory'
groupsOVSearchFilterFactory:
$ref: '#/components/schemas/GroupsOVSearchFilterFactory'
objectSearchRequestFactory:
$ref: '#/components/schemas/ObjectSearchRequestFactory'
MetadataCache:
type: object
properties:
businessModelsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/ReltioBusinessModelRecord'
businessModelReferenceSupplier:
$ref: '#/components/schemas/ReltioBusinessModelReferenceSupplier'
metricsWriterService:
$ref: '#/components/schemas/MetricsWriterService'
metricLabels:
type: object
additionalProperties:
type: string
IdGeneratorService:
type: object
properties:
idGeneratorDAO:
$ref: '#/components/schemas/IIdGeneratorDAO'
factory:
$ref: '#/components/schemas/GeneratorsFactory'
generatorTOsCache:
$ref: '#/components/schemas/LoadingCacheStringGeneratorTO'
generatorsCache:
$ref: '#/components/schemas/LoadingCacheStringIGenerator'
hazelcastService:
$ref: '#/components/schemas/HazelcastService'
useStubGenerator:
type: boolean
statisticsCollector:
$ref: '#/components/schemas/StatisticsCollector'
IInteractionMappingsDAO:
type: object
IHistoryDAO:
type: object
ITenantID:
type: object
ICleanseDictionaryServiceFactoryProvider:
type: object
IPotentialMatchesDAO:
type: object
IInternalObjectService:
type: object
InteractionMemberResolverService:
type: object
properties:
interactionsDAO:
$ref: '#/components/schemas/InteractionsDAO'
entitiesDAO:
$ref: '#/components/schemas/EntitiesDAO'
tenantDataAccess:
$ref: '#/components/schemas/TenantDataAccess'
AWSLambdaClientFactory:
type: object
properties:
config:
$ref: '#/components/schemas/AWSLambdaConfig'
defaultCredentialsProviderFactory:
$ref: '#/components/schemas/CredentialsProviderFactory'
awsCredentialsManager:
$ref: '#/components/schemas/AWSCredentialsManager'
awsLambdaClientProvider:
$ref: '#/components/schemas/AWSLambdaClientProvider'
IOperationCounterAccess:
type: object
HandlerInstantiator:
type: object
PrintStream:
type: object
properties:
out:
$ref: '#/components/schemas/OutputStream'
closed:
type: boolean
closeLock:
type: object
lock:
$ref: '#/components/schemas/InternalLock'
autoFlush:
type: boolean
trouble:
type: boolean
formatter:
$ref: '#/components/schemas/Formatter'
charset:
$ref: '#/components/schemas/Charset'
textOut:
$ref: '#/components/schemas/BufferedWriter'
charOut:
$ref: '#/components/schemas/OutputStreamWriter'
closing:
type: boolean
IndexingConfig:
type: object
properties:
enabled:
type: boolean
description: Enables/disable indexing of the attribute
example: false
attributes:
uniqueItems: true
type: string
description: >-
List of names of sub-attributes that should be used to build index
for nested attribute
example: '["Type", "ID"]'
items:
type: string
predicateEnabled:
type: boolean
description: Enables/disable indexing of the predicate search
example: false
segmentationEnabled:
type: boolean
description: Enables/disable indexing of the segmentation search
example: false
caseSensitive:
type: boolean
description: >-
Defines if predicate API indexes are case sensitive for the
attribute, true by default
example: false
subAttributeValuesLimit:
type: integer
description: >-
Defines the limit of sub-attribute values for building indexes for
the nested attribute
format: int32
example: 2
consistency:
type: string
description: >-
Defines the consistency mode for the predicate API: 'eventual' (by
default) - indexes are updated in the background when processing the
queue or 'strong' - indexes are updated synchronously when updating
the objects (may affect write operation performance)
example: eventual
enum:
- eventual
- strong
description: >-
Indexing configuration for the attribute, enables fast access to the
object by the indexed attributes
Joiner:
type: object
properties:
separator:
type: string
CosmosThroughputConfig:
type: object
properties:
throughput:
type: integer
format: int32
type:
type: string
enum:
- PROVISIONED
- AUTO_SCALING
- CUSTOM_SCALING
BusinessProcessDataDAO:
type: object
properties:
converterFactory:
$ref: '#/components/schemas/DBLayerConverterFactory'
keyFactory:
$ref: '#/components/schemas/ICassandraDataKeyFactory'
OutputFormat:
type: object
MessagingProviderHelper:
type: object
properties:
awsExecutor:
$ref: '#/components/schemas/ScheduledExecutorService'
gcpExecutor:
$ref: '#/components/schemas/ScheduledExecutorService'
publishers:
type: object
additionalProperties:
$ref: '#/components/schemas/PublisherPool'
collector:
$ref: '#/components/schemas/MetricsCollector'
configLoader:
$ref: '#/components/schemas/MessagingConfigurationLoader'
config:
$ref: '#/components/schemas/Configuration'
lastConfigCheck:
type: integer
format: int64
awsRoleArn:
type: string
credentialsProviderResolver:
$ref: '#/components/schemas/CredentialsProviderResolver'
DataStorageMapping:
type: object
properties:
id:
type: string
type:
type: string
enum:
- BIGTABLE_DB
- CASSANDRA_DSE
- CASSANDRA_EXECUTOR
- COSMOS_DB
- DYNAMO_DB
- SPANNER_DB
- AURORA_DB
dataKeyspaceDAOs:
uniqueItems: true
type: array
items:
type: string
enum:
- ENTITIES
- RELATIONS
- CATEGORIES
- GRAPHS
- GROUPS
- USER_PREFERENCES
- ANALYTIC_ATTRIBUTES
- WORKFLOW
- ACTIVITY
- ACTIVITY_V2
- INTERACTIONS
- HIERARCHIES
cassandraConfig:
$ref: '#/components/schemas/CassandraConfigMapping'
dynamoDBConfig:
$ref: '#/components/schemas/DynamoDBConfigMapping'
cosmosDBConfig:
$ref: '#/components/schemas/CosmosClientConfigMapping'
spannerDBConfig:
$ref: '#/components/schemas/SpannerDBConfigMapping'
bigTableDBConfig:
$ref: '#/components/schemas/BigTableConfigMapping'
auroraDBConfig:
$ref: '#/components/schemas/AuroraDBConfigMapping'
tableVersions:
type: object
additionalProperties:
type: string
ActivenessAttribute:
type: object
properties:
uri:
type: string
description: >-
URI of attribute in business configuration whose value defines
start/end of activeness interval
example: configuration/entityTypes/Individual/attributes/DoB
type:
type: string
description: Type of attribute activeness interval
example: start
enum:
- start
- end
IFileStorageConfig:
type: object
description: Cloud file storage config
discriminator:
propertyName: type
RuntimeWrapper:
type: object
IElasticsearchUserManagementService:
type: object
SharedThreadContainer:
type: object
properties:
owner:
$ref: '#/components/schemas/Thread'
previous:
$ref: '#/components/schemas/StackableScope'
name:
type: string
virtualThreads:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/Thread'
key:
type: object
closed:
type: boolean
CassandraConfigWithDSMapping:
type: object
properties:
database:
type: string
keyspaceName:
type: string
tenantId:
type: string
localDataCenter:
type: string
host:
type: string
backupDataCenter:
type: string
clusterName:
type: string
replicationFactor:
type: integer
format: int32
cassandraVersion:
type: string
cassandraLogin:
type: string
cassandraPassword:
type: string
fetchBufferSize:
type: integer
format: int32
readConsistency:
type: string
writeConsistency:
type: string
executorFactory:
type: string
executorProtocolVersion:
type: string
maxInsertSizeInMb:
type: integer
format: int32
tableVersion:
type: string
ttl:
type: integer
format: int64
daoVersion:
type: string
hdsUri:
type: string
bigTableProjectId:
type: string
bigTableInstanceId:
type: string
bigTableClusterName:
type: string
bigTableZoneName:
type: string
smartConsistencyLevelEndTime:
type: integer
format: int64
dataStorageId:
type: string
dataStorageIds:
uniqueItems: true
type: array
items:
type: string
ttlISO:
type: string
MatchMethodsWeightingAlgorithm:
type: object
properties:
type:
type: string
parameters:
type: array
items:
$ref: '#/components/schemas/MatchParam'
list:
type: array
items:
type: string
fallback:
type: string
ComparatorConfigSerializable:
type: object
properties:
comparatorClass:
type: string
description: The fully qualified name of the comparator class
example: com.reltio.match.comparator.BasicStringComparator
parameters:
type: array
description: The list of comparator class parameters
items:
$ref: '#/components/schemas/MatchParamSerializable'
description: The description of the comparator configuration
DirectionalContext:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a directional context of
startPoint/endPoint configuration element
example: configuration/relationTypes/ParentChild/endObject/directionalContext
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
rule:
type: array
description: Rules when the label pattern should be applied
items:
$ref: '#/components/schemas/Rule'
description: Directional Context of start or end object of a Relationship Type
ComparatorConfig:
required:
- klass
- class
type: object
properties:
parameters:
type: array
description: The parameters of the comparator class
items:
$ref: '#/components/schemas/MatchParam'
fernConfig:
$ref: '#/components/schemas/FernConfig'
class:
type: string
description: The fully qualified name of the comparator class
example: com.reltio.ml.match.comparator.MLDocumentComparator
description: The structure to describe the match comparator class and its properties
MatchGroupAttributeMapping:
type: object
properties:
dataModelAttribute:
type: string
matchMethodAttribute:
type: string
MatchPrecisionPayload:
type: object
properties:
enabled:
type: boolean
description: >-
The parameter to enable or disable the profiling, default value is
'true'
example: true
maxObjectsPerType:
type: integer
description: >-
The parameter to specify the maximum number of objects of a type are
allowed to process
format: int32
example: 10000
matchActionTypes:
type: array
description: >-
The parameter to specify match action types which considered as a
match by analysis
example: POTENTIAL_MATCH
items:
type: string
description: A payload for the match precision analysis
NullValue:
required:
- attribute
- value
type: object
properties:
attribute:
type: string
description: Attribute URI
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Value to be considered as null for an attribute
example: unknown
description: >-
Allows to ignore irrelevant values during matching by specifying the
words that must be considered as nulls. If there is a value like
unknown, then the entities having the same unknown values
must not be matched
ComparatorClassMappingsArray:
required:
- mapping
type: object
properties:
mapping:
type: array
description: Defines the list of attribute URI mappings to comparator classes
items:
$ref: '#/components/schemas/ComparatorClassMapping'
description: List of mappings
EntityMatchGroupsAnalysis:
type: object
properties:
attributeList:
type: array
description: >-
The list of attribute URIs participating in the match groups of the
entity type
items:
type: string
inspectionResults:
type: array
description: >-
The results of the applied inspections related to the whole match
groups configuration of the entity type
items:
$ref: '#/components/schemas/InspectionResult'
tokenizationGroups:
type: array
description: >-
The static analysis results of the tokenization schemes for the
match groups
items:
$ref: '#/components/schemas/TokenizationGroupAnalysis'
comparatorGroups:
type: array
description: >-
The static analysis results of the comparison schemes for the match
groups
items:
$ref: '#/components/schemas/ComparatorGroupAnalysis'
entityType:
type: string
description: URI of the entity type
example: configuration/entityTypes/Location
description: The static analysis results for an entity type
HiddenEntityTypeConfiguration:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
matchGroups:
type: array
items:
$ref: '#/components/schemas/MatchGroup'
skippedMatchRules:
type: array
items:
type: string
InspectionResult:
type: object
properties:
inspectionId:
type: string
description: The inspection identifier
issues:
type: array
description: The list of the detected issues
items:
$ref: '#/components/schemas/Issue'
recommendations:
type: array
description: The list of the recommendations
items:
$ref: '#/components/schemas/Recommendation'
description: The result of the applied static analysis inspection
MultiAttributesOperand:
required:
- attributes
- uri
type: object
properties:
uri:
type: string
description: URI of multi group
example: configuration/entityTypes/Location/attributes/GeoLocationMulti
attributes:
type: array
description: >-
List of attribute URIs which participate in comparison with a
multi-attributes comparator
example: >-
["configuration/entityTypes/Location/attributes/GeoLocation/attributes/Latitude",
"configuration/entityTypes/Location/attributes/GeoLocation/attributes/Longitude"]
items:
type: string
combinationsConfig:
$ref: '#/components/schemas/CombinationsConfig'
description: Defines a group URI for set of attributes
MatchGroupAliasMapping:
type: object
properties:
from:
type: string
to:
type: string
Recommendation:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/Parameter'
allOf:
- $ref: '#/components/schemas/ParametrizedMessage'
- type: object
properties:
text:
type: string
description: The message text
example: Consider changing match token class {1} to an existing one
id:
type: string
description: The identifier of the recommendation
example: matchTokenClassNotFound
enum:
- matchTokenClassNotFound
- notMatchTokenClass
- comparatorClassNotFound
- notComparatorClass
- duplicateComparatorGroupDefinition
- duplicateTokenDefinition
- similarTokenDefinition
- equalsIsIgnoredInToken
- ovOnlyIsNotSetForMatchGroup
- tokenComparatorContractViolation
- tokenComparatorParametersMismatch
- onlyEqualsConstraintValuesAreDifferent
- lessStrictGroupFound
- matchGroupsDiffersByFuzzyComparatorOnly
- matchGroupsDiffersByFuzzyMatchTokenOnly
- multipleAttributeUsagesInMatchRule
- multipleComparatorDefinitionsForAttribute
- multipleMatchTokenDefinitionsForAttribute
- multipleFuzzyAttributesInToken
description: The description of the recommendation
AbstractTypeWithLifecycleActions:
type: object
properties:
lifecycleActions:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/LifecycleActionConfig'
description: >-
Life Cycle Action (LCA) allows to inject custom logic for various
operations on Reltio profile. Reltio supported operations(hooks)
are: beforeSave, afterSave, beforeMerge etc.
Configuration of LCA can be done in 2 ways:
1. Simple configuration:
{"beforeSave":["BeforeSaveAction","Lambda/BinaryJSON/LambdaAction"],
"afterMerge":["AfterMergeAction"]}
2. Conditional configuration: {"beforeSave":
[{"actions":["BeforeSaveAction"], "filter":"equals(clientType,
'Reltio UI')"}]}
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: Base class of EntityType and RelationshipType
discriminator:
propertyName: type
MatchAssetsType:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
algorithm:
type: string
description: The algorithm to create match assets
rematchOnThreshold:
type: boolean
description: >-
Reevaluate matches or check for Automatic Unmerge when common
asset(s) cross a threshold (default: true)
definitions:
type: array
description: The list of match asset definitions
items:
$ref: '#/components/schemas/MatchAssetType'
description: A definition of a set of match asset types
MatchAssetAttributeTransformerConfig:
type: object
properties:
type:
type: string
parameters:
type: object
additionalProperties:
type: string
GroupType:
required:
- attributeModelHelperList
- attributes
type: object
properties:
uri:
type: string
description: Path that is used to identify a group type configuration element
example: configuration/groupTypes/Physicians
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}'
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type. One
group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on the
defined expression
items:
$ref: '#/components/schemas/RuleBasedAttribute'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
hasPrimaryMember:
type: boolean
description: >-
If true, group type instances required to have a primary
member. This is validation rule - so groups can be created without
primary members but it will be reflected in validation warning.
Default: false
example: true
multiplePrimaryMembers:
type: boolean
description: >-
If true, group instances will have multiple primary members.
This is validation rule - so groups that are defined with single
primary member can have more then one primary member but it will be
reflected in validation warning. Default: true
example: true
limitMemberToOneGroupInstance:
type: boolean
description: >-
If true, restricts group object to being related to only one
instance of that group type
example: true
groupElements:
type: array
description: A collection of possible group elements
items:
$ref: '#/components/schemas/GroupElement'
memberTypes:
type: array
description: A collection of possible member types
items:
$ref: '#/components/schemas/GroupMember'
type:
type: string
description: >-
Type of a group. Supported types are:- manual - members of a
group instance are added manually (e.g. though API,
UI)
- logical - members of a group instance are defined by a
rule. Example - group of people graduated from some university in
some year
- manual-logical - it has a rule to identify members
of a group, but some members can be included or excluded
manually
example: logical
enum:
- manual
- logical
- manual-logical
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for which
object should be considered as active. Inactiveness for object means
that it won't appear in any search results by default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
description: >-
Examples of group types are: Household, Alumni, Extended Family, ER
Staff
StaticAnalysisInspectionPayload:
type: object
properties:
inspectionId:
type: string
description: The identifier of the inspection
example: BadMatchTokenClassInspection
enum:
- BadMatchTokenClassInspection
- MultipleMatchTokenDefinitionsForAttribute
- MatchGroupDiffersByFuzzyMatchTokenInspection
- DuplicateTokenDefinitionInspection
- SimilarTokenDefinitionInspection
- DuplicateComparatorGroupDefinitionInspection
- OnlyEqualsConstraintIsDifferentInspection
- MatchGroupDiffersByFuzzyComparatorInspection
- LessStrictGroupFoundInspection
- BadComparatorClassInspection
- TokenComparatorContractViolationInspection
- TokenComparatorParametersMismatchInspection
- MultipleAttributeUsagesInMatchRuleInspection
- EqualsIsIgnoredInTokenInspection
- PreferOvOnlyEntityInspection
- MultipleComparatorDefinitionsForAttribute
- MultipleFuzzyAttributesInToken
parameters:
type: object
additionalProperties:
type: object
description: >-
The parameters of the inspection. Allows to configure some
inspections:
SimilarTokenDefinitionInspection,MultipleFuzzyAttributesInToken
description: The static analysis inspection settings
Rule:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attribute:
type: string
description: Attribute URI to verify in the rule
example: configuration/entityTypes/Individual/attributes/Gender
type:
type: string
description: Type of the rule
example: condition
enum:
- condition
condition:
type: string
description: Condition type
example: '='
enum:
- '='
value:
type: string
description: Value to verify
example: Female
description: Rule for Directional Context of a Relationship Type
ParametrizedMessage:
type: object
properties:
text:
type: string
description: The message text
example: Match token class {1} is not found
id:
type: string
description: The identifier of the message
parameters:
type: array
description: The parameters of the message
items:
$ref: '#/components/schemas/Parameter'
description: The parametrized message of the static analysis engine
Prefilter:
type: object
properties:
enabled:
type: boolean
description: Whether prefiltering is enabled for this feature
example: true
algorithm:
type: string
description: Similarity algorithm to use for prefiltering
example: JaroWinkler
enum:
- JaroWinkler
- Levenshtein
- MinMax
- Exact
threshold:
type: string
description: 'Similarity threshold range for prefiltering (format: ''min-max'')'
example: 0.2-0.9
description: >-
Prefilter configuration for Fern LLM inference. Applies lightweight
similarity checks before expensive LLM inference to optimize performance
and cost.
MatchGroupOverrides:
type: object
properties:
attributesMapping:
type: array
items:
$ref: '#/components/schemas/MatchGroupAttributeMapping'
AnalyzeMatchRulesV2Payload:
type: object
properties:
entityTypes:
type: array
description: The names of the entity types to run the analysis for
example: '["Location","HCP"]'
items:
type: string
staticAnalysis:
$ref: '#/components/schemas/StaticAnalysisPayload'
profiling:
$ref: '#/components/schemas/ProfilingPayload'
matchPrecision:
$ref: '#/components/schemas/MatchPrecisionPayload'
model:
$ref: '#/components/schemas/ReltioBusinessModel'
description: A payload for the match groups analysis
ExportedReportLocation:
type: object
properties:
url:
type: string
type:
type: string
format:
$ref: '#/components/schemas/AnalyzeMatchRulesReportFormat'
errors:
type: array
items:
$ref: '#/components/schemas/ExportReportError'
AnalyticsAttribute:
required:
- name
- type
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a analytics attribute configuration
element
example: configuration/entityTypes/Party/analyticsAttributes/Name
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
name:
type: string
description: >-
Name of the attribute used by Data API. Should be exactly the same
as the last part of uri
example: Name
type:
type: string
description: Type of attribute from the configuration.
example: String
enum:
- String
- StringNotTokenized
- Long
- Int
- Number
- Float
- Boolean
- Date
- Timestamp
- Blob
- URL
- Blog URL
- Image URL
- SSN
- Id card (Passport)
- SIC-code
- NAICS-code
- Email domains
- Ticker symbol
- CIK id
- Stock exchange
- GeoLocation
- Nested
- Reference
maxOccurs:
type: integer
description: >-
Analytics attributes can contain multiple values, maximum number of
values is limited by the maxOccurs property. By default, 1
format: int32
example: 1
faceted:
type: boolean
description: >-
If true, this attribute will be displayed in the +More
list on the Search page when the entity is selected. By
default, false
example: false
searchable:
type: boolean
description: >-
If true, this attribute will be displayed in the Advanced
Search page when the entity is selected. By default, false
example: false
couldUpdateWithLCA:
type: boolean
description: If true, this attribute will be persisted. By default, false
example: false
analyticsAttributes:
type: array
description: Array of possible nested analyticsAttributes
items:
$ref: '#/components/schemas/AnalyticsAttribute'
description: >-
Analytics attributes are special attributes that are used to store
analytics' results. Analytics attributes are the properties of an
entity. There are two types of analytics attributes: simple and nested.
Nested attributes contain a set of analytics attributes. Analytics
attributes can contain multiple values, maximum number of values is
limited by the maxOccurs property.
GroupMember:
type: object
properties:
uri:
type: string
description: Path that is used to identify a group element configuration element
example: configuration/groupTypes/Physicians/memberTypes/Member
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
primaryMember:
type: boolean
description: Whether this member primary or not
example: true
description: Group Member
MatchMethodMetadata:
required:
- packageVersion
type: object
properties:
packageVersion:
type: string
description: Match package version.
example: 1.0.0
packageId:
type: string
description: Match package id
example: HCP_1.2
packageProfile:
type: string
description: Match package profile id
example: fern_ds
origin:
type: string
description: Match method origin
example: velocity_pack
matchMethodApplicability:
type: string
description: >-
Allows marking a match method as applicable to any pair that was
discovered or not. Default: if-tokens-generated
example: all
enum:
- if-tokens-generated
- all
description: Represents metadata for a match group
TokenizationGroupAttribute:
type: object
properties:
operands:
type: array
description: The match rule operands where the attribute is involved to
items:
$ref: '#/components/schemas/OperandsTreePath'
matchTokenConfig:
$ref: '#/components/schemas/MatchTokenConfigSerializable'
constraints:
type: array
description: >-
The constraints applied to the attribute (like 'equals',
'notEquals', 'in')
items:
$ref: '#/components/schemas/ConstraintSerializable'
uri:
type: string
description: The attribute URI
description: >-
The description of how an attribute is used in the match group
tokenization scheme
StatisticPayload:
type: object
properties:
enabled:
type: boolean
description: The parameter to enable or disable the statistic, default is 'true'
example: true
name:
type: string
description: >-
The name of the statistic. For the comprehensive list of available
statistics please refer to the official Reltio documentation
enum:
- min
- max
- mean
- std
- range
- total
- mode
- se
- skewness
- kurtosis
- variance
- median
- firstQuartile
- thirdQuartile
- mostFrequent
- lowerBoundOutliers
- upperBoundOutliers
- histogram
- countFrequency
- correlation
- covariance
- frequencies
parameters:
type: object
additionalProperties:
type: object
description: >-
The custom parameters of the statistic. For the detailed information
please refer to the official Reltio documentation
description: The model to describe a statistic applied
GroupElement:
type: object
properties:
uri:
type: string
description: Path that is used to identify a group element configuration element
example: configuration/groupTypes/Physicians/groupElements/1
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
entityTypeUris:
type: array
description: List of Entity Types
example: >-
configuration/entityTypes/Individual,
configuration/entityTypes/Location
items:
type: string
reachByRelationTypeUris:
type: array
description: List of Relation Types
example: >-
configuration/relationTypes/Parent,
configuration/relationTypes/Child
items:
type: string
description: Group Member
MatchRule:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
or:
type: array
properties:
size:
type: integer
format: int32
description: Logical operand OR, applied to single or multiple match rules
items:
$ref: '#/components/schemas/MatchRule'
and:
type: array
properties:
size:
type: integer
format: int32
description: >-
Logical operand AND, applied to single or multiple match
rules
items:
$ref: '#/components/schemas/MatchRule'
not:
type: array
properties:
size:
type: integer
format: int32
description: >-
Logical operand NOT, applied to single match rule. It is a
unary operand and hence, only one argument/sub-operand is allowed.
If you do not want to use a more complex condition after NOT,
use the AND or OR logical operand as a container
items:
$ref: '#/components/schemas/MatchRule'
exact:
type: array
description: >-
Evaluates to True if there is an exact match between attribute
values.List of attribute URIs.If there is no parent rule, the
AND logical operator is used.
example: >-
['configuration/entityTypes/Individual/attributes/FirstName',
'configuration/entityTypes/Individual/attributes/LastName']
items:
type: string
notExact:
type: array
description: Evaluates to True if there is no match between attribute values
items:
$ref: '#/components/schemas/NotExactOperand'
equals:
type: array
description: >-
This operator serves as a match filter, reducing the number of
records that will be considered for a rule. Helps in identifying
records that will be considered for matching
items:
$ref: '#/components/schemas/EqualsOperand'
exactOrNull:
type: array
description: >-
Evaluates to True when both values match, one value is null, or both
values are null.List of attribute URIs, evaluates to True if there
is an exact match between attribute values.If there is no parent
rule, the AND logical operator is used.
example: >-
['configuration/entityTypes/Individual/attributes/FirstName',
'configuration/entityTypes/Individual/attributes/LastName']
items:
type: string
exactOrAllNull:
type: array
description: >-
Evaluates to True when both values match or both values are
null.When you use the ExactOrAllNull operator, the rule evaluates to
True if there is an exact match between attributes based on the
value you specify or the value is null in both entities.If there is
no parent rule, the AND logical operator is used.
example: '[''configuration/entityTypes/Individual/attributes/LastName'']'
items:
type: string
fuzzy:
type: array
description: >-
Checks for similarity of attribute values.This operator uses the
comparator classes to check for similarity of attribute values
between two entities.Note: It's strongly recommends to define an
appropriate comparator class whenever a fuzzy match operator is
used. If you do not specify a comparator, the system chooses a
default comparator that may not produce the desired match results.
example: '[''configuration/entityTypes/Individual/attributes/LastName'']'
items:
type: string
ignoreInToken:
uniqueItems: true
type: array
description: >-
List of attribute URIs which aren't included in match token saved in
database. It's used to decrease token's size.
example: '[''configuration/entityTypes/Individual/attributes/MiddleName'']'
items:
type: string
multi:
type: array
description: Defines a list of groups of attributes
items:
$ref: '#/components/schemas/MultiAttributesOperand'
weights:
type: array
description: List of mappings between attributes URIs and their weight
items:
$ref: '#/components/schemas/AttributeWeight'
actionThresholds:
type: array
description: List of threshold range mapping to particular action type
items:
$ref: '#/components/schemas/MatchActionThreshold'
cleanse:
type: array
description: >-
List of cleansers can be used in match rules to cleanse matching
attributes
items:
$ref: '#/components/schemas/MatchRuleCleanseInfo'
matchTokenClass:
type: string
description: >-
Fully qualified Java class name used for computing match tokens
based on some predefined logic
example: com.reltio.match.token.SoundexTextMatchToken
comparatorClass:
type: string
description: >-
Fully qualified Java class name used for comparing values based on
some predefined logic. It's default for all matching attribute in
particular object type
example: com.reltio.match.comparator.SoundexComparator
matchTokenClasses:
$ref: '#/components/schemas/MatchTokenClassMappingsArray'
comparatorClasses:
$ref: '#/components/schemas/ComparatorClassMappingsArray'
nullValues:
type: array
description: >-
List of attribute mappings to ignore irrelevant values during
matching
items:
$ref: '#/components/schemas/NullValue'
notEquals:
type: array
description: >-
Defines the list of attribute to value mappings that helps in
identifying records that will not be considered for matching
items:
$ref: '#/components/schemas/EqualsOperand'
in:
type: array
description: >-
Defines the list of attribute to value mappings where boolean
OR condition that is available for multiple values
items:
$ref: '#/components/schemas/EqualsOperand'
description: >-
Defines a set of attributes that must be used to compare two entities
and the type of comparison used for each attribute.
StaticAnalysisPayload:
type: object
properties:
enabled:
type: boolean
description: >-
The parameter to enable or disable the static match rules analysis,
default value is 'true'
example: true
inspections:
type: array
description: >-
The list of requested inspections to be applied to the match rules.
By default all the inspections are applied
items:
$ref: '#/components/schemas/StaticAnalysisInspectionPayload'
hideEmptyResults:
type: boolean
description: >-
The parameter to hide the results of the inspections that do not
result in an issue or a recommendation, default value is 'false'
example: true
reports:
type: array
description: The list of the requested report formats and destinations
items:
$ref: '#/components/schemas/ReportPayload'
description: A payload for the static match rules analysis
ReportPayload:
type: object
properties:
format:
$ref: '#/components/schemas/AnalyzeMatchRulesReportFormat'
location:
$ref: '#/components/schemas/AnalyzeMatchRulesReportLocation'
description: Requested format and location of the static analysis report
CandidateLookupMethod:
required:
- type
type: object
properties:
type:
type: string
description: Type of the candidate selection algorithm
example: vector-based
enabled:
type: boolean
params:
type: array
description: Additional parameters for the candidate lookup
items:
$ref: '#/components/schemas/MatchParam'
description: >-
Represents a source of additional candidate pairs in the match method
definition.
FeatureDefaults:
type: object
properties:
promptTemplate:
type: string
description: Default prompt template for LLM inference
example: MULTIVALUE
enum:
- SINGLEVALUE
- MULTIVALUE
prefilter:
$ref: '#/components/schemas/Prefilter'
description: >-
Default configuration settings for Fern LLM inference applied to all
features unless overridden
InspectionsPayload:
type: object
properties:
enabled:
type: boolean
description: >-
The parameter to enable or disable the profiling inspections,
default value is 'true'
example: true
formatted:
type: boolean
description: >-
The parameter to enable or disable the formatting of the inspection
messages. - If 'true then the parametrized messages are
formatted with the parameters
- If 'false' then the
parametrized messages are returned as is
Default value is
'true'
example: true
description: The settings controlling how the profiling inspections are applied
DependentAttributeValues:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
valuesList:
type: array
description: List of values
example: '[''value_1'', ''value_2'']'
items:
type: string
visibleAttributes:
type: array
description: List of visible attributes URIs
example: >-
['configuration/entityTypes/Party/attributes/DocumentLinks',
'configuration/entityTypes/Individual/attributes/Prefix',
'configuration/entityTypes/Party/attributes/ImageLinks']
items:
type: string
description: Definition of dependent attribute values and their visibility
TokenizationGroupAnalysis:
type: object
properties:
id:
type: string
description: The identifier of the match group tokenization scheme analysis
type:
type: string
description: The type of the match group
attributes:
type: array
description: The attributes description
items:
$ref: '#/components/schemas/TokenizationGroupAttribute'
inspectionsResults:
type: array
description: The results of the applied inspections
items:
$ref: '#/components/schemas/InspectionResult'
matchGroup:
type: string
description: The URI of the match group
description: The static analysis results of the tokenization scheme for a match group
MatchAssetSourceSystemCondition:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
included:
type: array
items:
type: string
ReltioBusinessModel:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for a model
example: Business Model
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
schemaVersion:
type: string
description: >-
Version of Reltio API Configuration schema used to describe objects.
Value of schemaVersion field should be chosen according to
customer's internal processes. With every change of business
configuration of tenant value of schema version schould be changed.
example: 1.1.1
createdTime:
type: integer
description: Creation time of this configuration
format: int64
example: 1662566038186
updatedTime:
type: integer
description: Update time of this configuration
format: int64
example: 1662566038186
createdBy:
type: string
description: Identifier of a user created the Reltio Business Model
example: somebody@example.com
updatedBy:
type: string
description: Identifier of a user updated the Reltio Business Model last time
example: somebody@example.com
abstractModel:
type: boolean
description: >-
Defines if this configuration is abstract and can be used only in
inheritance hierarchy on top levels
example: false
referenceConfigurationURI:
type: string
description: URI of configuration which current configuration inherits from
example: configuration/_vertical/life-sciences
rdmTenantId:
type: string
description: Identifier of Reference Data Management tenant
example: rdm
entityTypes:
type: array
description: List of entity types definitions
items:
$ref: '#/components/schemas/EntityType'
changeRequestTypes:
type: array
description: List of changeRequest types definitions
items:
$ref: '#/components/schemas/ChangeRequestType'
roles:
type: array
description: List of roles definitions
items:
$ref: '#/components/schemas/Role'
groupTypes:
type: array
description: List of groupType definitions
items:
$ref: '#/components/schemas/GroupType'
matchActions:
type: array
description: List of match actions definitions
items:
$ref: '#/components/schemas/MatchAction'
interactionTypes:
type: array
description: List of interactions types definitions
items:
$ref: '#/components/schemas/InteractionType'
graphTypes:
type: array
description: List of graphs types definitions
items:
$ref: '#/components/schemas/GraphType'
survivorshipStrategies:
type: array
description: List of survivorship strategies definitions
items:
$ref: '#/components/schemas/SurvivorshipStrategy'
sources:
uniqueItems: true
type: array
description: List of all sources definitions
items:
$ref: '#/components/schemas/SourceType'
pinIgnoredPriority:
type: array
description: >-
Defines priority of pin/ignored/neutral value statuses when equal
values are merged or being overridden. Allowable value is ordered
list of 3 value status name with descending priority. By default,
['ignored', 'pin', 'neutral']
example: '["ignored", "pin", "neutral"]'
items:
type: string
enum:
- ignored
- pin
- neutral
attributeTypes:
type: array
description: List of generic attribute types definitions
items:
$ref: '#/components/schemas/GenericAttributeType'
relationTypes:
type: array
description: List of relationship types definitions
items:
$ref: '#/components/schemas/RelationshipType'
ratings:
$ref: '#/components/schemas/Ratings'
activity:
$ref: '#/components/schemas/ActivityConfig'
description: Configuration of the tenant metadata
AnalyzeMatchRulesReportFormat:
required:
- type
type: object
properties:
type:
type: string
description: The report format
example: HTML
enum:
- JSON
parameters:
type: object
additionalProperties:
type: object
description: The custom parameters of the report format
description: The format of the static analysis report
MatchGroup:
required:
- type
- useOvOnly
type: object
properties:
uri:
type: string
description: Path that is used to identify a match group configuration element
example: configuration/entityTypes/Individual/matchGroups/IndividualByEmail
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
type:
type: string
description: >-
Defines how to proceed duplicates found using this group: merge
automatically ("automatic"), create a potential match which could be
merged after user confirmation ("suspect"),merge or create a
potential match or not match based on relevance
("relevance_based"),or even proceed with custom match action.
example: automatic
enum:
- '[''automatic'''
- '''suspect'''
- '''relevance_based'''
- '''automatic_grouping'']'
scope:
type: string
description: >-
Option to classify a rule as external only or internal only.Provides
information about how to enable and disable match rules. By default,
'ALL'
example: ALL
enum:
- '[''NONE'''
- '''INTERNAL'''
- '''EXTERNAL'''
- '''ALL'']'
useOvOnly:
type: string
description: >-
If set to true, then only the OV value will be used for matching. By
default, false.
example: 'false'
matchMethodMetadata:
$ref: '#/components/schemas/MatchMethodMetadata'
rule:
$ref: '#/components/schemas/MatchRule'
negativeRule:
$ref: '#/components/schemas/NegativeMatchRule'
documentComparator:
$ref: '#/components/schemas/ComparatorConfig'
documentTokenizer:
$ref: '#/components/schemas/MatchTokenConfig'
matchServiceClass:
type: string
description: >-
Fully qualified Java class name of the match service implementation.
Using this attribute external implementation of match service can be
configured to use.
example: >-
com.reltio.businesslogic.match.providers.internal.InternalMatchService
scoreStandalone:
type: integer
description: >-
Numeric value (0, 100), the total match score for entity is based on
in case of entity matched on this rule. The base match score is a
max value of standalone scores between each match rule that the
entity matched on. Total match score for entity is a sum of the base
match score and incremental match scores EXCLUDING the rule that
provided the standaloneScore.
format: int32
scoreIncremental:
type: integer
description: >-
Numeric value (0, 100), added to the base match score in case of
entity matched on this rule. Total match score for entity is a sum
of the base match score and incremental match scores EXCLUDING the
rule that provided the standaloneScore
format: int32
matchMethod:
type: string
description: >-
Differentiate between the customer-defined match rules versus Match
IQ defined match rules. All the match rules that do not have value
for this field should default to customer-defined match rule.
enum:
- match_iq
- rule_based
aliasing:
$ref: '#/components/schemas/MatchGroupAliasing'
overrides:
$ref: '#/components/schemas/MatchGroupOverrides'
compositeMatchMethodParticipants:
$ref: '#/components/schemas/CompositeMatchMethodParticipants'
matchMethodPostEvaluation:
$ref: '#/components/schemas/MatchMethodPostEvaluation'
candidatesLookup:
$ref: '#/components/schemas/CandidateLookup'
matchMethodPrerequisites:
$ref: '#/components/schemas/MatchMethodPrerequisites'
filter:
type: string
description: >-
ES-style filter expression to determine if this match rule is
applicable to an entity. If the entity does not satisfy the filter,
no match tokens will be generated for this rule. Supports functions
like: equals, missing, exists, gt, gte, lt, lte, startsWith,
containsWordStartingWith, range. Example: 'not
missing(attributes.Phone)' or 'equals(attributes.Status, "Active")'
example: not missing(attributes.Phone)
description: >-
A match group defines match rule or negative match rule to compare
entities within the entity type.
MatchMethodPostEvaluation:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
type:
type: string
description: The type of the post-evaluation
example: common_assets
assetsList:
type: array
description: List of match assets to be used for the matching process
example: >-
['configuration/entityTypes/Individual/matchAssets/NameAsset',
'configuration/entityTypes/Individual/matchAssets/PhoneAsset']
items:
type: string
description: >-
A common assets rule defines the conditions checked by the matching
process to determine if two entities are allowed to merge/match.
Parameter:
type: object
properties:
id:
type: string
description: >-
The identifier of the parameter. The identifier works as a
placeholder in the message text
example: '1'
value:
type: string
description: The value of the parameter
example: configuration/entityTypes/Location/matchGroups/AutoMatch
type:
type: string
description: The type of the parameter
example: matchGroupUri
enum:
- attributeUri
- matchGroupUri
- matchTokenClass
- comparatorClass
- tokenizationGroupId
- comparatorGroupId
- matchParameterNames
- attributeUris
- operandPaths
- text
description: The parameter of the static analysis parametrized message
MatchActionThreshold:
required:
- threshold
- type
type: object
properties:
type:
type: string
description: >-
Action type. When a match pair is detected the action with this type
is invoked. Predefined types are: auto_merge, not_a_match,
potential_match. Custom match actions could also be used.
example: not_a_match
threshold:
type: string
description: >-
Weight range: floating point numbers separated by '-'. Allowed range
for start and end values is [0, 1]
example: 0.7-0.9
label:
type: string
description: Readable name for the configuration element
example: Recommended for workflow
description: >-
Defines a threshold range for particular action type. When a match pair
is detected the action with this type is invoked
Issue:
type: object
properties:
parameters:
type: array
items:
$ref: '#/components/schemas/Parameter'
allOf:
- $ref: '#/components/schemas/ParametrizedMessage'
- type: object
properties:
text:
type: string
description: The message text
example: Match token class {1} is not found
id:
type: string
description: The identifier of the issue
example: matchTokenClassNotFound
enum:
- matchTokenClassNotFound
- notMatchTokenClass
- comparatorClassNotFound
- notComparatorClass
- duplicateComparatorGroupDefinition
- duplicateTokenDefinition
- similarTokenDefinition
- tokenComparatorContractViolation
- tokenComparatorParametersMismatch
- onlyEqualsConstraintValuesAreDifferent
- lessStrictGroupFound
- matchGroupsDiffersByFuzzyComparatorOnly
- matchGroupsDiffersByFuzzyMatchTokenOnly
- multipleComparatorDefinitionsForAttribute
- multipleMatchTokenDefinitionsForAttribute
- multipleFuzzyAttributesInToken
severity:
type: string
description: The severity of the issue
example: HIGH
enum:
- UNKNOWN
- MEDIUM
- HIGH
description: The description of the detected issue
MatchTokenClassMappingsArray:
required:
- mapping
type: object
properties:
mapping:
type: array
description: Defines the list of attribute URI mappings to match token classes
items:
$ref: '#/components/schemas/MatchTokenClassMapping'
description: List of mappings
SourceType:
type: object
properties:
uri:
type: string
description: Path that is used to identify a source type configuration element
example: configuration/sources/ReltioCleanser
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
priority:
type: integer
description: >-
Priority of the Source that could be used by some Survivorship
Strategies
format: int32
example: 10
abbreviation:
type: string
description: >-
Abbreviation of a source system that will be used in Reltio Data API
requests for crosswalks
example: FB
icon:
type: string
description: Icon of the source to be displayed at Reltio UI
example: sources/icon.png
autoGenerated:
type: boolean
description: >-
If true, the value of an appropriate crosswalk will be
auto-generated
example: false
generator:
type: string
description: The generator name (if autoGenerated is true)
example: SequentialGenerator
autoGenerationPattern:
type: string
description: >-
Pattern for autogenerated value. {value} will be substituted by
generated value
example: ID_{value}
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
description: >-
Data may come to Reltio from multiple sources. Each source must be
registered in Reltio, and all data loaded into a tenant will be
associated with a data source. If no source is specified when creating
an object, the source will default to "Reltio"
MatchActionMapping:
required:
- clazz
- class
type: object
properties:
parameters:
type: array
description: >-
List of additional parameters passing to custom handler Java
class
items:
$ref: '#/components/schemas/MappingParam'
class:
type: string
description: Match Action handler Java class name
example: com.reltio.businesslogic.match.handlers.SuspectMatchHandler
description: Match Action handler class mapping for attributes
RelationshipType:
required:
- attributeModelHelperList
type: object
properties:
description:
type: string
extendsTypeUri:
type: string
cleanse:
$ref: '#/components/schemas/CleanseInfo'
attributeModelHelperList:
type: array
items:
$ref: '#/components/schemas/AttributeModelHelper'
activenessAttributeModelHelpers:
type: array
items:
$ref: '#/components/schemas/ActivenessAttributeModelHelper'
surrogateCrosswalksList:
type: array
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributeNames:
type: array
items:
type: string
defaultSearchAttributeNames:
type: array
items:
type: string
reverceOfTypeUris:
type: string
directionString:
type: string
allOf:
- $ref: '#/components/schemas/AbstractTypeWithLifecycleActions'
- required:
- attributes
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a relationship type configuration
element
example: configuration/relationTypes/HasAddress
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for
which object should be considered as active. Inactiveness for
object means that it won't appear in any search results by
default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: >-
Tooltip:
{configuration/entityTypes/Individual/attributes/FullName}
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type.
One group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on
the defined expression
items:
$ref: '#/components/schemas/ruleBasedAttributes'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
startObject:
$ref: '#/components/schemas/RelationshipEndPoint'
endObject:
$ref: '#/components/schemas/RelationshipEndPoint'
sameAsTypeURIs:
type: string
description: >-
Collection URI of the relation type that has the same semantics
as this type. In all graphs the configuration of these relation
types is used as synonyms; therefore, there is no need to list
all possible types in the graph configuration
example: configuration/relationTypes/HasLocation
reverseOfTypeURIs:
type: string
description: >-
Collection of URIs that define the semantic reverse relation
type as this type
example: configuration/relationTypes/Parent
implicit:
type: boolean
description: >-
If true, the relationship is marked as an Implicit
relationship.
- Implicit Relationships that do not
appear, for example, in a Network graph because they are deemed
not to be of significant business value in a graphical display.
Implicit relationships are used only in Business Objects for
reference attributes such as Address, where, again, its not
considered important to render that
relationship.
- Explicit Relationships such as this
between an Individual and an Employer are displayed in a
graph.
Default is false; that is, explicit
example: true
direction:
type: string
description: >-
Identifies directional semantics of relationship object of the
type. Supported directions:
- directed: Used
when the two nodes that the relationship connects have different
business meaning relative to each other. Example: When the
"parent" relationship type is used, it is understood that one
node is a parent, and the other node is the
child.
- undirected: Used when connecting node A to
node B, and there is no reverse relationship implied. Example:
"professional" might be used to connect a cardiologist to a
neurosurgeon. A reverse relationship is neither required nor
implied.
- bidirectional: Both objects in the
relationship are equal and active in a system. Start and end
entity types must play the same role. Example: "friendship"
relationship in FB (when both sides confirmed that they are
friends).
Default is directed
example: directed
enum:
- directed
- undirected
- bidirectional
entityEndDateStrategy:
type: string
description: >-
Defines how to handle the relation when the start/end entity is
end dated.
- END_DATE_RELATION: End date the
whole relation and related
crosswalks
- END_DATE_RELATION_CROSSWALKS: End date
related relation crosswalks
Defaults to
END_DATE_RELATION_CROSSWALKS
example: END_DATE_RELATION_CROSSWALKS
enum:
- END_DATE_RELATION
- END_DATE_RELATION_CROSSWALKS
analyticsAttributes:
type: array
description: >-
Allows to define list of attributes that not stored with
relation but calculated on the fly according some rules.
items:
$ref: '#/components/schemas/AnalyticsAttribute'
contributorCrosswalkSingleSourceUpdateMode:
type: boolean
description: >-
If true, the relation crosswalks will be consolidated
when crosswalks.
are coming from single contributor,
ensuring that only the most recent crosswalk entry from the same
contributor is retained. Default is false; that is,
explicit
example: true
defaultSurvivorshipStrategy:
type: string
description: >-
Name of the default survivorship strategy name to apply to
attributes of this relationship type when a specific mapping
does not define one
example: Aggregation
description: Definition of particular Relationship Type
MatchTokenConfig:
required:
- klass
- class
type: object
properties:
params:
type: array
description: The parameters of the comparator class
items:
$ref: '#/components/schemas/MatchParam'
class:
type: string
description: The fully qualified name of the comparator class
example: com.reltio.ml.match.token.MLMatchDocumentTokenizer
description: The structure to describe the match token class and its properties
MatchAssetAttributeType:
type: object
properties:
uri:
type: string
optional:
type: boolean
defaultValue:
type: string
noiseCharacters:
type: string
transformers:
type: array
items:
$ref: '#/components/schemas/MatchAssetAttributeTransformerConfig'
MatchTokenConfigSerializable:
type: object
properties:
matchTokenClass:
type: string
description: The fully qualified name of the match token class
example: com.reltio.match.token.ExactMatchToken
parameters:
type: array
description: The list of match token class parameters
items:
$ref: '#/components/schemas/MatchParamSerializable'
description: The description of the match token configuration
ComparatorGroupAnalysis:
type: object
properties:
id:
type: string
description: The identifier of the match group comparison scheme analysis
type:
type: string
description: The type of the match group
attributes:
type: array
description: The attributes description
items:
$ref: '#/components/schemas/ComparatorGroupAttribute'
inspectionsResults:
type: array
description: The results of the applied inspections
items:
$ref: '#/components/schemas/InspectionResult'
useOvOnly:
type: boolean
description: >-
The value showing that the match group is configured to take
OV-value only
matchGroup:
type: string
description: The URI of the match group
description: The static analysis results of the comparison scheme for a match group
SamplingAlgorithm:
type: object
description: The custom algorithm to sample the objects dataset
discriminator:
propertyName: name
FeatureOverride:
type: object
properties:
promptTemplate:
type: string
description: Override prompt template for this specific feature
example: SINGLEVALUE
enum:
- SINGLEVALUE
- MULTIVALUE
prefilter:
$ref: '#/components/schemas/Prefilter'
description: >-
Per-feature override configuration for Fern LLM inference. Allows
customization of prompt templates and prefiltering for specific
attributes.
Ratings:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
sources:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/Rating'
description: Configuration for Sources
readOnly: true
userRoles:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/Rating'
description: Configuration for Roles
readOnly: true
timestamp:
type: integer
description: Timestamp of last modification of this configuration
format: int64
readOnly: true
example: 1234567890
description: >-
Define rules of how to calculate rating for objects.
It contains
rating calculation parameters for source systems inside a relation and
for roles of users who made votes. Each source system and user role
contains weights configuration connected to relation types. Weights
configuration may not contain the list of relation types - such
configuration is default. The "timestamp" property contains timestamp of
last modification of this configuration
FernConfig:
type: object
properties:
featureDefaults:
$ref: '#/components/schemas/FeatureDefaults'
featureOverrides:
type: object
additionalProperties:
$ref: '#/components/schemas/FeatureOverride'
description: >-
Per-feature override configurations, keyed by attribute path (e.g.,
'Address.City', 'FirstName')
description: >-
Configuration for Fern LLM inference in document comparators. Supports
default settings and per-feature overrides for prompt templates and
prefiltering.
ChangeRequestType:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a data change request (DCR) type
configuration element
example: configuration/changeRequestTypes/default
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: >-
Definition of particular Change Request Type. Only one Change Request
Type can be defined for a configuration. Note that if you configure Life
Cycle Actions that should be executed for a change request then
afterDCRSave hook only could be used.
ActivityAttributeModel:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Attribute label
example: An attribute
description:
type: string
description: Attribute description
example: Custom attribute of activity log
name:
type: string
description: Attribute name
example: attr
type:
type: string
description: Type of the attribute
example: string
enum:
- number
- boolean
- integer
- float
- time
- date
- string
- blob
searchable:
type: boolean
description: >-
Specifies whether you will be able to search activity log records by
the attribute or not
example: false
description: Configuration of a custom attribute in activity log
ComparatorGroupAttribute:
type: object
properties:
operands:
type: array
description: The match rule operands where the attribute is involved to
items:
$ref: '#/components/schemas/OperandsTreePath'
ignoreInToken:
type: boolean
description: The value showing if the attribute is marked as ignored in token
comparatorConfig:
$ref: '#/components/schemas/ComparatorConfigSerializable'
constraints:
type: array
description: >-
The constraints applied to the attribute (like 'equals',
'notEquals', 'in')
items:
$ref: '#/components/schemas/ConstraintSerializable'
uri:
type: string
description: The attribute URI
description: >-
The description of how an attribute is used in the match group
comparison scheme
SurvivorshipStrategy:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a survivorship strategy configuration
element
example: configuration/survivorshipStrategies/LUD
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
parentStrategyURI:
type: string
description: >-
Reference to parent survivorship strategy, used only for 'Custom
Name' survivorship strategy
example: LUD
mainSourceType:
type: string
description: >-
Reference to to "main" source type, used only for 'Custom Name'
survivorship strategy
example: configuration/sources/TWITTER
winnerSourceType:
type: string
description: >-
URI of the source type with the highest priority, used only for
'Record-values based source priority' strategy
example: configuration/sources/ReltioCleanser
winnerSourceAttributes:
type: array
description: >-
The list of attributes to look for crosswalks with
"winnerSourceType", used only for 'Record-values based source
priority' strategy
example: '[''configuration/entityTypes/Location/attributes/AddressLine1'']'
items:
type: string
isDefault:
type: boolean
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: >-
Survivorship strategy definition, used for defining survivorship rules
to determine Operational Values (OV) for object (an entity/relation)
attributes. Each attribute can have 0, 1 or multiple values that have
been marked as OV, they are also called "winner values".
NotExactOperand:
required:
- uri
type: object
properties:
uri:
type: string
description: Attribute URI
example: configuration/entityTypes/Individual/attributes/FirstName
multiValueAnyMismatchIsPositive:
type: boolean
description: >-
The flag to activate different behavior for multi-value attributes
(like Entity A = {Type=[T1, T2]}, Entity B = {Type=[T1]}). If true,
the operand will result in 'true' as the pair of T2 from Entity A
and T1 from Entity B are accepted. If false, the operand will result
in 'false' as the pair T1 from Entity A and T1 from Entity B are the
same which is not accepted. Default value is 'false'
example: false
description: >-
This operator selects entities for matching that are based on the
attribute value or values that are equal to the ones you specify
ProfilingAnalysisSubmissionResponse:
type: object
properties:
description:
type: string
description: The description of the submitted job
prepareSamplesTask:
type: string
description: >-
The identifier of the job that prepares the entity identifiers to
process according to the given SEARCH sampling algorithm
id:
type: string
description: The identifier of the submitted job
uri:
type: string
description: The part of the URI to get the profiling results
description: >-
The information about the job which is submitted to run the profiling
analysis
DependentAttributes:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attributeUri:
type: string
description: URI of attribute that depends on other attribute's value
example: configuration/entityTypes/Party/attributes/Name
values:
type: array
description: List of dependent attribute values and their visibility
items:
$ref: '#/components/schemas/DependentAttributeValues'
default:
type: array
description: >-
List of URI of default attributes which attributeUri depends
on
example: >-
['configuration/entityTypes/Party/attributes/DocumentLinks',
'configuration/entityTypes/Individual/attributes/Prefix']
items:
type: string
description: Definiton of attributes that depend on an entity attribute value(s).
MatchTokenClassMapping:
required:
- clazz
type: object
properties:
attribute:
type: string
description: Attribute or multi-group URI
example: configuration/entityTypes/Location/attributes/GeoLocationMulti
clazz:
type: string
description: >-
Match token fully qualified class name.
Match token
classes
- com.reltio.match.token.ExactMatchToken
- The class generates a match token which is equal to the attribute
value
- com.reltio.match.token.ExactNumberMatchToken -
This class generates a token that contains all digits from the
attribute
value
- com.reltio.match.token.SoundexTextMatchToken -
Uses the soundex algorithm to generate the token and the resultant
token consists of a soundex
code
- com.reltio.match.token.DoubleMetaphoneMatchToken
- Generates two tokens for the name. The first token is a Double
Metaphone code, and the second is statistical token to avoid
character ordering and double characters
misspellings
- com.reltio.match.token.FuzzyTextMatchToken
- This class generates a token for each common spelling up to a
maximum of six
tokens
- com.reltio.match.token.DictionaryStatsPhoneticFuzzyToken
- This class generates a token which is a combination of the
metaphone code (generated using the metaphone algorithm) and the
characters ordered in the alphabetical
order
- com.reltio.match.token.ComplexPhoneticNameToken
- Generates two tokens for the name. The first token is a Metaphone
code, and the second token is a statistical token to avoid
characters being ordered in the alphabetical order and check double
characters
misspellings
- com.reltio.match.token.AddressLineMatchToken
- This class generates a token for the AddressLine1 attribute as
follows:
- Splits the attribute value into separate
words.
- Removes all numbers. If the address consists only of
numbers, then "ZERO-ADDRESS" is returned.
- Removes all
garbage words (such as ste, blvd, ave). If the address consists only
of garbage words, then all garbage words are
preserved.
- Sorts remaining words
alphabetically.
- com.reltio.match.token.OrganizationNameMatchToken
- Generates tokens by using the following steps:
- Splits the
organization name into multiple words.
- Removes words such as
inc, limited, corp, and so on.
- Generates tokens by using the
metaphone code instead of the word value if the attribute has been
defined as fuzzy in a match rule.
- Generates a standalone
token for each word
pair.
- com.reltio.match.token.RangeNumericMatchToken
- Generates appropriate tokens for a range numeric
values.
Parameters: - threshold - The value of this
parameter can be a number or percentage value, for example, 0.25 or
10%. This value indicates the maximum acceptable difference for the
comparison to evaluate to
True.
- com.reltio.match.token.BasicTokenizedOrganizationNameMatchToken
- Generates tokens by using the following steps:
- Splits the
organization name into words with the non-alphabetical characters as
separators.
- Removes words such inc, limited, corp, and so
on.
- Generates token by using the metaphone code instead of
the word value if the attribute is defined as fuzzy in a match
rule.
- Generates a standalone token for each word
pair.
- com.reltio.match.token.CustomMatchToken
- This match token class is a container for other match token
classes. It preprocesses the values and passes them to the nested
classes. For the comprehensive guide how to configure the match
token class please refer to the official Reltio
documentation.
- com.reltio.match.token.DistinctWordsMatchToken
- For the comprehensive guide how to configure the match token class
please refer to the official Reltio
documentation.
- com.reltio.match.token.ProximateGeoToken
- The ProximateGeoToken match token class generates tokens for an
area around the geo point location (described by latitude and
longitude attributes).
Please refer to the official
Reltio documentation for more information about the match token
classes, their parameters, use cases, corresponding comparator
classes
example: com.reltio.match.token.ProximateGeoToken
parameters:
type: array
description: Additional match token class parameters
items:
$ref: '#/components/schemas/MappingParam'
description: >-
Match token class mapping for attributes. If mapping not defined
ExactMatchToken will be used.
MatchParamSerializable:
type: object
properties:
name:
type: string
description: The name of the parameter
value:
type: string
description: The value of the parameter
values:
type: array
description: The list of the composite values of the parameter
items:
type: object
additionalProperties:
type: object
description: The match token or comparator class parameter
MatchMethodPrerequisiteRuleFilter:
type: object
properties:
uri:
type: string
description: Match Group URI or pattern
type:
type: string
description: Match Group Type
example: suspect
defined:
type: string
description: Match Group definition scope
example: customer
ConstraintSerializable:
type: object
properties:
values:
type: array
description: The list of constraint values
items:
type: string
attribute:
$ref: '#/components/schemas/AttributeSerializable'
ovOnly:
type: boolean
description: The value showing if the OV-values are used only
example: true
useCleansed:
type: boolean
description: The value showing if the cleansed values are allowed
example: true
ignoreInToken:
type: boolean
description: The value showing if the attribute is marked as ignored in token
example: true
weight:
type: number
description: The weight of the constraint in a 'relevance_based' match rule
example: 0.8
strict:
type: boolean
description: >-
The value showing if the constraint needs to meet when calculating
match tokens and relevance score
example: true
checkNulls:
type: boolean
description: >-
The value showing if the constraint needs to ignore null values in
attributes
example: true
description: >-
The constraint ('equals' etc) applied to an attribute. Can be one of
EqualsConstraintSerializable, NotEqualsConstraintSerializable,
InConstraintSerializable
discriminator:
propertyName: type
EntityType:
required:
- attributeModelHelperList
type: object
properties:
label:
type: string
description:
type: string
extendsTypeUri:
type: string
cleanse:
$ref: '#/components/schemas/CleanseInfo'
attributeModelHelperList:
type: array
items:
$ref: '#/components/schemas/AttributeModelHelper'
activenessAttributeModelHelpers:
type: array
items:
$ref: '#/components/schemas/ActivenessAttributeModelHelper'
surrogateCrosswalksList:
type: array
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributeNames:
type: array
items:
type: string
defaultSearchAttributeNames:
type: array
items:
type: string
abstractFlag:
type: boolean
allOf:
- $ref: '#/components/schemas/AbstractTypeWithLifecycleActions'
- required:
- attributes
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify an entity type configuration
element
example: configuration/entityTypes/Individual
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for
which object should be considered as active. Inactiveness for
object means that it won't appear in any search results by
default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: >-
Tooltip:
{configuration/entityTypes/Individual/attributes/FullName}
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type.
One group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on
the defined expression
items:
$ref: '#/components/schemas/ruleBasedAttributes'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
typeIcon:
type: string
description: Icon used in UI facets when representing the entity type
example: images/base_type/Individual.png
typeImage:
type: string
description: Default profile image
example: images/defaultImage/no-photo.png
typeGraphIcon:
type: string
description: Icon used in UI graphs when representing the entity type
example: images/graphIcon/person-icon.png
entitySmartLogic:
type: string
description: Identifies if entity type has smart logic.
example: Individual
overrideIgnorePin:
type: boolean
description: >-
Determines if the "pin"/"ignore" flags should be overridden
after updating attribute by the same value. By default, true
example: true
abstract:
type: boolean
description: >-
Defines whether this entity type is abstract and cannot be
materialized as an instance
example: false
skipValidationForAbstractType:
type: boolean
description: >-
Disables validation for abstract type.Sometimes validation
errors can occur for abstract entity types that are not part of
the implementation.To exclude such entity types from being
checked during validation it can be disabled.
example: false
matchBeforeCreate:
type: boolean
description: >-
Enables/disables on-the-fly optimization to match entities
before create.In case optimization is enabled and match was
found by auto rule the new entity will be merged on-the-fly with
existing one instead of created separately. By default, true
example: true
cleanseInputObjectBeforeOverwrite:
type: boolean
description: >-
Enables/disables cleanse function for specific entityTO before
overwrite process.If value is true then cleanse will be
performed, else cleanse will be skipped.By default, true
example: true
uniqueGeneratedValuePerEntityPerRequest:
type: boolean
description: >-
If true, and the object already stored, the existing value by
same crosswalk as in request will be reused instead of
generating a new one. By default, false
example: false
entityTypeRoleURIs:
type: array
description: >-
List of URIs for role that can be used in combination with this
entity type. For example, an Individual entity object can be
client, while Location object cannot be.
example: '[''configuration/roles/Client'', ''configuration/roles/Advisor'']'
items:
type: string
businessCardAttributeURIs:
type: array
description: >-
List of URIs attributes that should be used in a business card.
They come in priorities order and order is preserved.Can be used
in place of secondary labels
example: >-
['configuration/entityTypes/Individual/attributes/FirstName',
'configuration/entityTypes/Individual/attributes/Gender']
items:
type: string
imageAttributeURIs:
type: array
description: >-
List of URIs for attributes that might contain entity object
images.First list element will be considered as default "bucket"
for profiles
example: '[''configuration/entityTypes/Individual/attributes/ImageLinks'''
items:
type: string
matchGroups:
type: array
description: >-
List of match groups specifications, how to configure match
rules to match and merge entities
items:
$ref: '#/components/schemas/MatchGroup'
matchAssets:
$ref: '#/components/schemas/MatchAssetsType'
dependentAttributes:
type: array
description: List of attributes that depend on an entity attribute value(s).
items:
$ref: '#/components/schemas/DependentAttributes'
analyticsAttributes:
type: array
description: >-
Allows to define list of attributes that not stored with entity
but calculated on the fly according some rules.
items:
$ref: '#/components/schemas/AnalyticsAttribute'
ignoreNonOVChangesWhenUpdateThroughReferencedEntity:
type: boolean
description: >-
Defines if you should send an event indicating that the
referenced entity was changed in the case when a non-OV value
was updated on a current entity. The default value is false, and
if specified, then the system works without changes. If you set
the value to true for some entity type, then during the update
of an entity of another type (which uses the first entity as a
reference attribute) the system will not send events indicating
that all entities with references to the first entity were
changed.
example: false
useOnlyOvValuesInReferencedEntities:
type: boolean
description: >-
Defines if you should use non-OV values of all attributes of the
current entity type when the entity is used as a reference
attribute.The default value is false, and if specified, then the
system works without changes. If you set the value to true, then
the inside reference attributes which refer to this entity will
use only OV values from the particular entity. In this case, if
a non-OV value is changed, then it is changed only in the
referenced entity,therefore, there is no need to send an event
to all entities which have a relation with this one.There is no
issue with searching by non-OV values because the reference
attribute will not have it.
example: false
defaultSurvivorshipStrategy:
type: string
description: >-
Name of the default survivorship strategy name to apply to
attributes of this entity type when a specific mapping does not
define one
example: Aggregation
hiddenConfiguration:
$ref: '#/components/schemas/HiddenEntityTypeConfiguration'
unmerge:
$ref: '#/components/schemas/EntityUnmerge'
groupLabels:
type: array
description: >-
The group label is “free of text” field. It will not show
existing list of group labels
example: '[''Label1'', ''Label2'']'
items:
type: string
description: Definition of particular Entity Type
Role:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: >-
Baked into the entity type object is the concept of Entity Roles. Entity
Roles provide the ability to classify entities (entity data).
For
example, you can configure roles such as Customer, Prospect, and Vendor
and then assign those roles to entities in your data set. Entities can
have multiple roles. For example, a company in your data set can be both
a customer and a vendor. You can use a single role type across different
entity types. For example, you can assign the Customer role to companies
and individuals in your data set
ExportReportError:
type: object
properties:
text:
type: string
description: The text of the error
details:
type: object
additionalProperties:
type: object
description: The details of the error
description: The model describing the error exporting the static analysis report
MappingParam:
type: object
properties:
parameter:
type: string
description: Parameter name
example: distance_miles
value:
type: string
description: Simple parameter value
example: '0.4'
values:
type: array
description: Complex parameter value
example: '{"p1":"v1", "p2":"v2"}'
items:
type: object
additionalProperties:
type: object
description: >-
Additional parameters for Match Token, Comparator or Match Action class
mapping for attributes
GenericAttributeType:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a custom generic attribute type
configuration element
example: configuration/attributeTypes/NumberSuperType
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
valueType:
type: string
description: >-
Data type of attribute.
Note: You must provide either
extendsTypeURI or valueType attributes
example: Boolean, Timestamp, Int, Dollar, Number, Long, Blob, Float, Date
matchTokenClass:
$ref: '#/components/schemas/MatchTokenClassMapping'
comparatorClass:
$ref: '#/components/schemas/ComparatorClassMapping'
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
description: >-
The Generic attribute types in Reltio allow you to define attribute
configuration and behavior options and then streamline them.
Generic
attribute types enable you to define attribute configuration and
behavior options that can be applied to groups of specified entity
attributes. Attribute types can define comparator and match token
classes.
Use generic attribute types to streamline the configuration
by reducing and centrally managing shared attribute configuration
definitions
OperandsTreePath:
type: object
properties:
path:
type: array
description: The list of operands leading the attribute
example: '["and","or","exact"]'
items:
type: string
description: The operands path to an attribute
MatchMethodLink:
type: object
properties:
uri:
type: string
retain:
type: boolean
InteractionType:
required:
- attributeModelHelperList
- attributes
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify an interaction type configuration
element
example: configuration/interactionTypes/Email
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}'
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type. One
group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on the
defined expression
items:
$ref: '#/components/schemas/RuleBasedAttribute'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
groupKeyAttributeUris:
type: array
description: >-
List of URIs for attributes that can be used as group key for this
interaction type. These attributes are used to group interactions of
this type together. For example, if the group key is
'configuration/interactionTypes/Booking/attributes/BookingId', then
all interactions of this type will be grouped by the value of the
BookingId attribute of the Booking interaction type
example: '[''configuration/interactionTypes/Booking/attributes/BookingId'']'
items:
type: string
memberTypes:
type: array
description: >-
A collection of possible member types. Examples can be: Participant,
Organizer
items:
$ref: '#/components/schemas/InteractionMemberType'
ignoreUniqueness:
type: boolean
description: >-
If true, Data Access API (part of the Analytics Spark SDK)
and Compaction (application of Analytics Jobs REST API) will not
perform uniqueness resolution (de-duplication) for interactions of
this type. If false (default), regular uniqueness resolution
is performed
example: true
hasMembers:
type: boolean
description: >-
Specifies whether the interaction type has members (true, default)
or is "memberless" (false). If an interaction type is marked as
"memberless", then Data Access API (part of the Analytics Spark SDK)
and Data Import (application of Analytics Jobs REST API) will skip
the step of joining interactions with members.
To avoid
validation errors, keep in mind that:- If true, members
must be provided in the mapping and/or data file
- If
false, members must not be provided in the mapping and/or
data file
example: true
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for which
object should be considered as active. Inactiveness for object means
that it won't appear in any search results by default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
description: >-
Interactions are lightweight objects that represent any kind of
interaction or transaction.
As a broad term, interaction stands for
an event that occurs at a particular moment such as a retail purchase,
or a measurement. It can also represent a fact in a period of time such
as a sales figure for the month of June
CombinationsConfig:
type: object
properties:
threshold:
type: integer
description: >-
Threshold for limiting the number of combinations generated. When
exceeded, the strategy is applied.
format: int32
example: 1000
strategy:
type: string
description: >-
Strategy to apply when threshold is exceeded. Options: FIRST_N,
DROP_ALL, NOOP
example: FIRST_N
enum:
- DROP_ALL
- FIRST_N
- NOOP
description: Configuration for controlling multi-attribute combinations
NegativeMatchRule:
required:
- and
- equals
- notEquals
- notExactSame
- notFuzzySame
- or
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
or:
$ref: '#/components/schemas/NegativeMatchRule'
and:
$ref: '#/components/schemas/NegativeMatchRule'
notExactSame:
type: array
items:
type: string
notFuzzySame:
type: array
items:
type: string
equals:
type: array
items:
$ref: '#/components/schemas/EqualsOperand'
notEquals:
type: array
items:
$ref: '#/components/schemas/EqualsOperand'
comparatorClasses:
$ref: '#/components/schemas/ComparatorClassMappingsArray'
nullValues:
type: array
items:
$ref: '#/components/schemas/NullValue'
comparatorClass:
type: string
RelationshipEndPoint:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a relationship startPoint/endPoint
configuration element
example: configuration/relationTypes/ParentChild/endObject
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
directionalContext:
type: array
description: Directional context
items:
$ref: '#/components/schemas/DirectionalContext'
objectTypeURI:
type: string
description: URI of the object type
example: configuration/entityTypes/Individual
description: Defines properties of start or end objects for a Relationship Type
Rating:
required:
- maxVoteWeight
- minVoteWeight
- monthsToMinWeight
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
uris:
type: array
description: List of Relationship Type uris that the configuration is applied to
example: >-
configuration/relationTypes/HasAddress,
configuration/relationTypes/Employment
items:
type: string
minVoteWeight:
type: number
description: >-
Minimum Vote Weight. Should be a number in a range [0,5] and less
than maxVoteWeight. If amount of months from current date to
updateDate of the Crosswalk is greater or equal to monthsToMinWeight
then agedSourceWeight is set to minVoteWeight.
format: double
example: 0.2
maxVoteWeight:
type: number
description: >-
Maximum Vote Weight. Should be a number in a range [0,5] and greater
than minVoteWeight
format: double
example: 4.5
monthsToMinWeight:
type: number
description: >-
Defines how many months needed a vote weight to decrease from
maximum weight to minimum weight
format: double
example: 0.8
description: >-
Defines Rating calculation parameters for a Source or a Role. Vote
weight depends on minVoteWeight, maxVoteWeight and
monthsDelta.monthsDelta = monthsToMinWeight - ." +
if monthsDelta <= 0 or monthsToMinWeight <= 0 then agedSourceWeight =
minVoteWeight," +
else agedSourceWeight = minVoteWeight + (maxVoteWeight - minVoteWeight)
* monthsDelta / monthsToMinWeight"
CandidateLookup:
type: object
properties:
lookupMethods:
type: array
items:
$ref: '#/components/schemas/CandidateLookupMethod'
description: >-
Represents a source of additional candidate pairs in the match method
definition.
AnalysisTypeProfilingPayload:
type: object
properties:
analysisType:
type: string
description: The type of the analysis
enum:
- matchToken
- matchTokenIntersections
- matchGroupsPerMatchDocument
- matchDocumentsPerMatchGroup
- matchDocumentMatches
enabled:
type: boolean
description: >-
The parameter to enable or disable the analysis of the given type,
default is 'true'
example: true
perMatchGroup:
type: boolean
description: >-
The parameter to enable or disable the analysis per each match
group. The default value is 'false' for 'matchDocumentMatches'
analysis otherwise 'true'
example: true
splitByMatchGroupType:
type: boolean
description: >-
The parameter to enable or disable the analysis per each type of the
match groups ('suspect', 'automatic' etc). The default value is
'false' for 'matchDocumentMatches' analysis otherwise 'true'
example: true
statistics:
type: array
description: The custom statistics list for the analysis
items:
$ref: '#/components/schemas/StatisticPayload'
additionalParams:
type: object
additionalProperties:
type: object
description: The block to customize the analysis of a given type
MatchAssetType:
type: object
properties:
uri:
type: string
description: >-
Path that is used to identify a common asset type configuration
element
example: configuration/entityTypes/Individual/matchAssets/EmailAsset
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
threshold:
type: integer
description: >-
A threshold value that is used to determine if a match asset becomes
a common asset
format: int32
example: 100
pattern:
type: string
description: A pattern that is used to create a match asset out of the attributes
example: ${FirstName}::${LastName}
attributes:
type: array
description: The list of attributes that are used to create a match asset
items:
$ref: '#/components/schemas/MatchAssetAttributeType'
sourceSystem:
$ref: '#/components/schemas/MatchAssetSourceSystemCondition'
description: A definition of a match asset type
ProfilingPayload:
type: object
properties:
enabled:
type: boolean
description: >-
The parameter to enable or disable the profiling, default value is
'true'
example: true
maxObjectsPerType:
type: integer
description: >-
The parameter to specify the maximum number of objects of a type are
allowed to process
format: int32
example: 10000
timeout:
type: integer
description: >-
The parameter to specify the maximum execution time for the
analysis. 3600 seconds by default
format: int32
example: 3600
samplingAlgorithm:
$ref: '#/components/schemas/SamplingAlgorithm'
analysisTypes:
type: array
description: The block to customize the analyses of different types
items:
$ref: '#/components/schemas/AnalysisTypeProfilingPayload'
inspections:
$ref: '#/components/schemas/InspectionsPayload'
email:
type: string
description: >-
The custom email address to send the information about the
completed/failed profiling analysis
example: someUser@someCompany.com
scopes:
type: array
description: The match group scopes to include in the profiling analysis
example: INTERNAL
items:
type: string
useSkippedRules:
type: boolean
description: Whether or not to use skipped rules in the profiling analysis
description: A payload for the match groups profiling (dynamic analysis)
AnalyzeMatchRulesReportLocation:
type: object
description: >-
The location of the static analysis report. One of
AnalyzeMatchRulesS3ReportLocation, AnalyzeMatchRulesGCSReportLocation
discriminator:
propertyName: type
AttributeWeight:
required:
- attribute
- weight
type: object
properties:
attribute:
type: string
description: Attribute URI to associate with specific weight
example: configuration/entityTypes/Individual/attributes/MiddleName
weight:
type: number
description: >-
Relevance weight of attribute. Allowed range is [0, Inf). Default
weight is 1 for simple attributes and 'max(weight(subAttribute1,
..., subAttributeN))' for nested attributes
format: double
example: 0.2
description: >-
Defines a mapping of attribute URI to its weight. This weight used in
match relevance calculation for relevance-based matching
MatchGroupAliasing:
type: object
properties:
mapping:
type: array
items:
$ref: '#/components/schemas/MatchGroupAliasMapping'
ActivityConfig:
type: object
properties:
uri:
type: string
description: Path that is used to reach the configuration element
example: >-
For verticals: "configuration/_vertical/verticalName". For
non-abstract configurations: "configuration"
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
attributes:
uniqueItems: true
type: array
description: Configuration of custom attributes in activity log
items:
$ref: '#/components/schemas/ActivityAttributeModel'
description: Configuration of custom attributes in activity log
EqualsOperand:
required:
- uri
type: object
properties:
uri:
type: string
description: Attribute URI
example: configuration/entityTypes/Individual/attributes/FirstName
value:
type: string
description: Value to compare with
example: John
values:
type: array
description: List of values to compare with
example: '[''Partner'', ''Customer'']'
items:
type: string
weight:
type: number
description: >-
Relevance weight of the constraint. Allowed range is [0, Inf)Default
weight is 0. Affects 'relevance_based' match rules only
format: double
example: 0.2
strict:
type: boolean
description: >-
The parameter to control whether the constraint needs to meet to
generate match token phrases and compute the relevance score.
Affects 'relevance_based' match rules only
example: false
checkNulls:
type: boolean
description: >-
The parameter shows on how to result of constraint affects on
comparison. Affects only on exactOrNull operand, if set to true and
attribute doesn't fit the condition comparison process matches the
attribute as null value. By default the parameter is set to true.
example: false
description: >-
This operator selects entities for matching that are based on the
attribute value or values that are equal to the ones you specify
MatchAction:
required:
- mapping
- name
type: object
properties:
name:
type: string
description: >-
Short name, alias of match action. This name can be used in
matchGroup type or in relevance-based rules as identifier of custom
match action
example: custom_suspect
mapping:
type: array
description: >-
Defines mapping of action handler classes and parameters for them.
Several handlers could be assigned for one action.
items:
$ref: '#/components/schemas/MatchActionMapping'
description: >-
Custom match action to define an additional action where a pair can be
identified as having a link and it can be published to the external
queue. The consumer of this pair outside Reltio can then decide whether
a relationship exists between the pair.
MatchMethodPrerequisites:
type: object
properties:
rules:
type: array
description: >-
Defines a list of matching criteria used to evaluate other Match
Groups before the current Match Group. Each rule specifies which
Match Groups from the `filters` should be matched to compare results
with the `scoreThreshold` to make a decision from the `onMatch`
attribute.These rules are applied sequentially.
items:
$ref: '#/components/schemas/MatchMethodPrerequisiteRule'
description: >-
Match Group's eligibility for continued operation will depend on the
evaluation of these prerequisites, which may result in either approval
to proceed or a complete cessation of operations.
AnalyzeMatchRulesV2Response:
type: object
properties:
staticAnalysisReports:
type: array
description: >-
The information about the locations containing the static analysis
reports
items:
$ref: '#/components/schemas/ExportedReportLocation'
staticAnalysis:
type: array
description: The static analysis results for the entity types
items:
$ref: '#/components/schemas/EntityMatchGroupsAnalysis'
profiling:
$ref: '#/components/schemas/ProfilingAnalysisSubmissionResponse'
description: The match rules analysis (V2) response
CompositeMatchMethodParticipants:
type: object
properties:
links:
type: array
items:
$ref: '#/components/schemas/MatchMethodLink'
weightingAlgorithm:
$ref: '#/components/schemas/MatchMethodsWeightingAlgorithm'
ComparatorClassMapping:
required:
- clazz
type: object
properties:
attribute:
type: string
description: Attribute or multi-group URI
example: configuration/entityTypes/Location/attributes/GeoLocationMulti
clazz:
type: string
description: >-
Comparator fully qualified class name.
Comparator
classes
- com.reltio.match.comparator.BasicStringComparator
- When two values are compared and the java equals operation returns
True, this class returns True. This is the default class for
attribute values defined in the exact, exactOrNull, and
exactOrAllNull sections. If no comparator class is specified for the
match rule, then this class is used by
default.
- com.reltio.match.comparator.DamerauLevenshteinDistance
- This class returns true if Damerau-Levenshtein distance between
two values is less than a defined constant:
- 1 for strings
with length <= 4
- 2 for strings with length > 4
This
class is default for attributes identified for fuzzy
comparison. - com.reltio.match.comparator.DynamicDamerauLevenshteinDistance
- This is an extension of the Damerau-Levenshtein distance
comparator with different distance values as follows:
- 1 for
strings with length <=6
- 2 for strings with length > 6 and <=
10
- 3 for strings with length > 10 and <= 20
- 4 for
strings with length > 20 and <= 30
- 5 for strings with length
>
30
- com.reltio.match.comparator.MetaphoneComparator
- Comparator returns true if two strings are phonetically equal
based on Metaphone
algorithm.
- com.reltio.match.comparator.DoubleMetaphoneComparator
- Comparator returns true if two strings are phonetically equal
based on the DoubleMetaphone algorithm. This comparator can be used
only for Latin
characters.
- com.reltio.match.comparator.SoundexComparator
- Comparator returns true if two strings are phonetically equal
based on the Soundex
algorithm.
- com.reltio.match.comparator.StringCharactersComparator
- Comparator returns true if two strings have the same set of
alphabetical characters. All non-alphabetical characters and spaces
are ignored. This comparison is
case-insensitive.
- com.reltio.match.comparator.StringComparatorIgnoringNulls
- Comparator returns true if two strings are equal ignoring case,
except in these two cases:
- if both strings equal empty
strings, comparator returns false.
- if both strings equal
null, comparator returns
false.
- com.reltio.match.comparator.OrganizationNamesComparator
- Compares two organization names by using the following
steps:
- Attribute value is split into separate words and
words, such as 'inc', 'corp', 'services', and so on are ignored
during comparison.
- Comparator compares the words list. If
there are at least 60% of the same words in the words list received
in the first step, then values are considered the
same.
- com.reltio.match.comparator.AddressLineComparator
- Compares two AddressLine1 attribute values. The comparator cleans
the Address Line from garbage words (such as 'ave', 'ste', etc.),
then it compares the strings ignoring
case.
- com.reltio.match.comparator.RangeNumericComparator
- This class compares attributes that have numeric values of type
Int, Integer, Number, and Double.
Parameters:
- threshold - The value of this parameter can be a
number or percentage value, for example, 0.25 or 10%. This value
indicates the maximum acceptable difference for the comparison to
evaluate to
True.
- com.reltio.match.comparator.BasicTokenizedOrganizationNameComparator
- Compares two organization names. Recommended to use for
Organization names since 2015.1. Comparison is done in two
steps:
- Comparator normalizes each value. Value is split into
separate words. All meaningless ('inc', 'corp', 'services', etc.)
words are removed from the words list.
- Comparator compares
the words list. If there are at least 60% of the same words in the
words list obtained in the first step, then the values are
considered the
same.
- com.reltio.match.comparator.CustomComparator
- This comparator is a container for other comparators. It
preprocesses the values and passes them to the nested comparators.
For the comprehensive guide how to configure the comparator please
refer to the official Reltio
documentation.
- com.reltio.match.comparator.DistinctWordsComparator
- Compares values by distinct words based on the parameters
specified. For the comprehensive guide how to configure the
comparator please refer to the official Reltio
documentation.
- com.reltio.match.comparator.ProximateGeoComparator
- Checks whether the two geo points are located closer than the
configured 'distance_miles' parameter.
Please refer to
the official Reltio documentation for more information about the
comparator classes, their parameters, use cases, corresponding match
token classes
parameters:
type: array
description: Additional comparator class parameters
items:
$ref: '#/components/schemas/MappingParam'
description: >-
Comparator class mapping for attributes. If mapping not defined
BasicStringComparator will be used.
AttributeSerializable:
type: object
properties:
path:
type: array
description: The path in the match group to the attribute
example: '["and","exact"]'
items:
type: string
nested:
type: boolean
description: The value showing if the attribute is nested
weight:
type: number
description: The value showing the weight of the attribute
format: double
description: The description of an attribute participating in the match group
GraphType:
required:
- attributeModelHelperList
- relationshipTypeUris
- attributes
type: object
properties:
uri:
type: string
description: Path that is used to identify a graph type configuration element
example: configuration/graphTypes/CompanyHierarchy
label:
type: string
description: Readable name for the configuration element
example: Test configuration element
description:
type: string
description: >-
Freeform verbose explanation of the part of the configuration where
this description appears
example: Test configuration element used to describe Configuration API format
dataPipelineTypeConfig:
$ref: '#/components/schemas/DataPipelineTypeConfig'
geoLocationAttributes:
type: array
description: Geolocation attributes definitions list of current object type
items:
$ref: '#/components/schemas/GeoLocationAttribute'
dataTooltipPattern:
type: string
description: >-
Pattern that is used to build the entity object's tooltip. Can
include static text as well as patterns-attributes in curly
brackets.
example: 'Tooltip: {configuration/entityTypes/Individual/attributes/FullName}'
typeColor:
type: string
description: Color that will be used to visualize this object type
example: '#00FF00'
survivorshipGroups:
type: array
description: >-
List of survivorship groups which belong to this object type. One
group in this list must be marked as default.
items:
$ref: '#/components/schemas/SurvivorshipGroup'
ruleBasedAttributes:
type: array
description: >-
Rules that can be used to define show dependent fields based on the
defined expression
items:
$ref: '#/components/schemas/RuleBasedAttribute'
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
relationshipTypeUris:
type: array
description: Relationship types to be displayed in the graph
example: >-
configuration/relationTypes/Parent,
configuration/relationTypes/Child
items:
type: string
graphStructureName:
type: string
description: Graph Structure
example: hierarchy
enum:
- tree
- hierarchy
- network
rootEntityType:
type: string
description: Type of the Graph root
example: configuration/entityTypes/Individual
type:
type: string
description: Type
example: logical
layout:
type: string
description: Layout
example: hierarchy
allowCycles:
type: boolean
description: Allow cycles
example: true
extendsTypeURI:
type: string
description: >-
URI of generic attribute type that is extended by this attribute
type.
Note it is required to provide one of
extendsTypeURI or valueType attributes
example: configuration/attributeTypes/OrganizationName
cleanseConfig:
$ref: '#/components/schemas/CleanseInfo'
attributes:
type: array
description: Attributes definitions list of current object type
items:
$ref: '#/components/schemas/Attribute'
activenessAttributes:
type: array
description: >-
Objects dynamics functionality allows to specify a period for which
object should be considered as active. Inactiveness for object means
that it won't appear in any search results by default.
example: >-
[{"uri":
"configuration/entityTypes/Individual/attributes/DoB","type":
"start"}]
items:
$ref: '#/components/schemas/ActivenessAttribute'
surrogateCrosswalks:
type: array
description: List of surrogate crosswalks defined for this object type
items:
$ref: '#/components/schemas/SurrogateCrosswalkConfig'
defaultFacetedAttributes:
type: array
description: List of attributes that should be faceted for this object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
defaultSearchAttributes:
type: array
description: >-
List of attributes that should be searchable dy default for this
object type
example: >-
['configuration/entityTypes/HCP/attributes/FirstName',
'configuration/entityTypes/HCP/attributes/LastName']
items:
type: string
description: >-
The Graph type defines a hierarchical structure you can use to model a
tree of entities and is usually displayed on an profile page using the
Hierarchy facet.
A tree of data will populate within the facet
anytime the entity that you have navigated to (that is, the base entity
of the current profile page you are on) is a member of the tree. If it
is not, then the facet will contain no data.
A Graph is naturally
heterogeneous meaning that it can be composed of different entity types
and different relationship types. It can even support entities that have
multiple parents. A branch that has multiple parents is shown with a
special indicator. The user is able to click the indicator and
understand the multiple parents.
Once you have defined the graph type
within your tenant configuration, you must configure the Hierarchy facet
within the UI Configuration. The UI facet must be configured to support
all of the parent-child relationships and entity types you wish
displayed within the facet.
MatchRuleCleanseInfo:
required:
- cleanseAdapter
type: object
properties:
cleanseAdapter:
type: string
description: Fully qualified java name of the matching engine cleanser
example: com.reltio.cleanse.impl.NameDictionaryCleanser
cleanseAdapterParams:
type: object
additionalProperties:
type: object
description: >-
Defined parameters with their values that are passing to
cleanseAdapter
example: >-
{'dictionary': 'SynonymFirstNamesNA_2020-09-01',
'keepOriginalValue': 'false'}
mappings:
type: array
description: >-
Defines a list of attributes mappings being processed by
cleanseAdapter. If mappings are not required, use
attributes
items:
$ref: '#/components/schemas/CleanseAttributeMapping'
attributes:
type: array
description: >-
Defines a list of attributes being processed by
cleanseAdapter. If the attributes need to be mapped, use
mappings
items:
type: string
description: Defines attribute cleanse parameters for matching
MatchMethodPrerequisiteRule:
type: object
properties:
onMatch:
type: string
description: >-
Option to classify a rule as external only or internal only.
Provides information about how to enable and disable match rules. By
default, 'EVALUATE'
example: EVALUATE
enum:
- '[''EVALUATE'''
- '''SKIP'']'
scoreThreshold:
type: string
description: >-
Weight range: floating point numbers separated by '-'. Allowed range
for start and end values is [0, 1]. Default: [1, 1]
example: 0.5-1.0
evaluationContinuation:
type: boolean
description: >-
Indicates that the condition is essential, and no further
evaluations will occur if the condition is unmet. Default: true
example: true
filters:
type: array
description: >-
Filters to resolve into a set of Match Groups. These filters are
applied sequentially.
items:
$ref: '#/components/schemas/MatchMethodPrerequisiteRuleFilter'
description: >-
Specifies which Match Groups from the `filters` should be matched to
compare results with the `scoreThreshold` to make a decision from the
`onMatch` attribute.
PrecisionResult:
type: object
properties:
status:
type: string
description: The current status of the analysis job
example: PROCESSING
enum:
- PROCESSING
- COMPLETED
- FAILED
- SCHEDULED
startTimestamp:
type: integer
description: The start time of the analysis job
format: int64
example: 1610748891486
finishTimestamp:
type: integer
description: The finish time of the analysis job
format: int64
example: 1610748901486
duration:
type: integer
description: The duration of the analysis job
format: int64
example: 10000
totalObjectsProcessed:
type: integer
description: The total number of processed objects
format: int64
example: 10000
objectsProcessed:
type: object
additionalProperties:
type: integer
format: int64
description: The number of processed objects by type
entityTypes:
type: array
description: The list of the match precision results for every entity type
items:
$ref: '#/components/schemas/EntityTypePrecisionResult'
description: The result of the match precision analysis for the tenant
MatchPrecision:
type: object
properties:
truePositive:
type: number
description: >-
The proportion of true positive matches out of the total positive
match labels
format: double
example: 0.8735
falsePositive:
type: number
description: >-
The proportion of false positive matches out of the total negative
match labels
format: double
example: 0.8735
falseNegative:
type: number
description: >-
The proportion of false negative matches out of the total positive
match labels
format: double
example: 0.8735
truePositiveNumber:
type: integer
description: The number of true positive matches
format: int32
example: 83
falsePositiveNumber:
type: integer
description: The number of false positive matches
format: int32
example: 83
falseNegativeNumber:
type: integer
description: The number of false negative matches
format: int32
example: 83
description: Match Precision for a single match method or an entire entity type
MatchMethodPrecisionResult:
type: object
properties:
methodName:
type: string
description: The name of the match method
example: ByFirstNameAndLastName
methodPrecision:
$ref: '#/components/schemas/MatchPrecision'
description: The result of the match groups precision analysis for the entity type
EntityTypePrecisionResult:
type: object
properties:
entityType:
type: string
description: The URI of the entity type
example: configuration/entityTypes/Location
entityTypePrecision:
$ref: '#/components/schemas/MatchPrecision'
methodPrecisionResults:
type: array
description: The match precisions for the match methods of the entity type
items:
$ref: '#/components/schemas/MatchMethodPrecisionResult'
description: The result of the match groups precision analysis for the entity type
ProjectionProfilingResult:
type: object
properties:
type:
type: string
description: The type of the subset
example: match-group-all
enum:
- match-group-all
- match-group-single
- match-group-type-automatic
- match-group-type-suspect
- match-group-type-relevance_based
- match-group-type-*
matchGroups:
type: array
description: The match groups participating in the analysis
items:
$ref: '#/components/schemas/MatchGroupRepresentation'
statistics:
type: array
description: The statistics collected by the analysis
items:
$ref: '#/components/schemas/StatisticProfilingResult'
inspections:
type: array
description: The inspection results obtained by the analysis
items:
$ref: '#/components/schemas/ProfilingInspectionResult'
description: The profiling result for a subset of the match groups
ProfilingInspectionResult:
type: object
properties:
uid:
type: string
description: Unique identifier of the inspection result
example: 8-a3b118b7-3699-4942-a61b-28d7151198a6
inspectionId:
type: string
description: The identifier of the inspection
example: tooManyTokens
enum:
- tooManyTokens
- tooManyMatches
- veryFewTokens
- uselessMatchGroups
- overcollisionedTokens
- highlyCorrelatedMatchGroups
parameters:
type: array
description: List of the inspection parameters
items:
$ref: '#/components/schemas/ProfilingInspectionParameter'
computationResults:
type: array
description: List of the inspection computation results
items:
$ref: '#/components/schemas/ProfilingInspectionComputationResult'
profilingInspectionSummary:
$ref: '#/components/schemas/ProfilingInspectionSummary'
profilingInspectionExplanation:
$ref: '#/components/schemas/ProfilingInspectionExplanation'
profilingInspectionRecommendation:
$ref: '#/components/schemas/ProfilingInspectionRecommendation'
description: The results of an applied inspection
EntityTypeProfilingResult:
type: object
properties:
entityType:
type: string
description: The URI of the entity type
example: configuration/entityTypes/Location
analyses:
type: array
description: The list of analyses of different types applied
items:
$ref: '#/components/schemas/AnalysisTypeProfilingResult'
description: The result of the match groups profiling analysis for the entity type
ProfilingInspectionSummary:
type: object
properties:
text:
type: string
parameters:
type: array
items:
$ref: '#/components/schemas/ProfilingInspectionMessageParameter'
allOf:
- $ref: '#/components/schemas/ProfilingInspectionMessage'
- type: object
properties:
severity:
type: string
description: The severity of the inspection result
example: ERROR
enum:
- ERROR
- WARNING
- INFO
description: The profiling inspection summary
ProfilingInspectionExplanation:
type: object
properties:
text:
type: string
parameters:
type: array
items:
$ref: '#/components/schemas/ProfilingInspectionMessageParameter'
allOf:
- $ref: '#/components/schemas/ProfilingInspectionMessage'
- type: object
description: The profiling inspection explanation
ProfilingInspectionParameter:
type: object
properties:
name:
type: string
description: The name of the parameter
value:
type: object
description: The value of the parameter
description: The profiling inspection parameter
ProfilingInspectionMessageParameter:
type: object
properties:
id:
type: string
description: The identifier of the parameter, unique within the message
example: '1'
type:
type: string
description: The type of the parameter
example: matchGroupUri
enum:
- number
- percentage
- matchGroupUri
- text
value:
type: object
description: The value of the parameter
example: configuration/entityTypes/Location/matchGroups/AutoMatch
description: The profiling inspection message parameter
MatchGroupRepresentation:
type: object
properties:
uri:
type: string
description: The URI of the match group
example: configuration/entityTypes/Location/matchGroups/AutoMatch
label:
type: string
description: The label of the match group
example: Automatic on load Addresses match
type:
type: string
description: The type of the match group
example: automatic
scope:
type: string
description: The scope of the match group
example: ALL
enum:
- NONE
- EXTERNAL
- INTERNAL
- ALL
- ML_MATCH
useOvOnly:
type: string
description: The 'useOvOnly' of the match group
example: 'true'
scoreStandalone:
type: integer
description: The 'scoreStandalone' of the match group
format: int32
example: 20
scoreIncremental:
type: integer
description: The 'scoreIncremental' of the match group
format: int32
example: 30
description: The basic information about the match group
AnalysisTypeProfilingResult:
type: object
properties:
analysisType:
type: string
description: The name of the analysis
example: matchToken
enum:
- matchToken
- matchTokenIntersections
- matchGroupsPerMatchDocument
- matchDocumentsPerMatchGroup
- matchDocumentMatches
enabled:
type: boolean
description: The value shows if the analysis of the type was enabled
example: true
perMatchGroup:
type: boolean
description: >-
The value shows if the analysis of the type was enabled per each
match group
example: true
splitByMatchGroupType:
type: boolean
description: >-
The value shows if the analysis of the type was enabled per each
type of the match groups
example: true
projections:
type: array
description: >-
The list of the profiling results obtained for the subsets of match
groups
items:
$ref: '#/components/schemas/ProjectionProfilingResult'
description: The result of the match groups profiling analysis of a given type
ProfilingInspectionRecommendation:
type: object
properties:
text:
type: string
parameters:
type: array
items:
$ref: '#/components/schemas/ProfilingInspectionMessageParameter'
allOf:
- $ref: '#/components/schemas/ProfilingInspectionMessage'
- type: object
description: The profiling inspection recommendation
ProfilingInspectionComputationResult:
type: object
properties:
name:
type: string
description: The name of the computation result
value:
type: object
description: The value of the computation result
values:
type: array
description: The composite values of the computation result
items:
type: object
description: The computation result of the profiling inspection
ProfilingResult:
type: object
properties:
status:
type: string
description: The current status of the analysis job
example: PROCESSING
enum:
- PROCESSING
- COMPLETED
- FAILED
- SCHEDULED
startTimestamp:
type: integer
description: The start time of the analysis job
format: int64
example: 1610748891486
finishTimestamp:
type: integer
description: The finish time of the analysis job
format: int64
example: 1610748901486
duration:
type: integer
description: The duration of the analysis job
format: int64
example: 10000
totalObjectsProcessed:
type: integer
description: The total number of processed objects
format: int64
example: 10000
objectsProcessed:
type: object
additionalProperties:
type: integer
format: int64
description: The number of processed objects by type
scopes:
type: array
description: The match group scopes included in the profiling analysis
example: INTERNAL
items:
type: string
enum:
- NONE
- EXTERNAL
- INTERNAL
- ALL
- ML_MATCH
useSkippedRules:
type: boolean
description: Whether or not skipped rules were included in the profiling analysis
entityTypes:
type: array
description: The list of the profiling results for every entity type
items:
$ref: '#/components/schemas/EntityTypeProfilingResult'
description: The result of the match groups profiling analysis for the tenant
StatisticProfilingResult:
type: object
properties:
name:
type: string
description: The name of the statistic
example: mean
parameters:
type: object
additionalProperties:
type: object
description: The parameters of the statistic
value:
type: object
description: The value of the statistic
example: '10.0'
details:
type: object
description: The additional results of the statistic
description: The result for the applied statistic
ProfilingInspectionMessage:
type: object
properties:
text:
type: string
description: >-
The text of the message. The text might contain placeholders which
corresponds to the parameters of the message
example: >-
Based on the number of entities producing the same token phrase, the
performance of your tenant will likely be impacted.
parameters:
type: array
description: The parameters of the message
items:
$ref: '#/components/schemas/ProfilingInspectionMessageParameter'
description: The profiling inspection message
discriminator:
propertyName: type
OperationStatusString:
type: object
properties:
successful:
type: boolean
error:
type: string
result:
type: string
message:
type: string
RuleBasedAttribute:
type: object
properties:
uri:
type: string
label:
type: string
description:
type: string
extendsTypeUri:
type: string
name:
type: string
type:
type: string
controlFunction:
$ref: '#/components/schemas/RuleBasedAttributeControlFunction'
SimpleAttributeValueTO:
required:
- value
type: object
allOf:
- $ref: '#/components/schemas/AttributeValueTO'
- required:
- value
type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes,relationTypes}/Individual/attributes/FirstName
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities,relations}/liugfgU/attributes/FirstName/NiyjVY90'
value:
type: string
description: Value of attribute
example: Ilya
description: Simple Attribute Object
NestedAttributeValueTO:
type: object
properties:
value:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
anyOf:
- $ref: '#/components/schemas/SimpleAttributeValueTO'
- $ref: '#/components/schemas/NestedAttributeValueTO'
description: Attributes of Nested Attribute
nullable: true
readOnly: false
writeOnly: false
extensions: {}
allOf:
- $ref: '#/components/schemas/AttributeValueTO'
- type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: configuration/{entityTypes|relationTypes}/Party/attributes/Phone
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities|relations}/liugfgU/attributes/Phone/NiyjVY90'
description: >-
Nested Attribute is a object which can contain another
interconnected attributes. NestedAttributeValueTO can contain
NestedAttributeValueTO and SimpleAttributeValueTO.
ActivenessAttributeModelHelper:
type: object
properties:
uri:
type: string
type:
type: string
AttributeModelHelper:
required:
- name
- type
type: object
properties:
uri:
type: string
label:
type: string
columnName:
type: string
name:
type: string
description:
type: string
type:
type: string
valueType:
type: string
lookupCode:
type: string
dependentLookupAttributes:
type: array
items:
type: string
resolveLookupCode:
type: boolean
hidden:
type: boolean
important:
type: boolean
system:
type: boolean
required:
type: boolean
dataLabelPattern:
type: string
faceted:
type: boolean
searchable:
type: boolean
maxOccurs:
type: integer
format: int32
autoGenerated:
type: boolean
generator:
type: string
autoGenerationPattern:
type: string
generateIfEmpty:
type: boolean
generateIfNotEmpty:
type: boolean
generatedValueUniqueForCrosswalk:
type: boolean
autoGenerationNestedPattern:
type: object
additionalProperties:
type: string
values:
type: array
items:
type: string
referencedAttributeURIs:
type: array
items:
type: string
immutableForSources:
uniqueItems: true
type: array
items:
type: string
immutableExceptForSources:
uniqueItems: true
type: array
items:
type: string
immutable:
type: boolean
doNotOverrideForSourceURIs:
type: array
items:
type: string
keyAttributeURIs:
type: array
items:
type: string
keyAttributeURIsExactOrNull:
type: array
items:
type: string
keyAttributeURIsExactOrAllNull:
type: array
items:
type: string
keyAttributeURIsIgnoreCase:
type: boolean
matchFieldURIs:
type: array
items:
type: string
matchFieldURIsExactOrNull:
type: array
items:
type: string
matchFieldURIsExactOrAllNull:
type: array
items:
type: string
matchFieldURIsIgnoreCase:
type: boolean
matchOvOnly:
type: boolean
singleValue:
type: boolean
singleValueByCrosswalk:
type: boolean
singleValueByCrosswalkSources:
$ref: '#/components/schemas/SingleValueByCrosswalkSources'
referencedEntityTypeUri:
type: string
relationshipTypeUri:
type: string
referenceAttributeDirection:
type: string
relationshipLabelPattern:
type: string
survivorshipStrategy:
type: string
attributeOrdering:
$ref: '#/components/schemas/OrderingStrategy'
attributeMasking:
$ref: '#/components/schemas/AttributeMasking'
attributes:
type: array
items:
$ref: '#/components/schemas/AttributeModelHelper'
dataLabelPatternHolder:
$ref: '#/components/schemas/LocalizablePatternHolder'
cardinality:
$ref: '#/components/schemas/Cardinality'
defaultValue:
type: object
skipInDataAccess:
type: boolean
customReltioId:
type: boolean
vectorized:
type: boolean
indexingConfig:
$ref: '#/components/schemas/IndexingConfig'
enableNestedPartialOverride:
type: boolean
AttributeMasking:
type: object
properties:
regexPattern:
type: string
maskMatched:
type: boolean
RuleBasedAttributeControlFunction:
type: object
properties:
uri:
type: string
label:
type: string
description:
type: string
extendsTypeUri:
type: string
expression:
type: string
showAttributeURI:
type: array
items:
type: string
AttributeValueTO:
type: object
properties:
type:
type: string
description: Type of attribute
readOnly: true
example: >-
configuration/{entityTypes|relationTypes}/Individual/attributes/FirstName
ov:
type: boolean
description: Is value OV?
example: false
value:
type: string
description: Attribute value
example: HCP AddressLine1 01
uri:
type: string
description: URI of Attribute
readOnly: true
example: '{entities|relations}/liugfgU/attributes/FirstName/NiyjVY90'
description: >-
Super model for NestedAttributeValueTO, ReferenceAttributeValueTO,
SimpleAttributeValueTO for Attribute item
extensions:
x-original-swagger-version: '2.0'