openapi: 3.2.0
info:
title: Fenergo Requirements In Scope API
version: '1.0'
description: 'Operations tagged RequirementsInScope across 3 of this provider''s published API definitions: fenergo-policyquery-v1-0-openapi.json, fenergo-policyquery-v2-0-openapi.json, fenergo-policyquery-v3-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /policyquery
security:
- Bearer: []
tags:
- name: RequirementsInScope
paths:
/api/requirements-in-scope:
post:
tags:
- RequirementsInScope
summary: Get requirements in scope
description: 'Returns requirements that are in scope for a given search criteria.
Required permissions:
Following permissions are required: PolicySearch'
operationId: GetRequirementsInScope
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: Requirements in scope request with a set of criteria to search
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequirementsInScopeRequestDtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found. Requirements with given search criteria does not exist
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/requirements-in-scope/jurisdiction/{jurisdiction}:
get:
tags:
- RequirementsInScope
summary: Get the requirement set active version by jurisdiction
description: 'Returns requirement version by given jurisdiction. The version must be an active version to be returned.
Required permissions:
Following permissions are required: PolicySearch'
operationId: GetActiveSetVersionByJurisdiction
parameters:
- name: jurisdiction
in: path
description: The Jurisdiction
required: true
schema:
type: string
example: Global
- 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. Requirement version is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ActiveSetVersionResponseDtoServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found. Requirement set or requirement version with given jurisdiction does not exist
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/v2/requirements-in-scope:
post:
tags:
- RequirementsInScope
summary: Get requirements in scope
description: 'Returns deduplicated requirements that are in scope for a given search criteria.
Required permissions:
Following permissions are required: PolicySearch'
operationId: GetRequirementsInScopeV2
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: Requirements in scope request with a set of criteria to search
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequirementsInScopeRequestV2DtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/v2/requirements-in-scope/search:
post:
tags:
- RequirementsInScope
summary: Search requirements
description: 'Returns requirements that are in scope for a given search criteria.
Required permissions:
Following permissions are required: PolicySearch'
operationId: SearchRequirements
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: Requirements in scope request with a set of criteria to search
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SearchRequirementsDtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/v2/requirements-in-scope/evaluate:
post:
tags:
- RequirementsInScope
summary: Evaluate requirements in scope
description: 'Returns non-conditional and evaluated conditional requirements that are in scope for a given search criteria
and entity parameters.
Required permissions:
Following permissions are required: PolicySearch'
operationId: EvaluateRequirementsInScope
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: 'Evaluate requirements in scope request with a set of criteria to search requirements and evaluate
conditions'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EvaluateRequirementsInScopeRequestDtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/v3/requirements-in-scope:
post:
tags:
- RequirementsInScope
summary: Get requirements in scope
description: 'Returns deduplicated requirements that are in scope for a given search criteria.
Required permissions:
Following permissions are required: PolicySearch'
operationId: GetRequirementsInScopeV3
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: Evaluated Requirements in scope request with a set of criteria to search
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequirementsInScopeRequestV2DtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of evaluated requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found
type: Error
errorCode: Error Code
'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
servers:
- url: /policyquery
/api/v3/requirements-in-scope/search:
post:
tags:
- RequirementsInScope
summary: Search requirements
description: 'Returns requirements that are in scope for a given search criteria.
Required permissions:
Following permissions are required: PolicySearch'
operationId: postApiV3RequirementsInScopeSearch
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: Requirements in scope request with a set of criteria to search
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SearchRequirementsDtoServiceRequest'
description: Service request data
responses:
'200':
description: Success. List of requirements is returned
content:
application/json:
schema:
$ref: '#/components/schemas/RequirementDtoListServiceResponse'
'400':
description: Bad request. The request has missing/invalid values
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceResponse'
'404':
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectServiceResponse'
example:
data: {}
messages:
- message: Not Found
type: Error
errorCode: Error Code
'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
x-operation-id-source: normalized
x-operation-id-original: SearchRequirements
servers:
- url: /policyquery
components:
schemas:
ConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
type:
- string
- 'null'
description: Value that should be returned when conditions are met
example: Relationship Manager
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
valueId:
type:
- string
- 'null'
description: Value Id that should be returned when conditions are met
example: RM
additionalProperties: false
DateTimePeriodFormulaSchemaDto:
type: object
properties:
formulaSetId:
type: string
format: uuid
versionNumber:
type:
- integer
- 'null'
format: int32
formulaString:
type:
- string
- 'null'
dateTimePeriodFormulaVariables:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/DateTimePeriodFormulaVariableDto'
additionalProperties: false
DataFieldDto:
type: object
properties:
propertyName:
type:
- string
- 'null'
description: Property name
example: firstName
propertyType:
type:
- string
- 'null'
description: Property type
example: text
propertyTypeId:
type:
- string
- 'null'
description: Property type id
format: uuid
example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
linkChildFieldPropertyName:
type:
- string
- 'null'
description: Linked child field property name
example: productCategory
linkedParentFieldPropertyName:
type:
- string
- 'null'
description: Linked Parent field property name
example: productCategory
externalSearchApiProviderId:
type:
- string
- 'null'
description: External search api provider id
format: uuid
example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c
propertyTypeVersion:
type:
- integer
- 'null'
description: Property version
format: int32
deprecated: true
formulaSchema:
allOf:
- $ref: '#/components/schemas/NumberFormulaSchemaDto'
description: Number formula schema
dateTimePeriodFormulaSchema:
allOf:
- $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto'
description: Date formula schema
additionalProperties: false
description: Response DTO representing data field data
ValueLimitRuleDtoConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto'
description: Request DTO representing value limit rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
SpecialCharactersRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
excludedCharacters:
type:
- array
- 'null'
items:
type: string
description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"]
additionalProperties: false
description: Request DTO representing special characters rule metadata
ValueLimitRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
BasicRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/BasicRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
ExternalProviderRuleDto:
type: object
properties:
providerId:
type: string
description: Id of external provider.
format: uuid
additionalProperties: false
description: Request DTO representing external provider rule metadata
CollectionMinimumCountRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
SpecialCharactersRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
excludedCharacters:
type:
- array
- 'null'
items:
type: string
description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"]
additionalProperties: false
description: Request DTO representing special characters rule metadata
EmptyRuleDtoConditionalValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/EmptyRuleDto'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto'
description: Conditional validation rules
additionalProperties: false
DateTimePeriodFormulaVariableDto:
type: object
properties:
dataSource:
type:
- string
- 'null'
timePeriodKind:
type:
- string
- 'null'
value:
type:
- string
- 'null'
type:
type:
- string
- 'null'
timeZoneId:
type:
- string
- 'null'
additionalProperties: false
CollectionMaximumCountRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
RegexRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
isCaseSensitive:
type: boolean
description: Flag that indicate if regex is case sensitive
example: false
regexValue:
type:
- string
- 'null'
description: Regex expression
example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$
additionalProperties: false
description: Request DTO representing regex rule metadata
AccessLayerDto:
type: object
properties:
geographic:
type:
- array
- 'null'
items:
type: string
businessRelated:
type:
- array
- 'null'
items:
type: string
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
additionalProperties: false
SpecialCharactersRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/SpecialCharactersRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
NumberFormulaVariableDto:
type: object
properties:
dataSource:
type:
- string
- 'null'
propertyName:
type:
- string
- 'null'
filterConditions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FilterConditionDto'
additionalProperties: false
ValidationDataDto:
type: object
properties:
isMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Mandatory Rule - does not allow empty value
specialCharacters:
allOf:
- $ref: '#/components/schemas/SpecialCharactersRuleDto2'
description: 'Special characters validation rule - does not allow special characters,
but allows define array of characters which can be ignored by the validation'
noNumbers:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that does not allow numbers
onlyInteger:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that allows only integers
noNegative:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that does not allow negative numbers
onlyDecimal:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that allows numbers up to two decimal places
regex:
allOf:
- $ref: '#/components/schemas/RegexRuleDto2'
description: Validation rule that validates the value against provided regex
characterLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2'
description: Validation rule that allows to set minimum and maximum count of characters
numberLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2'
description: Validation rule that allows to set number range
noFutureDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that does not allow future dates
noPastDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Validation rule that does not allow past dates
dateLimit:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto2'
description: Validation rule that allows to set date range
multiSelectLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2'
description: Validation rule that allows to set selection range
collectionMinimumCount:
allOf:
- $ref: '#/components/schemas/CollectionMinimumCountRuleDto2'
description: Validation rule that allows to set minimum count requirements for collection
collectionMaximumCount:
allOf:
- $ref: '#/components/schemas/CollectionMaximumCountRuleDto2'
description: Validation rule that allows to set maximum count requirements for collection
externalProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto2'
description: Validation rule that allows to use external provider for validation
externalDataGroupProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto2'
description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection
additionalProperties: false
description: Request DTO representing validation data metadata
RequirementsInScopeRequestDtoServiceRequest:
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/RequirementsInScopeRequestDto'
description: Response DTO representing filter parameters for in-scope query
additionalProperties: false
description: Service request data
ReferenceDto:
type: object
properties:
type:
type:
- string
- 'null'
description:
type:
- string
- 'null'
url:
type:
- string
- 'null'
additionalProperties: false
ExternalProviderRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
providerId:
type: string
description: Id of external provider.
format: uuid
additionalProperties: false
description: Request DTO representing external provider rule metadata
CollectionMaximumCountRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMaxCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with maximum count
example:
Registered: 1
overallMaximumCount:
type:
- integer
- 'null'
description: Overall maximum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection maximum count validation rule metadata
CollectionMaximumCountRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMaxCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with maximum count
example:
Registered: 1
overallMaximumCount:
type:
- integer
- 'null'
description: Overall maximum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection maximum count validation rule metadata
ValueLimitRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minValue:
type:
- integer
- 'null'
description: Minimum value
format: int32
example: 1
maxValue:
type:
- integer
- 'null'
description: Maximum value
format: int32
example: 10
additionalProperties: false
description: Request DTO representing value limit rule metadata
BasicRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
additionalProperties: false
description: Request DTO representing basic validation rule metadata
ConditionDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
additionalProperties: false
description: Represents condition root
RegexRuleDtoConditionalValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/RegexRuleDto'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RegexRuleDtoConditionalValueDto'
description: Conditional validation rules
additionalProperties: false
DateLimitRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minDate:
type:
- string
- 'null'
description: Minimum date
format: date-time
example: '2020-01-01T14:48:00.000Z'
maxDate:
type:
- string
- 'null'
description: Maximum date
format: date-time
example: '2021-01-01T14:48:00.000Z'
additionalProperties: false
description: Request DTO representing date limit rule metadata
RegexRuleDtoConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/RegexRuleDto'
description: Request DTO representing regex rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
ServiceResponse:
type: object
properties:
data:
type:
- string
- 'null'
description: The service response DTO
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
additionalProperties: false
description: Service response data
OwnershipValidationDataDto:
type: object
properties:
isMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Request DTO representing basic validation rule metadata
partyCount:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2'
description: Request DTO representing value limit rule metadata
addAllParties:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Request DTO representing basic validation rule metadata
idvIsMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Request DTO representing basic validation rule metadata
idvPartyCount:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2'
description: Request DTO representing value limit rule metadata
idvAllParties:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2'
description: Request DTO representing basic validation rule metadata
additionalProperties: false
ValueField:
type: object
properties:
dataSource:
type:
- string
- 'null'
description: Value of DataSource used to filter field values
field:
type:
- string
- 'null'
description: Field value used to validate conditional value
additionalProperties: false
BasicRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
additionalProperties: false
description: Request DTO representing basic validation rule metadata
DateLimitRuleDtoConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto'
description: Request DTO representing date limit rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
EmptyRuleDto:
type: object
additionalProperties: false
description: Request DTO representing rule with no parameters
BasicRuleDtoConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/BasicRuleDto'
description: Request DTO representing basic validation rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
CollectionMinimumCountRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMinCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with minimum count
example:
Registered: 1
overallMinimumCount:
type: integer
description: Overall minimum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection minimum count validation rule metadata
ValueLimitRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minValue:
type:
- integer
- 'null'
description: Minimum value
format: int32
example: 1
maxValue:
type:
- integer
- 'null'
description: Maximum value
format: int32
example: 10
additionalProperties: false
description: Request DTO representing value limit rule metadata
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
- 'null'
description: The Guid containing the property type id
format: uuid
example: 450df9bf-b2d3-48cf-ab8d-481c69b74373
linkChildFieldPropertyName:
type:
- string
- 'null'
description: 'The string containing the property name child of this property, only has value when propertyType is set to
"selectLink"'
example: country
linkedParentFieldPropertyName:
type:
- string
- 'null'
description: 'The string containing the property name parent of this property, only has value when propertyType is set to
"LinkedSelectV2" or "LinkedMultiSelectV2"'
example: country
dataGroupId:
type:
- string
- 'null'
description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup"
format: uuid
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
- 'null'
description: Requirement/data group field property name
example: firstName
friendlyName:
type:
- string
- 'null'
description: Requirement/data group field friendly Name
example: First Name
validationType:
type:
- string
- 'null'
description: Validation type
example: text
validationData:
allOf:
- $ref: '#/components/schemas/ValidationDataDto'
description: Request DTO representing validation data metadata
additionalProperties: false
description: Request DTO representing validation rule metadata
ExternalProviderRuleDtoValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto'
description: Static validation rule always applied when active
additionalProperties: false
RequirementDtoListServiceResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RequirementDto'
description: The service response DTO
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
additionalProperties: false
description: Service response data
DateLimitRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minDate:
type:
- string
- 'null'
description: Minimum date
format: date-time
example: '2020-01-01T14:48:00.000Z'
maxDate:
type:
- string
- 'null'
description: Maximum date
format: date-time
example: '2021-01-01T14:48:00.000Z'
additionalProperties: false
description: Request DTO representing date limit rule metadata
ObjectServiceResponse:
type: object
properties:
data:
description: The service response DTO
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
additionalProperties: false
description: Service response data
StringServiceResponse:
type: object
properties:
data:
type:
- string
- 'null'
description: The service response DTO
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
additionalProperties: false
description: Service response data
FilterConditionDto:
type: object
properties:
fieldName:
type:
- string
- 'null'
description: Field name for the filter condition
conditions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDto'
description: Conditions applied to the field
additionalProperties: false
ValueLimitRuleDtoConditionalValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto'
description: Conditional validation rules
additionalProperties: false
ActiveSetVersionResponseDto:
type: object
properties:
id:
type: string
description: The UiD of the requirement set version
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
setId:
type: string
description: The UiD of the requirement set that the version belongs to
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
requirementSetStatus:
type:
- string
- 'null'
description: Requirement set status
example: Active
jurisdiction:
type:
- string
- 'null'
description: Requirement set jurisdiction
example: Global
versionNumber:
type: integer
description: The versions number
format: int32
example: 1
effectiveFrom:
type: string
description: The date that the version takes effect when published
format: date-time
example: '2021-01-01T14:48:00.000Z'
effectiveUntil:
type:
- string
- 'null'
description: The calculated date that the version ceases being active
format: date-time
example: '2021-01-01T14:48:00.000Z'
status:
allOf:
- $ref: '#/components/schemas/VersionStatus'
description: The status of the version
example: Published
created:
type: string
description: The creation date of the version
format: date-time
example: '2021-01-01T14:48:00.000Z'
version:
type: integer
description: Version number for given Aggregate (concurrency check)
format: int32
example: 1
additionalProperties: false
description: Response DTO representing light requirement set version data
EmptyRuleDtoConditionalValueDto:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/EmptyRuleDto'
description: Request DTO representing rule with no parameters
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
NumberFormulaSchemaDto:
type: object
properties:
formulaSetId:
type: string
format: uuid
versionNumber:
type:
- integer
- 'null'
format: int32
formulaString:
type:
- string
- 'null'
formulaVariables:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/NumberFormulaVariableDto'
additionalProperties: false
ConditionDefinitionDto:
type: object
properties:
fieldName:
type:
- string
- 'null'
description: Name of the field to evaluate
example: EntityType
value:
type:
- array
- 'null'
items:
type: string
description: List of values
valueId:
type:
- array
- 'null'
items:
type: string
description: List of value ids
valueType:
type:
- string
- 'null'
description: Type of the value
example: text
dataSource:
type:
- string
- 'null'
description: Data source from which field is retrieved. If empty then Entity Data properties will be used.
example: entityDataMetadata
operation:
type:
- string
- 'null'
description: Logical operation to be performed to match the values
example: equal
logicalOperation:
type:
- string
- 'null'
description: Logical operation to be performed on the operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
valueField:
allOf:
- $ref: '#/components/schemas/ValueField'
description: Field value used for conditional limit validation
additionalProperties: false
description: Represents condition
RequirementsInScopeRequestDto:
type: object
properties:
name:
type:
- string
- 'null'
description: Exact name of the requirement
example: Fenergo Comprehensive Standard Policy Requirements
jurisdiction:
type:
- string
- 'null'
description: '(Deprecated - Use Jurisdictions instead)
Jurisdiction of the requirement'
example: Global
deprecated: true
jurisdictions:
type:
- array
- 'null'
items:
type: string
description: Jurisdictions of the requirement e.g. ["Global", "Ireland"]
type:
type:
- string
- 'null'
description: Type of requirement
example: Data
category:
type:
- array
- 'null'
items:
type: string
description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
entityType:
type:
- string
- 'null'
description: Type of entity
example: Company
isMandatory:
type:
- boolean
- 'null'
description: Mandatory flag of the requirement
example: true
isSensitiveData:
type:
- boolean
- 'null'
description: Sensitive data flag of the requirement
example: true
isMaterialData:
type:
- boolean
- 'null'
description: Materiality flag of the requirement
example: true
isIndexable:
type:
- boolean
- 'null'
description: Requirement is data indexed for search flag
example: true
dataField:
allOf:
- $ref: '#/components/schemas/DataFieldDto'
description: Data field definition
targetEntity:
type:
- string
- 'null'
description: Target entity
example: Client
includeConditions:
type: boolean
description: 'Include conditions flag.
If true, include the Requirements containing conditions.
If false, only the Requirements without conditions will be returned.'
example: false
additionalProperties: false
description: Response DTO representing filter parameters for in-scope query
ActiveSetVersionResponseDtoServiceResponse:
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/ActiveSetVersionResponseDto'
description: Response DTO representing light requirement set version data
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ServiceResponseMessage'
description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
additionalProperties: false
description: Service response data
RegexRuleDto:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
isCaseSensitive:
type: boolean
description: Flag that indicate if regex is case sensitive
example: false
regexValue:
type:
- string
- 'null'
description: Regex expression
example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$
additionalProperties: false
description: Request DTO representing regex rule metadata
DateLimitRuleDtoConditionalValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto'
description: Conditional validation rules
additionalProperties: false
VersionStatus:
enum:
- Draft
- Pending
- Rejected
- Published
- Archived
- Deleted
type: string
CollectionMinimumCountRuleDto2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMinCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with minimum count
example:
Registered: 1
overallMinimumCount:
type: integer
description: Overall minimum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection minimum count validation rule metadata
ServiceResponseMessage:
type: object
properties:
message:
type:
- string
- 'null'
description: The message
example: Success
type:
type:
- string
- 'null'
description: 'Type of the message
One of Info, Warning, Error, Forbidden'
example: Info
errorCode:
type:
- string
- 'null'
description: Error Code
example: INTERNAL_SERVER_ERROR
additionalProperties: false
description: The message associated to the service response
BasicRuleDtoConditionalValidationRuleDto:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/BasicRuleDto'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BasicRuleDtoConditionalValueDto'
description: Conditional validation rules
additionalProperties: false
RequirementDto:
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
- 'null'
description: The UiD of the tenant
example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1
category:
type:
- string
- 'null'
description: Requirement business category
example: Basic Details
description:
type:
- string
- 'null'
description: Requirement description
example: This is the client first name
template:
type:
- string
- 'null'
description: Requirement template
example: Product
entityType:
type:
- string
- 'null'
description: Requirement entity type
example: Individual
name:
type:
- string
- 'null'
description: Requirement name
example: First Name
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 and cannot be deleted or altered
example: false
jurisdiction:
type:
- string
- 'null'
description: Requirement jurisdiction
example: Global
references:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ReferenceDto'
description: Requirement references list
targetEntity:
type:
- string
- 'null'
description: Requirement target entity
example: Client
classification:
type:
- string
- 'null'
description: Requirement classification
example: Customer Profiling
type:
type:
- string
- 'null'
description: Requirement type
example: Data
conditions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDto'
description: Requirement conditions list
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
dataProtectionJurisdiction:
type:
- string
- 'null'
description: Jurisdiction for data protection
example: Global
order:
type:
- number
- 'null'
description: Order
format: double
example: 1
defaultValue:
type:
- string
- 'null'
description: Default Value
example: Not Available
isReadOnly:
type: boolean
description: Is requirement readonly
example: false
isIndexable:
type: boolean
description: Is requirement indexable
example: true
isJourneyLevelData:
type: boolean
description: Is journey level data
example: false
isMandatoryIndexable:
type: boolean
description: Is requirement mandatory indexable
example: true
isMandatory:
type: boolean
description: Is requirement mandatory
example: false
documentDescription:
type:
- string
- 'null'
description: Document Description
example: Driver License
documentDataKey:
type:
- string
- 'null'
description: Document Data Key
documentAccessLayers:
allOf:
- $ref: '#/components/schemas/AccessLayerDto'
description: Document Access Layers
acceptableDocumentDataKeys:
type:
- array
- 'null'
items:
type: string
description: List of acceptable Document Types for the Document Requirement
fieldAccessLayers:
allOf:
- $ref: '#/components/schemas/AccessLayerDto'
description: Field Access Layers
isMasked:
type: boolean
description: Flag indicating if field is masked due to missing Sensitive Data Access layers
example: false
ownershipDataKey:
type:
- string
- 'null'
description: Ownership Data Key
example: DataKey
partyTypes:
type:
- array
- 'null'
items:
type: string
description: Party Types e.g. ["Director"]
uboThreshold:
type:
- number
- 'null'
description: UBO Threshold
format: double
example: 0.6
relatedPartyEntityTypes:
type:
- array
- 'null'
items:
type: string
description: Types of Related Party Entity e.g. ["Individual"]
directAssociationsOnly:
type: boolean
description: Is Only direct association
example: false
idvOn:
type: boolean
description: Is Idv On
example: false
idvName:
type:
- string
- 'null'
description: Idv Name
example: IdentityRequirement
idvTooltip:
type:
- string
- 'null'
description: Idv Tooltip
example: Identity Requirement
ownershipValidationRule:
allOf:
- $ref: '#/components/schemas/OwnershipValidationRuleDto'
description: Ownership Validation Rule
validationRule:
allOf:
- $ref: '#/components/schemas/ValidationRuleDto'
description: Validation Rule
validationRulesV2:
allOf:
- $ref: '#/components/schemas/DataValidationRulesDto'
description: Request DTO representing validation data metadata
conditionalValues:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionalValueDto'
description: List of conditional values
hasEvaluatedConditionalValue:
type: boolean
description: Does this field has evaluated conditional value?
evaluatedConditionalValueId:
type:
- string
- 'null'
description: Evaluated conditional value Id
evaluatedConditionalValue:
type:
- string
- 'null'
description: Evaluated conditional value
tags:
type:
- array
- 'null'
items:
type: string
description: List of tags
clearValueIfTriggerConditionNotMet:
type: boolean
description: Indicates whether the field value should be cleared when trigger conditions are not met
example: false
aggregateVersion:
type:
- integer
- 'null'
description: Requirement aggregate version
format: int32
example: 1
uiDecoration:
type:
- string
- 'null'
description: Determines how the requirement should be rendered
uiColorDecoration:
type:
- string
- 'null'
description: Determines with what colour requirement should be rendered
portalGuidance:
type:
- string
- 'null'
description: Portal guidance
example: Provide at least one director RP
isLocked:
type: boolean
description: True if the aggregate is locked (obsolete)
example: false
deprecated: true
discriminator:
type:
- string
- 'null'
description: Data group field core definition flag (obsolete)
example: 'true'
deprecated: true
version:
type: integer
description: Requirement aggregate version (obsolete)
format: int32
example: true
deprecated: true
partyCount:
type:
- integer
- 'null'
description: Requirement party count
format: int32
example: 1
deprecated: true
partyType:
type:
- string
- 'null'
description: Requirement party type
example: Shareholder
deprecated: true
sourceEntityType:
type:
- string
- 'null'
description: Any of the related party entity types selected can be counted toward this requirement
example: Individual
deprecated: true
additionalProperties: false
description: Request DTO representing requirement metadata
DataValidationRulesDto:
type: object
properties:
mandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto'
description: Mandatory Rule - does not allow empty value
specialCharacters:
allOf:
- $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto'
description: 'Special characters validation rule - does not allow special characters,
but allows define array of characters which can be ignored by the validation'
noNumbers:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that does not allow numbers
onlyInteger:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that allows only integers
noNegative:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that does not allow negative numbers
onlyDecimal:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that allows numbers up to two decimal places
regex:
allOf:
- $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto'
description: Validation rule that validates the value against provided regex
characterLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto'
description: Validation rule that allows to set minimum and maximum count of characters
numberLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto'
description: Validation rule that allows to set number range
noFutureDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that does not allow future dates
noPastDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto'
description: Validation rule that does not allow past dates
dateLimit:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto'
description: Validation rule that allows to set date range
multiSelectLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto'
description: Validation rule that allows to set selection range
collectionMinimumCount:
allOf:
- $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto'
description: Validation rule that allows to set minimum count requirements for collection
collectionMaximumCount:
allOf:
- $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto'
description: Validation rule that allows to set maximum count requirements for collection
externalProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto'
description: Validation rule that allows to use external provider for validation
externalDataGroupProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto'
description: Validation rule that allows to use external provider for validation of one field with other fields as context
readOnly:
allOf:
- $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto'
description: Validation rule that allows to set if field should be read only
conditionalLimit:
allOf:
- $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto'
description: Validation rule that validates the dynamic value against provided condition
timeZoneId:
type:
- string
- 'null'
description: Time zone id used for date values validation in order to determine exact Today time range
example: Europe/Warsaw
additionalProperties: false
description: Request DTO representing validation data metadata
SearchRequirementsDto:
type: object
properties:
name:
type:
- string
- 'null'
description: Exact name of the requirement
example: Fenergo Comprehensive Standard Policy Requirements
type:
type:
- string
- 'null'
description: Type of requirement
example: Data
jurisdictions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VersionedJurisdictionDto'
description: Jurisdictions of the requirement in specific version. Null versionId will get the latest.
category:
type:
- array
- 'null'
items:
type: string
description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
entityType:
type:
- string
- 'null'
description: Type of entity
example: Company
isMandatory:
type:
- boolean
- 'null'
description: Mandatory flag of the requirement
example: true
isSensitiveData:
type:
- boolean
- 'null'
description: Sensitive data flag of the requirement
example: true
isMaterialData:
type:
- boolean
- 'null'
description: Materiality flag of the requirement
example: true
isIndexable:
type:
- boolean
- 'null'
description: Requirement is data indexed for search flag
example: true
dataField:
allOf:
- $ref: '#/components/schemas/DataFieldDto'
description: Data field definition
targetEntity:
type:
- string
- 'null'
description: Target entity
example: Client
includeConditions:
type: boolean
description: 'Include conditions flag.
If true, include the Requirements containing conditions.
If false, only the Requirements without conditions will be returned.
false'
additionalProperties: false
description: Request DTO representing requirements search filter
EntityAssociationDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
associationType:
type:
- string
- 'null'
ownershipPercentage:
type:
- number
- 'null'
format: double
associationToClient:
type:
- string
- 'null'
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Generic properties
additionalProperties: false
EntityDataMetadataDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
entityType:
type:
- string
- 'null'
additionalProperties: false
ManualCreditScreeningDto:
type: object
properties:
taskDataKey:
type:
- string
- 'null'
description: Task Data Key
taskId:
type: string
description: Task Id
format: uuid
entityId:
type: string
description: Entity Id
format: uuid
creditScreeningOutcome:
type:
- string
- 'null'
description: The outcome recorded for a manual screening task.
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy for manual credit screening
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
RelatedPartyDto:
type: object
properties:
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Generic properties setup in policy
metadata:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
description: The properties from the actual relationship
additionalProperties: false
ReviewAndApprovalDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy for review and approval task
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
approvalOutcome:
type:
- string
- 'null'
description: The Approval Outcome of the task
approvalReason:
type:
- string
- 'null'
description: The Reason of the approval decision.
taskId:
type:
- string
- 'null'
description: Task Id
taskDataKey:
type:
- string
- 'null'
description: Task Data Key
additionalProperties: false
ChangedFieldsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
changedFields:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ChangedFieldDto'
additionalProperties: false
RelatedAssetDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
EvaluateRequirementsInScopeRequestDtoServiceRequest:
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/EvaluateRequirementsInScopeRequestDto'
description: The service request DTO
additionalProperties: false
description: Service request data
CurrentFieldDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
currentField:
type:
- string
- 'null'
additionalProperties: false
AutoCreditScreeningDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
creditScreenings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AutoCreditScreeningDto'
relatedPartyCreditScreenings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AutoCreditScreeningDto'
additionalProperties: false
SignificanceEngineDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
significanceEngine:
allOf:
- $ref: '#/components/schemas/SignificanceEngineDto'
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
- 'null'
additionalProperties: false
discriminator:
propertyName: type
mapping:
Collection: '#/components/schemas/CollectionPropertyDto'
Custom: '#/components/schemas/CustomPropertyDto'
Single: '#/components/schemas/SinglePropertyDto'
JourneyLevelDataDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
additionalProperties: false
AutoCreditAssessmentDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
autoCreditAssessments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AutoCreditAssessmentDto'
additionalProperties: false
SearchRequirementsDtoServiceRequest:
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/SearchRequirementsDto'
description: Request DTO representing requirements search filter
additionalProperties: false
description: Service request data
RelatedDocumentVersionedDto:
type: object
properties:
documentKey:
type:
- string
- 'null'
documentType:
type:
- string
- 'null'
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
CollectionItemDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/SinglePropertyDto2'
additionalProperties: false
CollectionPropertyDto2:
type: object
properties:
items:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/CollectionItemDto'
collectionId:
type:
- string
- 'null'
format: uuid
additionalProperties: false
MainEntityDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
additionalProperties: false
VersionedJurisdictionDto:
type: object
properties:
jurisdiction:
type:
- string
- 'null'
description: Jurisdiction of the requirement
example: Global
versionId:
type:
- string
- 'null'
description: Jurisdiction of the requirement
format: uuid
example: 894e1443-dd7a-4b9d-b253-430c2de80524
additionalProperties: false
RelatedFCRDto:
type: object
properties:
status:
type:
- string
- 'null'
description: The status of the FCR.
createdDate:
type: string
description: The date the FCR was created.
format: date-time
submittedDate:
type:
- string
- 'null'
description: The date the FCR was submitted.
format: date-time
additionalProperties: false
CustomPropertyDto2:
type: object
properties:
singleProperties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/SinglePropertyDto2'
customProperties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/CustomPropertyDto2'
additionalProperties: false
RelatedDocumentsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
documents:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedDocumentDto'
additionalProperties: false
ExternalDataAdapterDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
eventType:
type:
- string
- 'null'
eventSubtype:
type:
- string
- 'null'
additionalProperties: false
RelatedAssetsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
assets:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedAssetDto'
additionalProperties: false
InvestmentAccountDto:
type: object
properties:
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Generic properties of a single in-scope investment account
additionalProperties: false
CurrentDataGroupItemDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
type:
- object
- 'null'
additionalProperties:
type:
- string
- 'null'
additionalProperties: false
ScreeningMaterialityDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
assessments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ScreeningMaterialityAssessmentDto'
additionalProperties: false
description: 'Data source for Screening Materiality Assessment outcomes.
Contains a list of assessments — one per entity in the batch (main entity and related parties).'
InvestmentAccountFundDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Properties of the single investment account fund
additionalProperties: false
DataSourcesDto:
type: object
properties:
entityDataMetadata:
allOf:
- $ref: '#/components/schemas/EntityDataMetadataDataSource'
description: DataSource for EntityDraft information beside generic properties
eventIngress:
allOf:
- $ref: '#/components/schemas/EventIngressDataSource'
description: DataSource for EventIngress event details
changedFields:
allOf:
- $ref: '#/components/schemas/ChangedFieldsDataSource'
description: DataSource for detecting changed EntityDraft properties in comparasion with verified Entity
relatedClient:
allOf:
- $ref: '#/components/schemas/RelatedClientDataSource'
description: DataSource for new Related Client properties added in Association task
relatedProducts:
allOf:
- $ref: '#/components/schemas/RelatedProductsDataSource'
description: DataSource for new Related Product properties added in Manage Product task
currentDataGroupItem:
allOf:
- $ref: '#/components/schemas/CurrentDataGroupItemDataSource'
description: DataSource for single, current data group row item. Can be used only for Data Group field conditions.
externalDataAdapter:
allOf:
- $ref: '#/components/schemas/ExternalDataAdapterDataSource'
description: DataSource for External Data Adapter (Ongoing Monitoring) event details
entityAssociation:
allOf:
- $ref: '#/components/schemas/EntityAssociationDataSource'
description: DataSource for entity association details
manualCreditAssessment:
allOf:
- $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource'
description: DataSource for manual credit assessment
reviewAndApproval:
allOf:
- $ref: '#/components/schemas/ReviewAndApprovalDataSource'
description: DataSource for review and approval
autoCreditAssessment:
allOf:
- $ref: '#/components/schemas/AutoCreditAssessmentDataSource'
description: DataSource for auto credit assessment
manualCreditScreening:
allOf:
- $ref: '#/components/schemas/ManualCreditScreeningDataSource'
collateral:
allOf:
- $ref: '#/components/schemas/CollateralDataSource'
currentJourneys:
allOf:
- $ref: '#/components/schemas/CurrentJourneysDataSource'
description: DataSource for entity current journeys
autoCreditScreening:
allOf:
- $ref: '#/components/schemas/AutoCreditScreeningDataSource'
description: DataSource for auto credit screening
currentProduct:
allOf:
- $ref: '#/components/schemas/CurrentProductDataSource'
description: DataSource for product scoping
relatedDeals:
allOf:
- $ref: '#/components/schemas/RelatedDealsDataSource'
description: DataSource for related deals
mainEntity:
allOf:
- $ref: '#/components/schemas/MainEntityDataSource'
description: DataSource for main entity properties used for condition evaluation
relatedAssets:
allOf:
- $ref: '#/components/schemas/RelatedAssetsDataSource'
description: DataSource for related assets
relatedAssociations:
allOf:
- $ref: '#/components/schemas/RelatedAssociationsDataSource'
description: DataSource for related associations
accountRelatedFunds:
allOf:
- $ref: '#/components/schemas/AccountRelatedFundsDataSource'
description: DataSource for account related funds
investmentAccountFund:
allOf:
- $ref: '#/components/schemas/InvestmentAccountFundDataSource'
description: DataSource for investment account fund
investmentAccountRelatedFundShareClass:
allOf:
- $ref: '#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource'
description: DataSource for investment account related fund share class
investmentAccount:
allOf:
- $ref: '#/components/schemas/InvestmentAccountDataSource'
description: DataSource for in-scope investment accounts, evaluated across all accounts on the entity
journeyLevelData:
allOf:
- $ref: '#/components/schemas/JourneyLevelDataDataSource'
description: DataSource for draft properties using journey level data requirements used for journey scoping
relatedParties:
allOf:
- $ref: '#/components/schemas/RelatedPartiesDataSource'
description: DataSource for related parties entity properties
currentField:
allOf:
- $ref: '#/components/schemas/CurrentFieldDataSource'
description: DataSource for condtional limit validation
significanceEngine:
allOf:
- $ref: '#/components/schemas/SignificanceEngineDataSource'
description: DataSource for significance engine
alert:
allOf:
- $ref: '#/components/schemas/AlertDataSource'
description: DataSource for Transaction Monitoring Alert
relatedFCRs:
allOf:
- $ref: '#/components/schemas/RelatedFCRsDataSource'
description: DataSource for related FCRs in product domain
relatedInvestmentManager:
allOf:
- $ref: '#/components/schemas/RelatedInvestmentManagerDataSource'
description: Related Investment Manager data source for product domain
relatedUnderlyingPrincipalOwner:
allOf:
- $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource'
description: Data Source for Related UP Owners
alertAssessment:
allOf:
- $ref: '#/components/schemas/AlertAssessmentDataSource'
description: DataSource for Transaction Monitoring Alert assessment outcomes
currentProductMetadata:
allOf:
- $ref: '#/components/schemas/CurrentProductMetadataDataSource'
description: DataSource for Product Metadata
currentUser:
allOf:
- $ref: '#/components/schemas/CurrentUserDataSource'
description: DataSource for current user
relatedDocuments:
allOf:
- $ref: '#/components/schemas/RelatedDocumentsDataSource'
description: DataSource for related documents
screeningMateriality:
allOf:
- $ref: '#/components/schemas/ScreeningMaterialityDataSource'
description: DataSource for Screening Materiality Assessment outcomes for the entity being evaluated (main entity or a specific related party).
additionalProperties: false
AlertDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
source:
type:
- string
- 'null'
type:
type:
- string
- 'null'
attribute:
type:
- string
- 'null'
additionalProperties: false
RelatedInvestmentManagerDataSource:
type: object
properties:
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
dataSource:
type:
- string
- 'null'
readOnly: true
additionalProperties: false
EvaluateRequirementsInScopeRequestDto:
type: object
properties:
requirementTypes:
type:
- array
- 'null'
items:
type: string
description: List of requirement types [Data, Document, OwnershipAndControl]
jurisdictions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VersionedJurisdictionDto'
description: Jurisdictions of the requirement in specific version
targetEntity:
type:
- string
- 'null'
description: Target entity
example: Client
entityType:
type:
- string
- 'null'
description: Type of entity
example: Company
categories:
type:
- array
- 'null'
items:
type: string
description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Entity data properties used for condition evaluation
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
dataSources:
allOf:
- $ref: '#/components/schemas/DataSourcesDto'
description: Additional data sources used for evaluation
additionalProperties: false
RelatedProductDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in product policy
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
lifecycleStatus:
type:
- string
- 'null'
description: System field used in backend for status of a product in lifecycle
relationshipTypes:
type:
- array
- 'null'
items:
type: string
description: System field used in backend for product of a product relationship
additionalProperties: false
AutoCreditScreeningDto:
type: object
properties:
entityId:
type: string
description: Entity Id
format: uuid
creditScreeningOutcome:
type:
- string
- 'null'
description: The outcome recorded for a manual screening task.
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy for auto credit screening
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
providerInternalIdentifier:
type:
- string
- 'null'
description: Provider Internal Identifier
additionalProperties: false
RelatedAssociationsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
relatedAssociations:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedAssociationDto'
additionalProperties: false
RelatedClientDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
InvestmentAccountDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
investmentAccount:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/InvestmentAccountDto'
additionalProperties: false
CurrentUserDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
teamIds:
type:
- array
- 'null'
items:
type: string
format: uuid
isSystemUser:
type: boolean
additionalProperties: false
RequirementsInScopeRequestV2DtoServiceRequest:
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/RequirementsInScopeRequestV2Dto'
description: Request DTO representing requirements search filter
additionalProperties: false
description: Service request data
CollateralDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
RelatedDealsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
relatedDeals:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedDealDto'
additionalProperties: false
CurrentProductMetadataDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
isAgency:
type:
- string
- 'null'
lifecycleStatus:
type:
- string
- 'null'
additionalProperties: false
SinglePropertyDto2:
type: object
properties:
value:
type:
- string
- 'null'
valueId:
type:
- string
- 'null'
additionalProperties: false
ScreeningMaterialityAssessmentDto:
type: object
properties:
mainEntity:
type: boolean
description: Whether this assessment is for the main entity (true) or a related party (false).
materialityOutcome:
type:
- string
- 'null'
description: Overall materiality outcome of the screening assessment (e.g. "Material", "Non-Material").
pepMaterialityStatus:
type:
- string
- 'null'
description: PEP (Politically Exposed Person) materiality status.
sanctionsMaterialityStatus:
type:
- string
- 'null'
description: Sanctions materiality status.
adverseMediaMaterialityStatus:
type:
- string
- 'null'
description: Adverse media materiality status.
enforcementsMaterialityStatus:
type:
- string
- 'null'
description: Enforcements materiality status.
otherMaterialityStatus:
type:
- string
- 'null'
description: Other (non-categorised) materiality status.
pepJurisdictions:
type:
- array
- 'null'
items:
type: string
description: PEP jurisdictions associated with this assessment.
sanctionsJurisdictions:
type:
- array
- 'null'
items:
type: string
description: Sanctions jurisdictions associated with this assessment.
adverseMediaJurisdictions:
type:
- array
- 'null'
items:
type: string
description: Adverse media jurisdictions associated with this assessment.
enforcementsJurisdictions:
type:
- array
- 'null'
items:
type: string
description: Enforcements jurisdictions associated with this assessment.
otherJurisdictions:
type:
- array
- 'null'
items:
type: string
description: Other jurisdictions associated with this assessment.
sanctionsProceedDecision:
type:
- string
- 'null'
description: Sanctions ok-to-proceed decision text returned by Screening (e.g. "Ok to proceed", "Not to proceed").
additionalProperties: false
RequirementsInScopeRequestV2Dto:
type: object
properties:
type:
type:
- string
- 'null'
description: Type of requirement
example: Data
name:
type:
- string
- 'null'
description: Exact name of the requirement
example: Fenergo Comprehensive Standard Policy Requirements
category:
type:
- array
- 'null'
items:
type: string
description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
jurisdictions:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/VersionedJurisdictionDto'
description: Jurisdictions of the requirement in specific version. Null versionId will get the latest.
isMandatory:
type:
- boolean
- 'null'
description: Mandatory flag of the requirement
example: true
entityType:
type:
- string
- 'null'
description: Type of entity
example: Company
isMaterialData:
type:
- boolean
- 'null'
description: Materiality flag of the requirement
example: true
isSensitiveData:
type:
- boolean
- 'null'
description: Sensitive data flag of the requirement
example: true
dataField:
allOf:
- $ref: '#/components/schemas/DataFieldDto'
description: Data field definition
isIndexable:
type:
- boolean
- 'null'
description: Requirement is data indexed for search flag
example: true
includeConditions:
type: boolean
description: 'Include conditions flag.
If true, include the Requirements containing conditions.
If false, only the Requirements without conditions will be returned.
false'
targetEntity:
type:
- string
- 'null'
description: Target entity
example: Client
disableFilteringForConditionalValues:
type: boolean
description: Do not filter requirements that have evaluated conditional values by categories
enableBasicDataRequirementsFiltering:
type: boolean
description: 'Filter data requirements only by basic properties: Target entity and Entity type'
disableDeduplication:
type: boolean
description: Disable Requirements deduplication based on data key
example: true
additionalProperties: false
description: Request DTO representing requirements search filter
EventIngressDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
eventType:
type:
- string
- 'null'
eventSubtype:
type:
- string
- 'null'
additionalProperties: false
ChangedFieldDto:
type: object
properties:
key:
type:
- string
- 'null'
additionalProperties: false
RelatedPartiesDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
relatedParties:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedPartyDto'
additionalProperties: false
InvestmentAccountRelatedFundShareClassDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Properties of the investment account related fund share class
additionalProperties: false
AlertAssessmentDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
assessments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AlertAssessmentDto'
lastAssessment:
allOf:
- $ref: '#/components/schemas/AlertAssessmentDto'
lastAssessmentOutcome:
type:
- string
- 'null'
lastAssessmentDisposition:
type:
- string
- 'null'
additionalProperties: false
PropertiesDto:
type: object
properties:
singleProperties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/SinglePropertyDto2'
collectionProperties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/CollectionPropertyDto2'
customProperties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/CustomPropertyDto2'
additionalProperties: false
CurrentJourneysDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
inProgressJourneyTypes:
type:
- array
- 'null'
items:
type: string
additionalProperties: false
SignificanceEngineDto:
type: object
properties:
singleFields:
type:
- array
- 'null'
items:
type: string
collections:
type:
- object
- 'null'
additionalProperties:
type:
- object
- 'null'
additionalProperties:
type: array
items:
type: string
additionalProperties: false
RelatedUnderlyingPrincipalOwnerDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
additionalProperties: false
ManualCreditAssessmentV2DataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
creditAssessments:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CreditAssessmentDto'
additionalProperties: false
RelatedFCRsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
fcRs:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedFCRDto'
additionalProperties: false
AlertAssessmentDto:
type: object
properties:
category:
type:
- string
- 'null'
additionalProperties: false
AccountRelatedFundDto:
type: object
properties:
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Generic properties
additionalProperties: false
ReviewAndApprovalDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
reviewAndApprovals:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ReviewAndApprovalDto'
additionalProperties: false
CreditAssessmentDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy for manual credit assessment
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
assessmentOutcome:
type:
- string
- 'null'
description: Assessment Outcome of this manual credit assessment
assessmentComment:
type:
- string
- 'null'
description: Assessment Comment of this credit assessment
taskId:
type:
- string
- 'null'
description: Task Id
taskDataKey:
type:
- string
- 'null'
description: Task Data Key
additionalProperties: false
RelatedDocumentDto:
type: object
properties:
document:
allOf:
- $ref: '#/components/schemas/RelatedDocumentVersionedDto'
additionalProperties: false
CollateralDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
collaterals:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/CollateralDto'
additionalProperties: false
RelatedDealDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
additionalProperties: false
RelatedAssociationDto:
type: object
properties:
associationType:
type:
- string
- 'null'
description: Type of this association
example: 'Employee of '
ownershipPercentage:
type:
- number
- 'null'
description: Ownership Percentage of this association
format: double
example: 0.5
associationToClient:
type:
- string
- 'null'
description: Association To Client
example: Direct/Indirect
properties:
allOf:
- $ref: '#/components/schemas/PropertiesDto'
description: Generic properties
additionalProperties: false
AutoCreditAssessmentDto:
type: object
properties:
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in policy for manual credit assessment
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
assessmentOutcome:
type:
- string
- 'null'
description: Assessment Outcome of this manual credit assessment
providerInternalIdentifier:
type:
- string
- 'null'
description: Provider Internal Identifier
additionalProperties: false
RelatedProductsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
products:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RelatedProductDto'
additionalProperties: false
AccountRelatedFundsDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
accountRelatedFunds:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AccountRelatedFundDto'
additionalProperties: false
CurrentProductDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
properties:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/PropertyDto'
description: Generic properties setup in product policy
example:
firstName:
type: Single
value: Tom
dateOfBirth:
type: Single
value: '2021-07-15'
address:
type: Collection
dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc
collections:
54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
properties:
country: Ireland
city: Dublin
street: Mayor Street
47010265-3b85-4407-be61-90d04525f020:
properties:
country: Ireland
city: Dublin
street: E Wall Rd
lifecycleStatus:
type:
- string
- 'null'
description: System field used in backend for status of a product in lifecycle
additionalProperties: false
ManualCreditScreeningDataSource:
type: object
properties:
dataSource:
type:
- string
- 'null'
readOnly: true
creditScreenings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ManualCreditScreeningDto'
relatedPartyCreditScreenings:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ManualCreditScreeningDto'
additionalProperties: false
PropertyType:
enum:
- Single
- Custom
- Collection
type: string
CollectionMinimumCountRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/CollectionMinimumCountRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
SpecialCharactersRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
excludedCharacters:
type:
- array
- 'null'
items:
type: string
description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"]
additionalProperties: false
description: Request DTO representing special characters rule metadata
ValueLimitRuleDtoConditionalValueDto_2:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2_2'
description: Request DTO representing value limit rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
ValueLimitRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
BasicRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
SpecialCharactersRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
excludedCharacters:
type:
- array
- 'null'
items:
type: string
description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"]
additionalProperties: false
description: Request DTO representing special characters rule metadata
ExternalProviderRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
providerId:
type: string
description: Id of external provider.
format: uuid
additionalProperties: false
description: Request DTO representing external provider rule metadata
CollectionMaximumCountRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/CollectionMaximumCountRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
RegexRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
isCaseSensitive:
type: boolean
description: Flag that indicate if regex is case sensitive
example: false
regexValue:
type:
- string
- 'null'
description: Regex expression
example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$
additionalProperties: false
description: Request DTO representing regex rule metadata
SpecialCharactersRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/SpecialCharactersRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
ValidationDataDto_2:
type: object
properties:
isMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Mandatory Rule - does not allow empty value
specialCharacters:
allOf:
- $ref: '#/components/schemas/SpecialCharactersRuleDto_2'
description: 'Special characters validation rule - does not allow special characters,
but allows define array of characters which can be ignored by the validation'
noNumbers:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that does not allow numbers
onlyInteger:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that allows only integers
noNegative:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that does not allow negative numbers
onlyDecimal:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that allows numbers up to two decimal places
regex:
allOf:
- $ref: '#/components/schemas/RegexRuleDto_2'
description: Validation rule that validates the value against provided regex
characterLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto_2'
description: Validation rule that allows to set minimum and maximum count of characters
numberLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto_2'
description: Validation rule that allows to set number range
noFutureDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that does not allow future dates
noPastDates:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Validation rule that does not allow past dates
dateLimit:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto_2'
description: Validation rule that allows to set date range
multiSelectLimit:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto_2'
description: Validation rule that allows to set selection range
collectionMinimumCount:
allOf:
- $ref: '#/components/schemas/CollectionMinimumCountRuleDto_2'
description: Validation rule that allows to set minimum count requirements for collection
collectionMaximumCount:
allOf:
- $ref: '#/components/schemas/CollectionMaximumCountRuleDto_2'
description: Validation rule that allows to set maximum count requirements for collection
externalProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto_2'
description: Validation rule that allows to use external provider for validation
externalDataGroupProvider:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto_2'
description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection
additionalProperties: false
description: Request DTO representing validation data metadata
CollectionMaximumCountRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMaxCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with maximum count
example:
Registered: 1
overallMaximumCount:
type:
- integer
- 'null'
description: Overall maximum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection maximum count validation rule metadata
CollectionMaximumCountRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMaxCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with maximum count
example:
Registered: 1
overallMaximumCount:
type:
- integer
- 'null'
description: Overall maximum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection maximum count validation rule metadata
ValueLimitRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minValue:
type:
- integer
- 'null'
description: Minimum value
format: int32
example: 1
maxValue:
type:
- integer
- 'null'
description: Maximum value
format: int32
example: 10
additionalProperties: false
description: Request DTO representing value limit rule metadata
BasicRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
additionalProperties: false
description: Request DTO representing basic validation rule metadata
RegexRuleDtoConditionalValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/RegexRuleDto2_2'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RegexRuleDtoConditionalValueDto_2'
description: Conditional validation rules
additionalProperties: false
DateLimitRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minDate:
type:
- string
- 'null'
description: Minimum date
format: date-time
example: '2020-01-01T14:48:00.000Z'
maxDate:
type:
- string
- 'null'
description: Maximum date
format: date-time
example: '2021-01-01T14:48:00.000Z'
additionalProperties: false
description: Request DTO representing date limit rule metadata
RegexRuleDtoConditionalValueDto_2:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/RegexRuleDto2_2'
description: Request DTO representing regex rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
OwnershipValidationDataDto_2:
type: object
properties:
isMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Request DTO representing basic validation rule metadata
partyCount:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto_2'
description: Request DTO representing value limit rule metadata
addAllParties:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Request DTO representing basic validation rule metadata
idvIsMandatory:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Request DTO representing basic validation rule metadata
idvPartyCount:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto_2'
description: Request DTO representing value limit rule metadata
idvAllParties:
allOf:
- $ref: '#/components/schemas/BasicRuleDto_2'
description: Request DTO representing basic validation rule metadata
additionalProperties: false
BasicRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
additionalProperties: false
description: Request DTO representing basic validation rule metadata
DateLimitRuleDtoConditionalValueDto_2:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto2_2'
description: Request DTO representing date limit rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
BasicRuleDtoConditionalValueDto_2:
type: object
properties:
id:
type: string
description: The ID of the condition
format: uuid
example: 118313c6-91e6-4b05-a537-5a1ab906418f
name:
type:
- string
- 'null'
description: The name of the condition
example: Company-type only
description:
type:
- string
- 'null'
description: The description of the condition
example: Applicable only when EntityType=Company
logicalOperation:
type:
- string
- 'null'
description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection
example: AND
operands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ConditionDefinitionDto'
description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto
value:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2_2'
description: Request DTO representing basic validation rule metadata
priority:
type: integer
description: Priority of the value in case when multiple conditional values are evaluated
format: int32
example: 1
additionalProperties: false
CollectionMinimumCountRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMinCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with minimum count
example:
Registered: 1
overallMinimumCount:
type: integer
description: Overall minimum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection minimum count validation rule metadata
ValueLimitRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minValue:
type:
- integer
- 'null'
description: Minimum value
format: int32
example: 1
maxValue:
type:
- integer
- 'null'
description: Maximum value
format: int32
example: 10
additionalProperties: false
description: Request DTO representing value limit rule metadata
ExternalProviderRuleDtoValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ExternalProviderRuleDto2_2'
description: Static validation rule always applied when active
additionalProperties: false
DateLimitRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
minDate:
type:
- string
- 'null'
description: Minimum date
format: date-time
example: '2020-01-01T14:48:00.000Z'
maxDate:
type:
- string
- 'null'
description: Maximum date
format: date-time
example: '2021-01-01T14:48:00.000Z'
additionalProperties: false
description: Request DTO representing date limit rule metadata
ValueLimitRuleDtoConditionalValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/ValueLimitRuleDto2_2'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto_2'
description: Conditional validation rules
additionalProperties: false
RegexRuleDto_2:
type: object
properties:
active:
type: boolean
description: Validation rule active flag
example: true
message:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
isCaseSensitive:
type: boolean
description: Flag that indicate if regex is case sensitive
example: false
regexValue:
type:
- string
- 'null'
description: Regex expression
example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$
additionalProperties: false
description: Request DTO representing regex rule metadata
DateLimitRuleDtoConditionalValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/DateLimitRuleDto2_2'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto_2'
description: Conditional validation rules
additionalProperties: false
CollectionMinimumCountRuleDto2_2:
type: object
properties:
errorMessage:
type:
- string
- 'null'
description: Validation rule error message
example: Validation error occurred
requiredTypesMinCount:
type:
- object
- 'null'
additionalProperties:
type: integer
format: int32
description: Dictionary of required Primary Data Group Field values with minimum count
example:
Registered: 1
overallMinimumCount:
type: integer
description: Overall minimum count
format: int32
example: 1
additionalProperties: false
description: Request DTO representing collection minimum count validation rule metadata
BasicRuleDtoConditionalValidationRuleDto_2:
type: object
properties:
isActive:
type: boolean
description: Validation rule active flag
example: true
staticRule:
allOf:
- $ref: '#/components/schemas/BasicRuleDto2_2'
description: Static validation rule always applied when active
dynamicRules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/BasicRuleDtoConditionalValueDto_2'
description: Conditional validation rules
additionalProperties: false
ExternalProviderRuleDto2_2:
type: object
properties:
providerId:
type: string
description: Id of external provider.
format: uuid
additionalProperties: false
description: Request DTO representing external provider rule metadata
securitySchemes:
Bearer:
type: apiKey
description: Please insert JWT with Bearer into field
name: Authorization
in: header
x-refined-from:
- fenergo-policyquery-v1-0-openapi.json
- fenergo-policyquery-v2-0-openapi.json
- fenergo-policyquery-v3-0-openapi.json