openapi: 3.0.1 info: title: Operate description: >- Run various operations on the data - modify, update, read, search, match, merge and more. contact: name: Reltio url: http://www.reltio.com email: support@reltio.com version: '2020.2' extensions: {} servers: - url: / security: [] tags: '0': name: Address APIs '1': name: Common Assets '2': name: Workflow '3': name: Entities '4': name: Lineage '5': name: Match '6': name: Graph '7': name: Interactions '8': name: Merge & Unmerge '9': name: Attribute Verification '10': name: Segments '11': name: Crosswalks '12': name: Reference Data Management '13': name: Saved Search '14': name: Relationships '15': name: File Based Search paths: /services/jobs/export/{tenantId}/activities: post: tags: - Export summary: Exports activities from a tenant description: >- This API exports activities from a tenant, uploads a CSV file or JSON file to the appropriate storage, and sends a link to the exported data (if post-processing is enabled and the partSize parameter was not specified) or a link to the Export Console UI page (in the other cases) to your email address.

Note: For details about S3, GCS, or an Azure Storage destination for export, please see Storing Export Results. Only one storage destination can be specified for one export request.

By default, the Activity Log Export API returns results for the last four months. To retrieve data for a different time range, specify the filter query parameter for timestamp. For example, by using the filter=gt(timestamp,1560800276000) query, all activities more recent than June 17, 2019, 7:37:56 PM are returned. The timestamp must be mentioned in milliseconds.

Note: As a best practice, we recommend that you specify the time period filter when searching/exporting the activity log data.

Retention, exporting, and searching against the activity log data is governed by Quotas and Limits. For more information, please see Quotas and Limits. operationId: exportActivitiesByTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: s3Bucket in: header description: > Custom storage destination: S3

Indicates the S3 bucket by name schema: type: string example: reltio-data-exports - name: s3Region in: header description: > Custom storage destination: S3

Indicates the S3 region. Specify the S3 region parameter to bypass region autodetection schema: type: string example: cn-north-1 - name: s3Path in: header description: > Custom storage destination: S3

Indicates the S3 path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: s3Sse in: header description: > Custom storage destination: S3

Indicates the server–side encryption algorithm (AES256 or aws:kms). The parameter is ignored if the s3Bucket parameter is not specified (export to Reltio bucket) schema: type: string example: aws:kms - name: s3SseKmsKey in: header description: > Custom storage destination: S3

Indicates the custom KMS key for server side encryption schema: type: string example: arn:aws:kms:us-east-1:0:key/1 - name: awsAccessKey in: header description: > Custom storage destination: S3

Indicates the AWS access key ID. The account must have Write permissions for the S3 destination schema: type: string example: AKIAIOSFODNN7EXAMPLE - name: awsSecretKey in: header description: > Custom storage destination: S3

Indicates the AWS secret key schema: type: string example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY - name: roleArn in: header description: > Custom storage destination: S3

Indicates the AWS role for cross-account secured export schema: type: string example: arn:aws:iam::123456789012:role/S3Access - name: externalId in: header description: > Custom storage destination: S3

Additional security over delegate role access (Assume Role) to control the access to custom S3 bucket schema: type: string example: Service-54823 - name: gcsBucket in: header description: > Custom storage destination: GCS

Indicates the GCS bucket by name schema: type: string example: reltio-data-exports - name: gcsPath in: header description: > Custom storage destination: GCS

Indicates the GCS path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: gcpCredentials in: header description: > Custom storage destination: GCS

Indicates the GCP credentials JSON. The account must have Write permissions on the GCS destination schema: type: string example: >- {"type":"service_account","project_id":"xxx","private_key_id":"xxx", ... } - name: azureStorageContainer in: header description: > Custom storage destination: Azure Storage

Indicates the Azure container schema: type: string example: reltio-data-exports - name: azureStorageAccountName in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: azurestorageaccountname - name: azureStorageAccountKey in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: YXp1cmVTdG9yYWdlQWNjb3VudEtleQExampleKey== - name: email in: query description: > This parameter indicates the comma-separated list of custom email addresses to which the notification is sent after the export is completed. If the parameter is not specified, the Export Service notifies the Reltio user who submitted the export request schema: type: string example: user@example.com - name: dateFormat in: query description: > This parameter indicates the format of the date and time attribute values schema: type: string default: TIMESTAMP enum: - TIMESTAMP - READABLE - name: fileFormat in: query description: > This parameter defines what output format must be used for export. Note that export to JSON is more efficient compared to export to CSV schema: type: string default: CSV enum: - CSV - JSON - name: distributed in: query description: > This parameter is applied only for Export Version 1. If set to true, then the export task is divided into parts that can be executed in parallel on different nodes. If not specified, then one task is created schema: type: boolean default: false - name: taskPartsCount in: query description: > This parameter is applied only for Export Version 1. It indicates the number of distributed task parts. This parameter is used only when the distributed parameter is set to true. If not specified, then auto-calculated number of tasks are created schema: type: integer default: 2 - name: filter in: query description: > This parameter indicates a filter condition to filter activity log items.
The format is the same as that for the ActivityLogRecordsSearch request. For more information, see Filtering Activities schema: type: string example: >- gt(timestamp,1560800276000) and equals(items.data.type, 'RELATIONSHIP_CHANGED') - name: partSize in: query description: > This parameter indicates a human-readable part size. The Export Service splits result files depending on this setting. For more information, please see Export Data into Multiple Files schema: type: string example: 1gb - name: name in: query description: > This parameter indicates a name of the export task displayed in the task status. The name is also used by the Export UI. For more information, please see Naming an Export Job schema: type: string example: Export-1 - name: skipPostprocessing in: query description: > During data extraction, the Export Service generates multiple smaller in size, partial files that contain export results. If this parameter is enabled, the Export Service returns links to these files as the result, and the partSize parameter is ignored. Otherwise, the Export Service combines the partial files into one or several files depending on the partSize parameter and returns links to the combined files as the result. The default value is false for Export Version 1 and true for Export Version 2 schema: type: boolean example: true - name: filenameTemplate in: query description: > It defines a filename template that will be used to generate filenames. A filename template might contain the {{n}} placeholder, the Export Service will replace that placeholder with actual file numbers. If the placeholder is not specified, the Export Service will add file numbers at the end of filenames.
Allowed characters: a-z, A-Z, 0-9, _, -
Max length: 512
A filename template cannot be empty:
"" - invalid
"x{{n}}" - valid

Examples:
filenameTemplate → result files:
unspecified → part-00000.zip, part-00001.zip, part-00002.zip, ...
export-file → export-file-00000.zip, export-file-00001.zip, export-file-00002.zip, ...
results-{{n}} → results-00000.zip, results-00001.zip, results-00002.zip, ... schema: type: string example: export-file requestBody: description: >- Object containing the filter parameter for activity log export

Note: If the filter parameter is present in the query and body, the query/filter parameter has priority and overrides the body/filter parameter content: application/json: schema: $ref: '#/components/schemas/ActivityExportBody' required: false responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/TaskStatus' example: groupId: d04b0318-44cb-411c-8860-7291070a14ba exportType: ACTIVITY_LOG version: v2 status: scheduled details: >- Export job has been scheduled. Result will be sent to your email: user@example.com taskIds: - 19387291-7b1c-4816-becb-da6910b2500a '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIErrorRepresentation' example: severity: Error errorMessage: >- Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. errorCode: 549 errorDetailMessage: >- Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. innerErrorData: exception: >- com.reltio.metadata.errors.CommonException:Code: EXPORT_DATA_INVALID_PARAM; Message parameters: [filenameTemplate, filenameTemplate cannot be empty]. Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty.. Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. '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 '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. 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: export x-controllerName: com.reltio.export.rest.controller.ExportController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Data%20Operation#/Export/exportActivitiesByTenant /services/jobs/export/{tenantId}/entities: post: tags: - Export summary: Exports entities from a tenant description: >- This API exports entities from a tenant, uploads a CSV file or JSON file to the appropriate storage, and sends a link to the exported data (if post-processing is enabled and the partSize parameter was not specified) or a link to the Export Console UI page (in the other cases) to your email address.

Note: For details about S3, GCS, or an Azure Storage destination for export, please see Storing Export Results. Only one storage destination can be specified for one export request.

operationId: exportEntitiesByTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: s3Bucket in: header description: > Custom storage destination: S3

Indicates the S3 bucket by name schema: type: string example: reltio-data-exports - name: s3Region in: header description: > Custom storage destination: S3

Indicates the S3 region. Specify the S3 region parameter to bypass region autodetection schema: type: string example: cn-north-1 - name: s3Path in: header description: > Custom storage destination: S3

Indicates the S3 path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: s3Sse in: header description: > Custom storage destination: S3

Indicates the server–side encryption algorithm (AES256 or aws:kms). The parameter is ignored if the s3Bucket parameter is not specified (export to Reltio bucket) schema: type: string example: aws:kms - name: s3SseKmsKey in: header description: > Custom storage destination: S3

Indicates the custom KMS key for server side encryption schema: type: string example: arn:aws:kms:us-east-1:0:key/1 - name: awsAccessKey in: header description: > Custom storage destination: S3

Indicates the AWS access key ID. The account must have Write permissions for the S3 destination schema: type: string example: AKIAIOSFODNN7EXAMPLE - name: awsSecretKey in: header description: > Custom storage destination: S3

Indicates the AWS secret key schema: type: string example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY - name: roleArn in: header description: > Custom storage destination: S3

Indicates the AWS role for cross-account secured export schema: type: string example: arn:aws:iam::123456789012:role/S3Access - name: externalId in: header description: > Custom storage destination: S3

Additional security over delegate role access (Assume Role) to control the access to custom S3 bucket schema: type: string example: Service-54823 - name: gcsBucket in: header description: > Custom storage destination: GCS

Indicates the GCS bucket by name schema: type: string example: reltio-data-exports - name: gcsPath in: header description: > Custom storage destination: GCS

Indicates the GCS path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: gcpCredentials in: header description: > Custom storage destination: GCS

Indicates the GCP credentials JSON. The account must have Write permissions on the GCS destination schema: type: string example: >- {"type":"service_account","project_id":"xxx","private_key_id":"xxx", ... } - name: azureStorageContainer in: header description: > Custom storage destination: Azure Storage

Indicates the Azure container schema: type: string example: reltio-data-exports - name: azureStorageAccountName in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: azurestorageaccountname - name: azureStorageAccountKey in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: YXp1cmVTdG9yYWdlQWNjb3VudEtleQExampleKey== - name: email in: query description: > This parameter indicates the comma-separated list of custom email addresses to which the notification is sent after the export is completed. If the parameter is not specified, the Export Service notifies the Reltio user who submitted the export request schema: type: string example: user@example.com - name: dateFormat in: query description: > This parameter indicates the format of the date and time attribute values schema: type: string default: TIMESTAMP enum: - TIMESTAMP - READABLE - name: fileFormat in: query description: > This parameter defines what output format must be used for export. Note that export to JSON is more efficient compared to export to CSV schema: type: string default: CSV enum: - CSV - JSON - name: filter in: query description: > This parameter enables you to filter entities by a condition. Format for filter query parameter: filter=({Condition Type}[AND/OR {Condition Type}]*). For more information, see Filtering Entities. schema: type: string example: equals(type,'configuration/entityTypes/Individual') - name: select in: query description: > This parameter accepts a list of entity fields to be exported. If not specified, then all fields are present in export. schema: type: string example: type,attributes.FirstName,attributes.Address.City,createdTime - name: options in: query description: >- Comma-separated list of different options which affect endpoints behaviour. Available options: style: FORM explode: false schema: type: array items: type: string example: searchByOv enum: - searchByOv example: searchByOv - name: partSize in: query description: > This parameter indicates a human-readable part size. The Export Service splits result files depending on this setting. For more information, please see Export Data into Multiple Files schema: type: string example: 1gb - name: activeness in: query description: > This parameter determines how the Export Service should process active and expired objects.
Possible values: schema: type: string default: ALL enum: - ALL - ACTIVE - NOT_ACTIVE - name: name in: query description: > This parameter indicates a name of the export task displayed in the task status. The name is also used by the Export UI. For more information, please see Naming an Export Job schema: type: string example: Export-1 - name: headersStyle in: query description: > This parameter defines how the Export Service must name the CSV columns that represent the attribute values.
It is only applicable for CSV export. schema: type: string default: NAME enum: - NAME - LABEL - name: skipPostprocessing in: query description: > During data extraction, the Export Service generates multiple smaller in size, partial files that contain export results. If this parameter is enabled, the Export Service returns links to these files as the result, and the partSize parameter is ignored. Otherwise, the Export Service combines the partial files into one or several files depending on the partSize parameter and returns links to the combined files as the result. The default value is false for Export Version 1 and true for Export Version 2 schema: type: boolean example: true - name: exploded in: query description: >- This parameter is only applicable for CSV export. If the parameter is specified and equals to true, then all attribute values for the same attribute must be within one column (multiple rows will be used for one entity). In other words, if the parameter equals to true, then each entity is represented as a set of CSV lines, where the set is a cartesian product of the entity's attributes. There is a restriction to explode up to 100K rows per one entity.

For more information, see Exploded format in CSV entities export. schema: type: boolean default: false - name: filenameTemplate in: query description: > It defines a filename template that will be used to generate filenames. A filename template might contain the {{n}} placeholder, the Export Service will replace that placeholder with actual file numbers. If the placeholder is not specified, the Export Service will add file numbers at the end of filenames.
Allowed characters: a-z, A-Z, 0-9, _, -
Max length: 512
A filename template cannot be empty:
"" - invalid
"x{{n}}" - valid

Examples:
filenameTemplate → result files:
unspecified → part-00000.zip, part-00001.zip, part-00002.zip, ...
export-file → export-file-00000.zip, export-file-00001.zip, export-file-00002.zip, ...
results-{{n}} → results-00000.zip, results-00001.zip, results-00002.zip, ... schema: type: string example: export-file - name: sendHidden in: query description: >- This parameter allows to include or exclude "hidden" attributes to the export result. By default all "hidden" attributes are included. schema: type: boolean default: true - name: anchorAttribute in: query description: > This parameter is only applicable for CSV export. Specifies an anchor attribute, it will precede all attributes, only a single OV value will be present on a CSV line for an entity. If it's used in combination with the slicedByCrosswalks option, the value will be put on each CSV line no matter which crosswalk that value belongs to. This option is not affected by the select parameter. schema: type: string example: attributes.UUID - name: slicedByCrosswalks in: query description: >- This parameter is only applicable for CSV export. If true, objects will be sliced by crosswalks, each set of attribute values will be placed on a separate CSV line that represents a crosswalk these attributes belong to. This option cannot be used in combination with the exploded option. schema: type: boolean default: false requestBody: description: >- Object containing any of the following parameters for entities export:
Note: If the filter parameter is present in the query and body, the query/filter parameter has priority and overrides the body/filter parameter content: application/json: schema: $ref: '#/components/schemas/EntitiesExportBody' required: false responses: '200': description: Successful operation content: application/json: schema: $ref: '#/components/schemas/TaskStatus' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/APIErrorRepresentation' example: severity: Error errorMessage: >- Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. errorCode: 549 errorDetailMessage: >- Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. innerErrorData: exception: >- com.reltio.metadata.errors.CommonException:Code: EXPORT_DATA_INVALID_PARAM; Message parameters: [filenameTemplate, filenameTemplate cannot be empty]. Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty.. Invalid export parameter: filenameTemplate. Reason: filenameTemplate cannot be empty. '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 '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. 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: export x-controllerName: com.reltio.export.rest.controller.ExportController x-codegen-request-body-name: body x-path: >- /private/swagger.htm?module=Data%20Operation#/Export/exportEntitiesByTenant /services/jobs/export/{tenantId}/entities/_crosswalksTree: post: tags: - Export summary: Exports the merge tree data for all entities in a tenant description: >- This endpoint allows you to export the merge tree data for all entities in a tenant. This is an asynchronous request that returns the IDs of tasks, which export data. Using these IDs you can track the status of these tasks. After completion of the tasks, a link to the result files is sent to the specified email address.
The file with the exported data is a multi-line text file and every line has a separate JSON object that stands for one entity merge tree: operationId: exportEntityCrosswalksTreeByTenant parameters: - name: tenantId in: path description: ID of the tenant required: true schema: type: string - name: s3Bucket in: header description: > Custom storage destination: S3

Indicates the S3 bucket by name schema: type: string example: reltio-data-exports - name: s3Region in: header description: > Custom storage destination: S3

Indicates the S3 region. Specify the S3 region parameter to bypass region autodetection schema: type: string example: cn-north-1 - name: s3Path in: header description: > Custom storage destination: S3

Indicates the S3 path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: s3Sse in: header description: > Custom storage destination: S3

Indicates the server–side encryption algorithm (AES256 or aws:kms). The parameter is ignored if the s3Bucket parameter is not specified (export to Reltio bucket) schema: type: string example: aws:kms - name: s3SseKmsKey in: header description: > Custom storage destination: S3

Indicates the custom KMS key for server side encryption schema: type: string example: arn:aws:kms:us-east-1:0:key/1 - name: awsAccessKey in: header description: > Custom storage destination: S3

Indicates the AWS access key ID. The account must have Write permissions for the S3 destination schema: type: string example: AKIAIOSFODNN7EXAMPLE - name: awsSecretKey in: header description: > Custom storage destination: S3

Indicates the AWS secret key schema: type: string example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY - name: roleArn in: header description: > Custom storage destination: S3

Indicates the AWS role for cross-account secured export schema: type: string example: arn:aws:iam::123456789012:role/S3Access - name: externalId in: header description: > Custom storage destination: S3

Additional security over delegate role access (Assume Role) to control the access to custom S3 bucket schema: type: string example: Service-54823 - name: gcsBucket in: header description: > Custom storage destination: GCS

Indicates the GCS bucket by name schema: type: string example: reltio-data-exports - name: gcsPath in: header description: > Custom storage destination: GCS

Indicates the GCS path. Specifying the leading slash is optional schema: type: string example: /entities/john.doe/2020.07.01 - name: gcpCredentials in: header description: > Custom storage destination: GCS

Indicates the GCP credentials JSON. The account must have Write permissions on the GCS destination schema: type: string example: >- {"type":"service_account","project_id":"xxx","private_key_id":"xxx", ... } - name: azureStorageContainer in: header description: > Custom storage destination: Azure Storage

Indicates the Azure container schema: type: string example: reltio-data-exports - name: azureStorageAccountName in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: azurestorageaccountname - name: azureStorageAccountKey in: header description: > Custom storage destination: Azure Storage

Indicates the Azure account name. The account must have Write permissions on the Azure destination schema: type: string example: YXp1cmVTdG9yYWdlQWNjb3VudEtleQExampleKey== - name: email in: query description: > This parameter indicates the comma-separated list of custom email addresses to which the notification is sent after the export is completed. If the parameter is not specified, the Export Service notifies the Reltio user who submitted the export request schema: type: string example: user@example.com - name: partSize in: query description: > This parameter indicates a human-readable part size. The Export Service splits result files depending on this setting. For more information, please see Export Data into Multiple Files schema: type: string example: 1gb - name: activeness in: query description: > This parameter determines how the Export Service should process active and expired objects.
Possible values: schema: type: string default: ALL enum: - ALL - ACTIVE - NOT_ACTIVE - name: name in: query description: > This parameter indicates a name of the export task displayed in the task status. The name is also used by the Export UI. For more information, please see Naming an Export Job schema: type: string example: Export-1 - name: skipPostprocessing in: query description: > During data extraction, the Export Service generates multiple smaller in size, partial files that contain export results. If this parameter is enabled, the Export Service returns links to these files as the result, and the partSize parameter is ignored. Otherwise, the Export Service combines the partial files into one or several files depending on the partSize parameter and returns links to the combined files as the result. The default value is false for Export Version 1 and true for Export Version 2 schema: type: boolean example: true - name: filenameTemplate in: query description: > It defines a filename template that will be used to generate filenames. A filename template might contain the {{n}} placeholder, the Export Service will replace that placeholder with actual file numbers. If the placeholder is not specified, the Export Service will add file numbers at the end of filenames.
Allowed characters: a-z, A-Z, 0-9, _, -
Max length: 512
A filename template cannot be empty:
"" - invalid
"x{{n}}" - valid

Examples:
filenameTemplate → result files:
unspecified → part-00000.zip, part-00001.zip, part-00002.zip, ...
export-file → export-file-00000.zip, export-file-00001.zip, export-file-00002.zip, ...
results-{{n}} → results-00000.zip, results-00001.zip, results-00002.zip, ... schema: type: string example: export-file requestBody: description: ' Body includes the following details -
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:
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' 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' ITenantDataAccess: type: object ITenantsDAO: type: object ISearchAuthenticationService: type: object IReltioBusinessModelExternalInfoProvider: 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' IObjectChangesProcessorInteractionTO: type: object 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 FastSerializationUtilsV3: type: object properties: metadataService: $ref: '#/components/schemas/IMetadataService' categoriesServiceInterface: $ref: '#/components/schemas/CategoriesServiceInterface' freeSerializers: type: array items: $ref: '#/components/schemas/Kryo' 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' 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' ILockerAccess: type: object 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 PlatformMetricsProviderService: type: object properties: metricsWriterService: $ref: '#/components/schemas/MetricsWriterService' metricsProviderConfigurator: $ref: '#/components/schemas/IMetricsProviderConfigurator' enabled: type: boolean ICommitLogDAO: type: object MatchGroupsProvider: type: object 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 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' 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 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 LookupsService: type: object properties: lookupsDAO: $ref: '#/components/schemas/ILookupsDAO' platformLookupsDAO: $ref: '#/components/schemas/PlatformLookupsDAO' eventPublishService: $ref: '#/components/schemas/EventPublishService' 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 CommonDynamoDBConfig: type: object properties: globalTablesConfig: $ref: '#/components/schemas/DynamoDBGlobalTablesConfig' DataloadMetricsProducer: type: object properties: metricsWriterService: $ref: '#/components/schemas/MetricsWriterService' eventPublishService: $ref: '#/components/schemas/EventPublishService' 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' 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' 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 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 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' FunctionCheckedFileOutputStream: type: object SerializableString: type: object 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: 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 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.
example: true IOAuthInstancesDAO: type: object PropertyNamingStrategy: type: object 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' 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:
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 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 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' 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 MergeSplitServiceProvider: type: object properties: mergeSplitServiceAtomicReference: $ref: '#/components/schemas/AtomicReferenceIMergeSplitService' TemplateClassResolver: type: object 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' 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 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' 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' 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 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 IRecentObjectChanges: type: object 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 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 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 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 AwsBackupConfig: type: object properties: encryptionType: type: string enum: - KMS_AWS - KMS_CUSTOMER - KMS_RELTIO kmsCustomerKeyMap: type: object additionalProperties: $ref: '#/components/schemas/DynamoDBEncryptionKeyConfig' OptionCacheEntryIPermissions: type: object IBigQueryClient: type: object CustomerDatabaseService: type: object properties: secretsManagerService: $ref: '#/components/schemas/InteractionSecretsManagerService' strategyRegistry: $ref: '#/components/schemas/DatabaseDAOStrategyRegistry' 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 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 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' JsonDeserializerObject: type: object ThreadFactory: type: object 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 RequestCrosswalkExtractor: type: object properties: tenantsConfigurationService: $ref: '#/components/schemas/TenantsConfigurationService' ILocalizationDAO: type: object UserPreferencesDAO: type: object properties: tenantDataAccess: $ref: '#/components/schemas/TenantDataAccess' AuthHelper: type: object 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 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' 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 UserPreferencesService: type: object properties: userPreferencesDAO: $ref: '#/components/schemas/UserPreferencesDAO' userPreferencesCache: $ref: >- #/components/schemas/AsyncLoadingCacheUserPrefCacheKeyMapStringListString TruncateBuiltinAlgorithm: type: object 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' 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 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' 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 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' MatchDeltaClustersEvaluatorFactory: type: object Permission: type: object properties: name: type: string CsvConfig: type: object properties: includeRelationActiveness: type: boolean includeRelationPinnedIgnored: type: boolean 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' 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 SegmentSearchController: type: object properties: reltioAPIPlatform: $ref: '#/components/schemas/ReltioServerPlatform' httpServletRequest: $ref: '#/components/schemas/HttpServletRequest' authHelper: $ref: '#/components/schemas/AuthHelper' accessChecker: $ref: '#/components/schemas/AccessChecker' crosswalkExtractor: $ref: '#/components/schemas/RequestCrosswalkExtractor' crudService: $ref: '#/components/schemas/CRUDService' overwriteObjectService: $ref: '#/components/schemas/OverwriteObjectService' metadataServiceFactory: $ref: '#/components/schemas/MetadataServiceFactory' tenantsConfigurationService: $ref: '#/components/schemas/TenantsConfigurationService' currentUser: $ref: '#/components/schemas/UserDetails' metricsProducer: $ref: '#/components/schemas/DataloadMetricsProducer' marshaller: $ref: '#/components/schemas/IMarshaller' lookupsService: $ref: '#/components/schemas/LookupsService' statisticsCollector: $ref: '#/components/schemas/StatisticsCollector' matchGroupDigest: $ref: '#/components/schemas/MatchGroupDigest' segmentSearchService: $ref: '#/components/schemas/ISegmentSearch' 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 RelationAttributeFilterModifier: type: object properties: metadataService: $ref: '#/components/schemas/MetadataService' CircuitBreakerCallback: 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' ICommonMultipleMetricsProvider: type: object 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 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' HistoryStorageConfigurator: type: object AWSLambdaClientProvider: 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 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 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 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 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' 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' Gbq: type: object properties: ovOnly: type: boolean IGroupsDAO: type: object TenantEventQueuesConfiguration: type: object properties: crud: $ref: '#/components/schemas/TenantEventQueueProcessors' match: $ref: '#/components/schemas/TenantEventQueueProcessors' CacheStringInteger: type: object UncaughtExceptionHandler: 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' 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 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' InteractionCassandraWriter: type: object properties: keyFactory: $ref: '#/components/schemas/ICassandraDataKeyFactory' 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' ICustomerDatabaseConfigDAO: type: object IUserPreferencesDAO: type: object 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' 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 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' CategoriesService: type: object properties: categoriesDAO: $ref: '#/components/schemas/CategoriesDAO' metadataService: $ref: '#/components/schemas/MetadataService' CodeSource: type: object properties: location: type: string format: url IAnalyticAttributesDAOIRelationURI: 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 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' CategoriesServiceInterface: type: object TenantsDataListener: 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' 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 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' 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 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' ProviderResourceBundleProvider: type: object IActivitySplitter: 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' 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 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 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 ValueListFileTO: type: object properties: path: type: string downloadLink: type: string format: url expirationDate: type: string format: date-time EmailVerificationResult: type: object properties: attributes: type: object additionalProperties: type: object EmailInput: type: object properties: email: type: string PhoneVerificationResult: type: object properties: attributes: type: object additionalProperties: type: object PhoneInput: type: object properties: phone: type: string country: type: string PredicateQueryRequest: type: object properties: queryType: type: string description: Type of predicate query enum: - uri - crosswalk - attribute metadataTypes: type: array description: Metadata types to be queried items: type: string attribute: $ref: '#/components/schemas/AttributeDefinition' crosswalk: $ref: '#/components/schemas/CrosswalkDefinition' uri: type: string description: Object URI in case of query by URI description: Request Body to perform predicateQuery requests CrosswalkDefinition: type: object properties: type: type: string description: Type of the crosswalk value: type: string description: Value of the crosswalk sourceTable: type: string description: SourceTable of the crosswalk (optional) description: Crosswalk definition for predicateQuery request body AttributeDefinition: type: object properties: name: type: string description: Name of the attribute value: $ref: '#/components/schemas/JsonNode' description: Attribute definition for predicateQuery request body ObjectTOObjectObject: 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 AttributeValueDoc: type: object properties: value: type: string description: Attribute value example: Johnny ObjectEntryObject: required: - index type: object properties: index: type: integer description: Index of an attribute value in JSON Array from response format: int32 readOnly: true errors: $ref: '#/components/schemas/APIErrorRepresentation' object: type: object description: >- Attribute value that is created. This parameter will be returned if returnObjects query parameter in the request is not false and object was created successfully readOnly: true successful: type: boolean description: Is this operation successful readOnly: true 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 CrosswalkAttribute: type: object properties: value: type: string description: Date value of crosswalk attribute example: '2021-05-16T06:12:51.000+04:00' MatchClassesResponse: type: object properties: parametrized: type: array description: Parametrized section contains all match classes that have parameters example: '["com.reltio.match.ParametrizedMatchClass"]' items: type: string notParametrized: type: array description: >- Not parametrized section contains all match classes that do not have parameters example: '["com.reltio.match.NotParametrizedMatchClass"]' items: type: string description: Collection of match classes available in the platform CompareResponse: type: object properties: fuzzy: type: boolean description: Is fuzzy comparison example: true first: type: string description: First value example: 'true' second: type: string description: Second value example: 'true' equals: type: boolean description: Comparison result example: true relevance: type: number description: Relevance score format: double example: 0.5 description: Result of comparison CompareRequest: type: object properties: fuzzy: type: boolean description: Is fuzzy comparison example: true first: type: string description: First value example: 'true' second: type: string description: Second value example: 'true' comparatorClass: $ref: '#/components/schemas/ComparatorClassMapping' description: Compare request CompareMultiRequest: required: - comparatorClasses - first - multi - second type: object properties: tenantId: type: string description: TenantId entityType: type: string description: entityType example: HCP first: type: object additionalProperties: type: object description: First value for comparison example: >- "configuration/entityTypes/Individual/attributes/FirstName": "William", "configuration/entityTypes/Individual/attributes/Age": 14 second: type: object additionalProperties: type: object description: Second value for comparison example: >- "configuration/entityTypes/Individual/attributes/FirstName": "William", "configuration/entityTypes/Individual/attributes/Age": 14 comparatorClasses: type: array description: Match comparator classes example: |- [ { "attribute": "configuration/entityTypes/Individual/attributes/Geo", "class": "com.reltio.match.comparator.ProximateGeoComparator", "parameters": [ { "parameter": "distance_miles", "value": "0.4" } ] } ] items: $ref: '#/components/schemas/ComparatorClassMapping' multi: type: array description: Multi attributes operands example: |- [ { "uri": "configuration/entityTypes/Individual/attributes/Geo", "attributes": [ "configuration/entityTypes/Individual/attributes/Latitude", "configuration/entityTypes/Individual/attributes/Longitude" ] } ] items: $ref: '#/components/schemas/MultiAttributesOperand' description: Body of /tools/matching/compare/multi request CompareMultiResponse: type: object properties: equals: type: boolean description: Comparison result example: true relevance: type: number description: Relevance score format: double example: 0.5 description: Response of /tools/matching/compare/multi ProcessedEvents: type: object properties: sentEvents: type: array items: type: string failedEvents: type: array items: type: string FixGroupingMatchesStateResponse: type: object properties: tenantId: type: string deletedMatches: type: array items: $ref: '#/components/schemas/DeletedMatch' entitiesProcessed: type: integer format: int32 deletedAssociations: type: array items: type: string associationsProcessed: type: integer format: int32 processedEvents: $ref: '#/components/schemas/ProcessedEvents' FixGroupingMatchesStatePayload: type: object properties: entities: type: array description: List of entity IDs items: type: string associations: type: array description: List of association IDs items: type: string matchGroupUri: type: string description: Optional match group URI to include for context, if applicable trace: type: boolean description: Enable trace logging description: >- Request to fix grouping matches state for provided entities and associations DeletedMatch: type: object properties: primaryId: type: string secondaryId: type: string matchGroups: type: array items: type: string MatchTokenIntersectionsResponse: type: object properties: fuzzy: type: boolean description: Is fuzzy comparison example: true first: type: string description: First value example: 'true' second: type: string description: Second value example: 'true' intersections: uniqueItems: true type: array description: >- List of token intersections. Empty list shows that values doesn't have token intersections. example: '["token"]' items: type: string description: Common parameters MatchTokenIntersectionRequest: type: object properties: fuzzy: type: boolean description: Is fuzzy comparison example: true first: type: string description: First value example: 'true' second: type: string description: Second value example: 'true' matchTokenClass: $ref: '#/components/schemas/MatchTokenClassMapping' MatchTokensRequest: type: object properties: fuzzy: type: boolean description: Flag allows fuzzy comparison. example: true values: type: array description: List of provided values. example: '["string 1","string 2"]' items: type: string matchTokenClass: $ref: '#/components/schemas/MatchTokenClassMapping' MatchTokensResponse: type: object properties: tokens: type: array description: List of generated tokens. example: '["token 1","token 2"]' items: type: string value: type: string description: Original value. example: Value total: type: integer description: Number of generated tokens. format: int32 example: 2 MultiMatchTokensResponse: type: object properties: tokens: type: array description: List of generated tokens example: '["token 1","token 2"]' items: type: string total: type: integer description: Number of generated tokens format: int32 example: 2 description: Response of /tools/matching/matchTokens/multi MultiMatchTokensRequest: required: - matchTokenClasses - multi - values type: object properties: tenantId: type: string description: TenantId entityType: type: string description: entityType example: HCP values: type: object additionalProperties: type: object description: Map of provided values matchTokenClasses: type: array description: Match token classes example: |- [ { "attribute": "configuration/entityTypes/Individual/attributes/Geo", "class": "com.reltio.match.token.ProximateGeoToken", "parameters": [ { "parameter": "distance_miles", "value": "0.4" } ] } ] items: $ref: '#/components/schemas/MatchTokenClassMapping' multi: type: array description: Multi attributes operands example: |- [ { "uri": "configuration/entityTypes/Individual/attributes/VirtualName", "attributes": [ "configuration/entityTypes/Individual/attributes/FirstName", "configuration/entityTypes/Individual/attributes/LastName" ] } ] items: $ref: '#/components/schemas/MultiAttributesOperand' description: Body of /tools/matching/matchTokens/multi request 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 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 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 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 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 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 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 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 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. 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". 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). 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 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 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" 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 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. TokensDetailedExplanationRequest: type: object properties: entityTO: $ref: '#/components/schemas/EntityTO' model: $ref: '#/components/schemas/ReltioBusinessModel' matchGroups: type: array description: List of specified match groups. items: type: string configuration: $ref: '#/components/schemas/TenantConfiguration' 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' 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 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 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 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 RetainMergeCondition: type: object properties: sources: type: array items: type: string matchGroups: type: array items: $ref: '#/components/schemas/UnmergeMatchGroup' 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 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 MatchAssetAttributeType: type: object properties: uri: type: string optional: type: boolean defaultValue: type: string noiseCharacters: type: string transformers: type: array items: $ref: '#/components/schemas/MatchAssetAttributeTransformerConfig' 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 EntityUnmerge: type: object properties: enabled: type: boolean retainManualMerges: type: boolean retainMergeConditions: $ref: '#/components/schemas/RetainMergeCondition' actions: type: array items: $ref: '#/components/schemas/UnmergeActionDefinition' 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 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 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 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 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 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. RemovingObjectChangeTO: type: object properties: id: type: string createdTime: type: integer format: int64 createdBy: type: string allOf: - $ref: '#/components/schemas/AbstractObjectChangeTO' - type: object properties: conflictDetails: type: string description: Additional details about conflicts readOnly: true example: >- Code: TYPE_IS_NOT_FOUND; Message parameters: [configuration/entityTypes/Individual, SomeTenant] type: type: string description: Type of the change item readOnly: true example: INSERT_ATTRIBUTE enum: - INSERT_ATTRIBUTE - UPDATE_ATTRIBUTE - DELETE_ATTRIBUTE - PIN_ATTRIBUTE - IGNORE_ATTRIBUTE - CREATE_ENTITY - CREATE_RELATIONSHIP - UPDATE_ROLES - UPDATE_TAGS - UPDATE_START_DATE - UPDATE_END_DATE - UPDATE_PROFILE_PIC_BY_URI - UPDATE_PROFILE_PIC_BY_URL - DELETE_RELATIONSHIP conflict: type: string description: >- Type of the conflict. This property is present only if the change item has conflicts readOnly: true example: ATTRIBUTE_NOT_FOUND enum: - UNEXPECTED_ERROR - OBJECT_TYPE_NOT_FOUND - ATTRIBUTE_TYPE_NOT_FOUND - ATTRIBUTE_NOT_FOUND - ATTRIBUTE_WAS_CHANGED - ADDING_REFERENCE_ATTRIBUTE_POSSIBLE_FOR_ENTITY_ONLY - OBJECT_NOT_FOUND description: >- Model for an relationship delete change request item inside a Data Change Request AttributeChangeTO: type: object properties: id: type: string createdTime: type: integer format: int64 createdBy: type: string oldValue: description: The value of an attribute at the moment when the item was created nullable: true readOnly: true writeOnly: false extensions: {} anyOf: - $ref: '#/components/schemas/SimpleAttributeValueTO' - $ref: '#/components/schemas/NestedAttributeValueTO' - $ref: '#/components/schemas/ReferenceAttributeValueTO' newValue: description: >- New suggested value of an attribute (absent for DELETE_ATTRIBUTE item type) nullable: true readOnly: true writeOnly: false extensions: {} anyOf: - $ref: '#/components/schemas/SimpleAttributeValueTO' - $ref: '#/components/schemas/NestedAttributeValueTO' - $ref: '#/components/schemas/ReferenceAttributeValueTO' allOf: - $ref: '#/components/schemas/AbstractObjectChangeTO' - type: object properties: attributeType: type: string description: Attribute type URI from metadata readOnly: true example: >- configuration/relationTypes/HasAddress/attributes/Phone/attributes/Number refAttributeType: type: string description: Type of the attribute inside the reference attribute readOnly: true example: >- configuration/entityTypes/Individual/attributes/Address/attributes/Phone/attributes/Number refObjectURI: type: string description: >- URI of reference entity or relation which contains the attribute for which some changes are requested (exists only for attribute changes inside reference attributes) readOnly: true example: relations/00006OP attributePath: type: string description: Path to an attribute which should be changed inside the object readOnly: true example: FirstName/0000fYX crosswalk: $ref: '#/components/schemas/CrosswalkTO' newPinOrIgnoreValue: type: boolean description: >- Suggested value for "pin" or "ignored" (used only for PIN_ATTRIBUTE and IGNORE_ATTRIBUTE item types) readOnly: true example: true description: >- Model for an attribute change request item inside a Data Change Request FieldChangeTO: type: object properties: id: type: string createdTime: type: integer format: int64 createdBy: type: string allOf: - $ref: '#/components/schemas/AbstractObjectChangeTO' - type: object properties: conflictDetails: type: string description: Additional details about conflicts readOnly: true example: >- Code: TYPE_IS_NOT_FOUND; Message parameters: [configuration/entityTypes/Individual, SomeTenant] type: type: string description: Type of the change item readOnly: true example: INSERT_ATTRIBUTE enum: - INSERT_ATTRIBUTE - UPDATE_ATTRIBUTE - DELETE_ATTRIBUTE - PIN_ATTRIBUTE - IGNORE_ATTRIBUTE - CREATE_ENTITY - CREATE_RELATIONSHIP - UPDATE_ROLES - UPDATE_TAGS - UPDATE_START_DATE - UPDATE_END_DATE - UPDATE_PROFILE_PIC_BY_URI - UPDATE_PROFILE_PIC_BY_URL - DELETE_RELATIONSHIP conflict: type: string description: >- Type of the conflict. This property is present only if the change item has conflicts readOnly: true example: ATTRIBUTE_NOT_FOUND enum: - UNEXPECTED_ERROR - OBJECT_TYPE_NOT_FOUND - ATTRIBUTE_TYPE_NOT_FOUND - ATTRIBUTE_NOT_FOUND - ATTRIBUTE_WAS_CHANGED - ADDING_REFERENCE_ATTRIBUTE_POSSIBLE_FOR_ENTITY_ONLY - OBJECT_NOT_FOUND newValue: type: array description: New values for the field which should be applied readOnly: true items: type: string oldValue: type: array description: Values of a field at the moment when the item was created readOnly: true items: type: string description: >- Model for an field (tags, roles, startDate, endDate) change request item inside a Data Change Request CreatingObjectChangeTO: type: object properties: id: type: string createdTime: type: integer format: int64 createdBy: type: string newValue: description: JSON of an object which is requested to be created nullable: false readOnly: true writeOnly: false extensions: {} anyOf: - $ref: '#/components/schemas/EntityTO' - $ref: '#/components/schemas/RelationTO' allOf: - $ref: '#/components/schemas/AbstractObjectChangeTO' - type: object properties: conflictDetails: type: string description: Additional details about conflicts readOnly: true example: >- Code: TYPE_IS_NOT_FOUND; Message parameters: [configuration/entityTypes/Individual, SomeTenant] type: type: string description: Type of the change item readOnly: true example: INSERT_ATTRIBUTE enum: - INSERT_ATTRIBUTE - UPDATE_ATTRIBUTE - DELETE_ATTRIBUTE - PIN_ATTRIBUTE - IGNORE_ATTRIBUTE - CREATE_ENTITY - CREATE_RELATIONSHIP - UPDATE_ROLES - UPDATE_TAGS - UPDATE_START_DATE - UPDATE_END_DATE - UPDATE_PROFILE_PIC_BY_URI - UPDATE_PROFILE_PIC_BY_URL - DELETE_RELATIONSHIP conflict: type: string description: >- Type of the conflict. This property is present only if the change item has conflicts readOnly: true example: ATTRIBUTE_NOT_FOUND enum: - UNEXPECTED_ERROR - OBJECT_TYPE_NOT_FOUND - ATTRIBUTE_TYPE_NOT_FOUND - ATTRIBUTE_NOT_FOUND - ATTRIBUTE_WAS_CHANGED - ADDING_REFERENCE_ATTRIBUTE_POSSIBLE_FOR_ENTITY_ONLY - OBJECT_NOT_FOUND description: Model for an create object request item inside a Data Change Request 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' InteractionMemberNode: type: object properties: type: type: string uri: type: string members: type: array items: $ref: '#/components/schemas/InteractionObjectTO' RoleURI: type: object properties: shortUri: type: string isNew: type: boolean parentURI: $ref: '#/components/schemas/ModelURI' tenantId: $ref: '#/components/schemas/TenantId' uriCache: type: string 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 ModelURI: type: object properties: shortUri: type: string isNew: type: boolean parentURI: $ref: '#/components/schemas/ModelURI' tenantId: $ref: '#/components/schemas/TenantId' uriCache: type: string 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 InteractionObjectTO: type: object properties: resolvedEntityURI: type: string description: >- URI of the resolved entity type or role that can be a member of the type example: configuration/entityTypes/Bco79gB initialEntityURI: type: string description: >- URI of an initial entity type or role that can be a member of the type example: configuration/entityTypes/Bco79gB entityType: type: string description: Type of member entity readOnly: true example: configuration/entityTypes/Individual label: type: string description: >- An entity label that is built using the entity type configuration dataLabelPattern and data of an member entity. readOnly: true example: John Smith description: Interaction Member Object StartObjectCrosswalk: type: object properties: type: type: string description: Type of crosswalk example: configuration/sources/OOSource value: type: string description: Value of crosswalk example: ABSourceValue RefEntityObject: type: object properties: objectURI: type: string description: Ref Entity Uri example: entities/uI8GeUq type: type: string description: Ref Entity Type example: configuration/entityTypes/Location crosswalks: type: array description: Ref Entity Crosswalks items: $ref: '#/components/schemas/CrosswalkTO' RefRelationObject: type: object properties: startRefPinned: type: boolean description: Ref Relation Uri is start Pinned? example: false endRefPinned: type: boolean description: Ref Relation Uri is end Pinned? example: false objectURI: type: string description: Ref Relation Uri example: relations/6lJRhZb endRefIgnored: type: boolean description: Ref Relation is end Ignored? example: false type: type: string description: Ref Relation Type example: configuration/relationTypes/HasAddress startRefIgnored: type: boolean description: Ref Relation Uri is start Ignored? example: false crosswalks: type: array description: Ref Relation Crosswalks items: $ref: '#/components/schemas/CrosswalkTO' extensions: x-original-swagger-version: '2.0'