{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Product Policy Logic Engine", "description": "Logic Engine API is part of FenX eco-system to evaluate Product Policy Requirements by logic conditions.All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/productpolicylogicengine" } ], "paths": { "/api/cache/flush": { "delete": { "tags": [ "Cache" ], "summary": "Allows clearing the Logic Engine API cache.\nThis is an maintenance endpoint and does not need to be used under normal circumstances.", "description": "

Required permissions:
Following permissions are required: ProductConfigurationDelete", "parameters": [ { "name": "clearRequirementsCache", "in": "query", "description": "If the Requirements cache should be flushed", "schema": { "type": "boolean" }, "example": true }, { "name": "clearRequirementSetsCache", "in": "query", "description": "If the Requirement sets cache should be flushed", "schema": { "type": "boolean" }, "example": true }, { "name": "clearDataGroupsCache", "in": "query", "description": "If the DataGroup cache should be flushed", "schema": { "type": "boolean" }, "example": true }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Cache was flushed successfully.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ClearCacheResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClearCacheResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClearCacheResponseDtoServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/engine/evaluate-product-requirement-sets": { "post": { "tags": [ "Engine" ], "summary": "Evaluate product requirement set", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateProductRequirementSets", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Service request with entity data properties required for evaluation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of evaluated product requirement sets is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/engine/evaluate-product-requirements": { "post": { "tags": [ "Engine" ], "summary": "Evaluate product requirement", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateProduct", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Service request with key-value data required for evaluation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of evaluated product requirements is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/engine/evaluate-data-group-fields": { "post": { "tags": [ "Engine" ], "summary": "Evaluate data group fields", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateDataGroupFields", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Service request with key-value data required for evaluation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of evaluated data group fields is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/engine/evaluate-products": { "post": { "tags": [ "Engine" ], "summary": "Evaluate products", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateProducts", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Service request with key-value data required for evaluation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductsRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductsRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. The list of evaluated product ids is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EvaluateProductsResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateProductsResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EvaluateProductsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers e.g. [\"Global\"]", "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers e.g. [\"Global\"]", "nullable": true } }, "additionalProperties": false, "description": "DTO representing associated access layers" }, "AccountRelatedFundDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" }, "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" }, "nullable": true }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ], "nullable": true }, "lastAssessmentOutcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "source": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "attribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BasicRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "CalculatedResultDto": { "type": "object", "properties": { "result": { "type": "string", "description": "Calculation result", "nullable": true }, "error": { "type": "string", "description": "Calculation error", "nullable": true } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" }, "nullable": true } }, "additionalProperties": false }, "ClearCacheResponseDto": { "type": "object", "properties": { "requirementsCacheCleared": { "type": "boolean", "description": "If true, the Requirements rules cache was cleared\ntrue" }, "requirementSetsCacheCleared": { "type": "boolean", "description": "If true, the RequirementsSets rules cache was cleared\ntrue" }, "dataGroupsCacheCleared": { "type": "boolean", "description": "If true, the DataGroup rules cache was cleared\ntrue" } }, "additionalProperties": false, "description": "Represents the clear cache response" }, "ClearCacheResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ClearCacheResponseDto" } ], "description": "Represents the clear cache response", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "assessmentComment": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CurrentProductDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentProductMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "isAgency": { "type": "string", "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentUserDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "teamIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isSystemUser": { "type": "boolean" } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked Parent field property name", "nullable": true, "example": "productCategory" }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchemaDto" } ], "description": "Formula schema", "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto" } ], "description": "Date formula schema", "nullable": true }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "description": "External search API provider id", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing data field data" }, "DataGroupFieldDto": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The UiD of the data group field", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Data group field name", "nullable": true, "example": "Product Type" }, "type": { "type": "string", "description": "Data group field type", "nullable": true, "example": "DataGroup" }, "order": { "type": "number", "description": "Data group field order", "format": "double", "nullable": true, "example": 2 }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data group field data field", "nullable": true }, "isSensitiveData": { "type": "boolean", "description": "Data group field sensitive data flag", "example": true }, "isCoreDefinition": { "type": "boolean", "description": "Data group field core definition flag", "example": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRule" } ], "description": "Data group field validation data", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Data group field validation rules V2", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Data group field conditions list", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "defaultValue": { "type": "string", "description": "Default value for this data field", "nullable": true, "example": "Australia" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "description": "List of conditional values", "nullable": true }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "description": { "type": "string", "description": "Data group field description", "nullable": true, "example": "This is the field description" } }, "additionalProperties": false, "description": "Response DTO representing data group field data" }, "DataGroupFieldDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupFieldDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "nullable": true }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "nullable": true }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "nullable": true }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "nullable": true } }, "additionalProperties": false }, "DataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow todays date", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "DateLimitRangeData": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "relativeTo": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "offset": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "offsetPeriod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateLimitRangeDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "relativeTo": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "offset": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "offsetPeriod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateLimitRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto3": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto4": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto3" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValidationRuleDto2": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto4" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto2" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto3" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto4" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateTimePeriodFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "description": "Formula set id", "format": "uuid", "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "versionNumber": { "type": "integer", "description": "Formula set version number", "format": "int32", "nullable": true, "example": 1 }, "formulaString": { "type": "string", "description": "Formula string will be used to perform calculation", "nullable": true, "example": "$1 + $2" }, "dateTimePeriodFormulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DateTimePeriodFormulaVariableDto" }, "description": "Metadata argument in formula string", "nullable": true } }, "additionalProperties": false }, "DateTimePeriodFormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "timePeriodKind": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmptyRuleDto": { "type": "object", "additionalProperties": false }, "EmptyRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "EmptyRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EntityAssociationDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluateDataGroupFieldsRequestDto": { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "The UiD of the data group", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "dataGroupVersionNumber": { "type": "integer", "description": "The version number of the data group", "format": "int32", "nullable": true, "example": 1 }, "data": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-Value pair of data to evaluate", "nullable": true, "example": { "entityType": "Company" }, "deprecated": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties for condition evaluation", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing object used to evaluate the condition of data group fields" }, "EvaluateDataGroupFieldsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateDataGroupFieldsRequestDto" } ], "description": "Request DTO representing object used to evaluate the condition of data group fields", "nullable": true } }, "additionalProperties": false }, "EvaluateProductRequirementSetsRequestDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties for condition evaluation", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true }, "cutOffDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing entity data properties used to evaluate the condition of product requirement set", "example": { "entityType": "Company" } }, "EvaluateProductRequirementSetsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementSetsRequestDto" } ], "description": "Request DTO representing entity data properties used to evaluate the condition of product requirement set", "nullable": true, "example": { "entityType": "Company" } } }, "additionalProperties": false }, "EvaluateProductRequirementSetsResponseDto": { "type": "object", "properties": { "requirementSetId": { "type": "string", "description": "The UiD of matched product requirement set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Name of matched product requirement set", "nullable": true, "example": "Fenergo Comprehensive Standard Product Requirements" }, "jurisdiction": { "type": "string", "description": "Jurisdiction of matched product requirement set", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Response DTO representing parameters of matched product requirement set" }, "EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluateProductRequirementSetsResponseDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EvaluateProductRequirementsRequestDto": { "type": "object", "properties": { "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "List of versioned jurisdiction", "nullable": true }, "requirementTypes": { "type": "array", "items": { "type": "string" }, "description": "List of product requirement types [Data, Document]", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties for condition evaluation", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Product" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of product requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "sourceEntityId": { "type": "string", "description": "The ID of the product being evaluated", "nullable": true }, "journeyId": { "type": "string", "description": "The ID of the Journey which initiated the request", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing object used to evaluate the condition of product requirement", "example": { "entityType": "Company" } }, "EvaluateProductRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsRequestDto" } ], "description": "Request DTO representing object used to evaluate the condition of product requirement", "nullable": true, "example": { "entityType": "Company" } } }, "additionalProperties": false }, "EvaluateProductsRequestDto": { "type": "object", "properties": { "scopingRuleSetVersionId": { "type": "string", "description": "The UiD of the scopingRuleSetVersionId", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRequestDataDto" }, "description": "Products data to check for scoping", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing object used to evaluate the collection of product ids in scope" }, "EvaluateProductsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductsRequestDto" } ], "description": "Request DTO representing object used to evaluate the collection of product ids in scope", "nullable": true } }, "additionalProperties": false }, "EvaluateProductsResponseDto": { "type": "object", "properties": { "productIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The UiDs of the products that met scoping rule", "nullable": true, "example": [ "84ec28e2-d786-417b-850f-96321dd849dd" ] } }, "additionalProperties": false, "description": "Response DTO representing collection of evaluated product ids" }, "EvaluateProductsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductsResponseDto" } ], "description": "Response DTO representing collection of evaluated product ids", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EventIngressDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalProviderRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDto2": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "description": "Formula set id", "format": "uuid", "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "versionNumber": { "type": "integer", "description": "Formula set version number", "format": "int32", "nullable": true, "example": 1 }, "formulaString": { "type": "string", "description": "Formula string will be used to perform calculation", "nullable": true, "example": "$1 + $2" }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormulaVariableDto" }, "description": "Metadata argument in formula string", "nullable": true } }, "additionalProperties": false }, "FormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConditionDto" }, "nullable": true } }, "additionalProperties": false }, "InvestmentAccountFundDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "JourneyLevelDataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "MainEntityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "type": "object", "properties": { "taskDataKey": { "type": "string", "nullable": true }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "OwnershipValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory requirement", "nullable": true }, "partyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "What is the minimum number of relationships that need to be added in order for this requirement to be fulfilled?", "nullable": true }, "addAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Is the unwrapping requirement non-calculable?", "nullable": true }, "idvIsMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory ID&V", "nullable": true }, "idvPartyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "What is the minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled?", "nullable": true }, "idvAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Do all entities that meet the criteria of this requirement need to be ID&Vd?", "nullable": true } }, "additionalProperties": false }, "OwnershipValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the ownership validation rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set", "format": "uuid", "example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3" }, "ownershipValidationData": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationDataDto" } ], "description": "Ownership Validation Data - set of validation rules specific to ownership requirement", "nullable": true } }, "additionalProperties": false }, "ProductRequestDataDto": { "type": "object", "properties": { "productId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "nullable": true } }, "additionalProperties": false }, "ProductRequirementDto": { "type": "object", "properties": { "rootVersionId": { "type": "string", "description": "The UiD of the root requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "Requirement set version number", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "tenant": { "type": "string", "description": "The UiD of the tenant", "nullable": true, "example": "c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1" }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "template": { "type": "string", "description": "Requirement template", "nullable": true, "example": "Product" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Individual" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "isSecondaryIdentifier": { "type": "boolean", "description": "Requirement Secondary Identifier flag", "example": true }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "isMaterialData": { "type": "boolean", "description": "Requirement material data flag", "example": true }, "isCoreDefinition": { "type": "boolean", "description": "Requirement is defined as core\nand cannot be deleted or altered", "example": false }, "jurisdiction": { "type": "string", "description": "Requirement jurisdiction", "nullable": true, "example": "Global" }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "description": "Requirement references list", "nullable": true }, "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Client" }, "classification": { "type": "string", "description": "Requirement classification", "nullable": true, "example": "Customer Profiling" }, "type": { "type": "string", "description": "Requirement type", "nullable": true, "example": "Data" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Requirement conditions list", "nullable": true }, "RequirementSetId": { "type": "string", "description": "The UiD of the current requirement set version", "format": "uuid", "example": "c060f297-70a2-4d4c-9360-9b5b39060ff0" }, "versionId": { "type": "string", "description": "The UiD of the current requirement set version", "format": "uuid", "example": "e060f297-70a2-4d4c-9360-9b5b39060ff0" }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data Field", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "defaultDateType": { "type": "string", "description": "Default Date Type e.g. Standard Default Value", "nullable": true, "example": "true" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "isIndexable": { "type": "boolean", "description": "Is requirement indexable", "example": true }, "isMandatoryIndexable": { "type": "boolean", "description": "Is requirement mandatory indexable", "example": true }, "isMandatory": { "type": "boolean", "description": "Is requirement mandatory", "example": false }, "documentDescription": { "type": "string", "description": "Document Description", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "Document Data Key", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "description": "Acceptable document types for the e-signature document requirement", "nullable": true }, "documentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document Access Layers", "nullable": true }, "ownershipDataKey": { "type": "string", "description": "Ownership Data Key", "nullable": true, "example": "DataKey" }, "partyTypes": { "type": "array", "items": { "type": "string" }, "description": "Party Types e.g. [\"Director\"]", "nullable": true }, "uboThreshold": { "type": "number", "description": "UBO Threshold", "format": "double", "nullable": true, "example": 0.6 }, "relatedPartyEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "Types of Related Party Entity e.g. [\"Individual\"]", "nullable": true }, "directAssociationsOnly": { "type": "boolean", "description": "Is Only direct association", "example": false }, "idvOn": { "type": "boolean", "description": "Is Idv On", "example": false }, "idvName": { "type": "string", "description": "Idv Name", "nullable": true, "example": "IdentityRequirement" }, "idvTooltip": { "type": "string", "description": "Idv Tooltip", "nullable": true, "example": "Identity Requirement" }, "ownershipValidationRule": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationRuleDto" } ], "description": "Ownership Validation Rule", "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "description": "Validation Rule", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Requirement validation rules V2", "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "description": "List of conditional values", "nullable": true }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calcualtion value", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags", "nullable": true }, "isTotalProductColumn": { "type": "boolean", "description": "Specifies is field is going to be displayed with a total summation", "example": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered\nnull", "nullable": true }, "dataProtectionJurisdiction": { "type": "string", "description": "Jurisdiction for data protection", "nullable": true, "example": "Global" }, "aggregateVersion": { "type": "integer", "description": "Requirement aggregate version", "format": "int32", "nullable": true, "example": 1 }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "clearValueIfTriggerConditionNotMet": { "type": "boolean", "description": "When enabled, the field value is cleared if its trigger condition is not met", "example": true } }, "additionalProperties": false, "description": "Request DTO representing requirement metadata" }, "ProductRequirementDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRequirementDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ReferenceDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Reference type", "nullable": true, "example": "FATCA" }, "description": { "type": "string", "description": "Reference description", "nullable": true, "example": "Foreign Account Tax Compliance Act" }, "url": { "type": "string", "description": "Reference URL", "nullable": true, "example": "www.irs.gov" } }, "additionalProperties": false, "description": "Request DTO representing reference metadata" }, "RegexRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/RegexRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RelatedAssetDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssetsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssociationDto": { "type": "object", "properties": { "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedClientDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedInvestmentManagerDataSource": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "dataSource": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedUnderlyingPrincipalOwnerDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "reviewAndApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewAndApprovalDto" }, "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "approvalOutcome": { "type": "string", "nullable": true }, "approvalReason": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDto" } ], "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "singleFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collections": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationData": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRule" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRule" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRule" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRule" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRule" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRule" } ], "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule" } ], "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow todays date", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "ValidationRule": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "propertyId": { "type": "string", "format": "uuid" }, "propertyName": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "isDataGroup": { "type": "boolean" }, "dataGroupId": { "type": "string", "format": "uuid", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationData" } ], "nullable": true }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "linkedParentFieldPropertyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the validation rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set/data group", "format": "uuid", "example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3" }, "propertyId": { "type": "string", "description": "The UiD of the requirement/data group field", "format": "uuid", "example": "450df9bf-b2d3-48cf-ab8d-481c69b74373" }, "propertyTypeId": { "type": "string", "description": "The Guid containing the property type id", "format": "uuid", "nullable": true, "example": "450df9bf-b2d3-48cf-ab8d-481c69b74373" }, "linkChildFieldPropertyName": { "type": "string", "description": "The string containing the property name child of this property, only has value when propertyType is set to \"selectLink\"", "nullable": true, "example": "country" }, "linkedParentFieldPropertyName": { "type": "string", "description": "The string containing the property name parent of this property, only has value when propertyType is set to \"LinkedSelectV2\" or \"LinkedMultiSelectV2\"", "nullable": true, "example": "country" }, "dataGroupId": { "type": "string", "description": "The UiD of the of data group - is set only when requirement/data group field propertyType is set to \"dataGroup\"", "format": "uuid", "nullable": true, "example": "8eb83ec6-1539-46a9-b0ba-c5138a09580c" }, "isDataGroup": { "type": "boolean", "description": "Flag indicating it is validation rules for data group field", "example": true }, "propertyName": { "type": "string", "description": "Requirement/data group field property name", "nullable": true, "example": "firstName" }, "friendlyName": { "type": "string", "description": "Requirement/data group field friendly Name", "nullable": true, "example": "First Name" }, "validationType": { "type": "string", "description": "Validation type", "nullable": true, "example": "text" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation rule metadata" }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValueLimitRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ValueLimitRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction of the requirement", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction of the requirement", "format": "uuid", "nullable": true, "example": "894e1443-dd7a-4b9d-b253-430c2de80524" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }