openapi: 3.2.0 info: title: Fenergo Field API version: '1.0' description: 'Operations tagged Field across 2 of this provider''s published API definitions: fenergo-policycommand-v2-0-openapi.json, fenergo-policyquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /policycommand - url: /policyquery security: - Bearer: [] tags: - name: Field paths: /api/v2/policies/{entityPolicyId}/fields: post: tags: - Field summary: Create a new policy field description: 'Creates a new field within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: CreatePolicyField parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID schema: type: string format: uuid - 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: Create field request content: application/json: schema: allOf: - $ref: '#/components/schemas/PolicyFieldRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Field created content: application/json: schema: $ref: '#/components/schemas/CreatePolicyFieldResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy with a given ID does not exist status: 404 '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.8 title: There are conflicts that cannot be resolved automatically, get latest and apply your changes detail: There are conflicts that cannot be resolved automatically, get latest and apply your changes status: 409 errorCode: CONFLICT '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/fields/{fieldId}: put: tags: - Field summary: Update a policy field description: 'Updates an existing field within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: UpdatePolicyField parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: fieldId in: path description: Field ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID schema: type: string format: uuid - 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: Update field request content: application/json: schema: allOf: - $ref: '#/components/schemas/PolicyFieldRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Field updated content: application/json: schema: $ref: '#/components/schemas/UpdatePolicyFieldResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or field with a given ID does not exist status: 404 '409': description: Conflict saving changes in expected version content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.8 title: There are conflicts that cannot be resolved automatically, get latest and apply your changes detail: There are conflicts that cannot be resolved automatically, get latest and apply your changes status: 409 errorCode: CONFLICT '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT delete: tags: - Field summary: Delete a policy field description: 'Deletes an existing field from the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: DeletePolicyField parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: fieldId in: path description: Field ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID schema: type: string format: uuid - 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: '202': description: Success. Field deleted '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or field with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/fields/{fieldId}/revert: put: tags: - Field summary: Revert a policy field changes description: 'Reverts changes made to an existing field within the specified workspace context. Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: RevertPolicyField parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: fieldId in: path description: Field ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID schema: type: string format: uuid - 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: '202': description: Success. Field updated content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or field with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v4/policies/{entityPolicyId}/fields/{fieldId}: get: tags: - Field summary: Get specific field from a specific version of the policy description: 'Returns field. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetField parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: fieldId in: path description: ID of the field required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. If not provided, default workspace will be used schema: type: string format: uuid - 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. Field is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields/{fieldId}: get: tags: - Field summary: Get specific field from a specific version of the policy description: 'Returns field. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetHistoricField parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: fieldId in: path description: ID of the field required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 type: integer format: int32 - 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. Field is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/fields: post: tags: - Field summary: Get fields from the current version of the policy description: 'Returns fields. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListFields parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. If not provided, default workspace will be used schema: type: string format: uuid - 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: Defines pagination, sorting and filtering content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchEntityPolicyFieldsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of fields is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields: post: tags: - Field summary: Get fields from the current version of the policy description: 'Returns fields. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListHistoricFields parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 type: integer format: int32 - 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: Defines pagination, sorting and filtering content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchEntityPolicyFieldsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of fields is returned content: application/json: schema: $ref: '#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/fields/summary: post: tags: - Field summary: Get fields' summary from the current version of the policy. description: 'Returns fields summary. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListFieldsSummary parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. schema: type: string format: uuid - 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: Request object that defines filters. content: application/json: schema: allOf: - $ref: '#/components/schemas/ListFieldsSummaryRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of fields is returned content: application/json: schema: $ref: '#/components/schemas/ListFieldsSummaryResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/fields/evaluate: post: tags: - Field summary: Evaluate fields for a specific policy version description: 'Evaluates fields based on provided filters and data sources. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: EvaluateFields parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 type: integer format: int32 - 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: Evaluation request with filters and data sources content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateFieldsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. Evaluated fields are returned content: application/json: schema: $ref: '#/components/schemas/EvaluateFieldsResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/fields/{entityType}/indexable: get: tags: - Field summary: Returns all indexable fields for the given entity type as two collections… description: 'Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetIndexableFields parameters: - name: entityType in: path description: Entity type (e.g. "Individual", "Company") required: true schema: type: string - name: searchTerms in: query description: Optional list of search terms — fields whose data key contains any term (case-insensitive) are included schema: type: array items: type: string - 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. Indexable fields returned as single and collection field lists content: application/json: schema: $ref: '#/components/schemas/GetIndexedDataFieldsResponseServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: No policy found for the given entity type status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery components: schemas: ConditionalValueDto: allOf: - $ref: '#/components/schemas/StringConditionalValueDto' - type: object properties: valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false CollectionMinimumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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: 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' 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: required: - staticRule type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active additionalProperties: false BasicRuleDtoValidationRuleDto: required: - staticRule type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata DateTimePeriodFormulaSchemaDto: required: - formulaSetId - formulaString type: object properties: formulaSetId: minLength: 1 type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: minLength: 1 type: string dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' additionalProperties: false 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/CollectionMaximumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false RegexRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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: required: - businessRelated - geographic type: object properties: geographic: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of geographic access layers businessRelated: type: array items: maxLength: 500 minLength: 1 type: string description: Collection of business related access layers additionalProperties: false description: DTO representing associated access layers SpecialCharactersRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2' 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/BasicRuleDto' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' 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' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' 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 ReferenceDto: required: - description - type - url type: object properties: type: maxLength: 256 minLength: 1 type: string description: Reference type example: FATCA description: maxLength: 2048 minLength: 1 type: string description: Reference description example: Foreign Account Tax Compliance Act url: maxLength: 2048 minLength: 1 type: string description: Reference URL example: www.irs.gov additionalProperties: false description: Request DTO representing reference metadata ExternalProviderRuleDto2: allOf: - $ref: '#/components/schemas/EmptyRuleDto' - type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata CollectionMaximumCountRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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 UpdatePolicyFieldResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdatePolicyFieldResponseDto' description: Represents the response for creating a new policy field. 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 CreatePolicyFieldResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreatePolicyFieldResponseDto' description: Represents the response for creating a new policy field. 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 CollectionMaximumCountRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: 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 StringConditionalValueDto: 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 additionalProperties: false ConditionDto: required: - logicalOperation - name - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string 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: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array 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 example: id: 118313c6-91e6-4b05-a537-5a1ab906418f name: Company-type only description: Applicable only when EntityType=Company logicalOperation: AND operands: - fieldName: EntityType value: - string valueType: text operation: equal operands: [] RegexRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false DateLimitRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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/RegexRuleDto2' 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 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: required: - errorMessage type: object properties: errorMessage: minLength: 1 type: string 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/DateLimitRuleDto2' 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/BasicRuleDto2' 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: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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 ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} 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 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/ExternalProviderRuleDto2' description: Static validation rule always applied when active additionalProperties: false DateLimitRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false 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 PolicyFieldRequestDto: required: - categories - dataKey - fieldType - name - references - tags - targetEntities type: object properties: name: maxLength: 700 minLength: 1 type: string description: Name of the field example: First Name description: maxLength: 1200 type: - string - 'null' description: Description of the field example: Client's first name dataKey: maxLength: 700 minLength: 1 type: string description: Data key for the field example: firstName fieldType: minLength: 1 type: string description: Type of the field example: text fieldTypeId: type: - string - 'null' description: ID of the field type format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldDataKey: type: - string - 'null' description: Key of the child field linked to this field example: childField linkedParentFieldDataKey: type: - string - 'null' description: Key of the parent field linked to this field example: parentField externalSearchApiProviderId: type: - string - 'null' description: External search API Provider ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto' description: Number formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto' description: Date formula schema order: type: - number - 'null' description: Order in which the field appears format: double example: 1 defaultValue: maxLength: 500 type: - string - 'null' description: Default value for the field example: John classification: type: - string - 'null' description: Classification of the field example: FATCA categories: minItems: 1 type: array items: maxLength: 250 minLength: 1 type: string description: Categories the field belongs to example: - Basic Details - Personal Information targetEntities: type: array items: type: string description: Target entities for the field example: - Client isReadOnly: type: boolean description: Whether the field is read-only example: false isJourneyLevelData: type: boolean description: Whether the field is journey level data example: false isIndexable: type: boolean description: Whether the field is indexable example: true isSensitiveData: type: boolean description: Whether the field contains sensitive data example: false isMaterialData: type: boolean description: Whether the field is material data example: false uiDecoration: type: - string - 'null' description: 'UI decoration for the field. Only applicable for (link)select/multi-select and statusV2fields For select/multi-select fields, it defines how the options are presented to the user. Valid values are: - RadioButtons - Checkboxes For statusV2 fields, it defines where the status chip is displayed. Valid values are: - EntityProfile - JourneyHub For multiple values ''|'' is being used as delimiter, e.g. ''EntityProfile|JourneyHub''' example: Checkboxes uiDecorationColor: type: - string - 'null' description: UI decoration color for the field. Only applicable for statusV2 field example: '#FF0000' accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Access layers for the field references: type: array items: $ref: '#/components/schemas/ReferenceDto' description: References for the field conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions for the field conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' description: Conditional values for the field legacyValidationRules: allOf: - $ref: '#/components/schemas/ValidationRuleDto' description: Legacy Validation Rule - required for compatibility deprecated: true validationRules: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata tags: type: array items: type: string description: Tags for the field example: - Required - Personal clearValueIfTriggerConditionNotMet: type: boolean description: Whether to clear the field value when all trigger conditions are not met example: false jurisdictionIds: type: - array - 'null' items: type: string format: uuid description: 'A collection of unique identifiers that represent jurisdictions associated with the policy field.' dataProtectionJurisdictionId: type: - string - 'null' description: Identifier for the jurisdiction in which the data protection regulations apply format: uuid additionalProperties: false description: Create policy field request 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: required: - formulaSetId - formulaString type: object properties: formulaSetId: minLength: 1 type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: minLength: 1 type: string 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 UpdatePolicyFieldResponseDto: required: - fieldId - fieldVersion type: object properties: fieldId: type: string description: Gets the unique identifier for a policy field. format: uuid example: 102c63eb-6be0-481f-98f0-eea7fa29cc01 fieldVersion: type: integer description: Version number of the field format: int32 example: 2 additionalProperties: false description: Represents the response for creating a new policy field. CreatePolicyFieldResponseDto: required: - fieldId type: object properties: fieldId: type: string description: Gets the unique identifier for a policy field. format: uuid example: 102c63eb-6be0-481f-98f0-eea7fa29cc01 additionalProperties: false description: Represents the response for creating a new policy field. RegexRuleDto: allOf: - $ref: '#/components/schemas/BasicRuleDto' - type: object properties: 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/DateLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false CollectionMinimumCountRuleDto2: allOf: - $ref: '#/components/schemas/BasicRuleDto2' - type: object properties: 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 PolicyFieldRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PolicyFieldRequestDto' description: Create policy field request additionalProperties: false description: Service request data 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/BasicRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false 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 IndexedCollectionFieldDto: required: - columns - dataKey - name type: object properties: dataKey: type: - string - 'null' name: type: - string - 'null' columns: type: - array - 'null' items: $ref: '#/components/schemas/IndexedFieldDto' additionalProperties: false CollectionMinimumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto_2' description: Static validation rule always applied when active additionalProperties: false 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/ValueLimitRuleDto_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 EntityAssociationDataSource: required: - associationToClient - associationType type: object properties: dataSource: type: - string - 'null' readOnly: true associationType: minLength: 1 type: string ownershipPercentage: type: - number - 'null' format: double associationToClient: minLength: 1 type: string properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false ExternalProviderRuleDto_2: type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata JurisdictionNameViewModelDto: type: object properties: jurisdictionId: type: string description: Unique identifier of jurisdiction format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b name: type: - string - 'null' description: Name of Jurisdiction example: Global additionalProperties: false description: Jurisdiction DTO SpecialCharactersRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_2' description: Static validation rule always applied when active additionalProperties: false ValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2_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/BasicRuleDto2_2' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto2_2' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2_2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2_2' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2_2' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_2' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_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 EntityDataMetadataDataSource: required: - entityType type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: minLength: 1 type: string additionalProperties: false ManualCreditScreeningDto: required: - properties 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 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: required: - properties 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: required: - approvalOutcome 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 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 BasicRuleDto_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 EvaluatedCollectionDataGroupDto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: firstName dataGroupId: type: string description: The UiD of the data group format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f dataGroupVersionNumber: type: integer description: The version number of the data group format: int32 example: 1 dataGroupName: type: - string - 'null' description: Data group name example: Addresses name: type: - string - 'null' description: Name of the field example: Mailing addresses description: type: - string - 'null' description: Description of the field example: Client's first name isReadOnly: type: boolean description: Whether the field is read-only example: false category: type: - string - 'null' description: Categories the field belongs to example: Basic Details validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Request DTO representing validation data metadata order: type: - number - 'null' description: Order in which the field appears format: double example: 1 primaryDataGroupField: type: - string - 'null' description: Property name of primary data group field example: addressType disableMultiselectPrimaryFieldOnAdd: type: boolean description: When this field toggle is enabled, users will not be able to add multiple entries to a Data Group at once columns: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupColumnDto' description: All data group columns evaluatedItems: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/EvaluatedDataGroupItemV2Dto' description: Evaluated data group items example: itemId: {} isConditional: type: boolean description: Whether the field is conditional example: false additionalProperties: false ConditionDto_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 additionalProperties: false description: Represents condition root RegexRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto_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 ChangedFieldsDataSource: required: - changedFields type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: array items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false LockDetailsDto: type: object properties: lockedByWorkspaceId: type: string format: uuid lockedByWorkspaceName: type: - string - 'null' lockChangeType: enum: - Updated - Deleted type: - string - 'null' additionalProperties: false EvaluatedDataGroupFieldV2Dto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: firstName fieldType: type: - string - 'null' description: Type of the field example: text fieldTypeId: type: - string - 'null' description: ID of the field type format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldDataKey: type: - string - 'null' description: Key of the child field linked to this field example: childField linkedParentFieldDataKey: type: - string - 'null' description: Key of the parent field linked to this field example: parentField externalSearchApiProviderId: type: - string - 'null' description: External search API Provider ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c name: type: - string - 'null' description: Name of the field example: First Name description: type: - string - 'null' description: Description of the field example: Client's first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default value for the field example: John isReadOnly: type: boolean description: Whether the field is read-only example: false validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Request DTO representing validation data metadata isRequired: type: boolean description: Is the field value mandatory? order: type: - number - 'null' description: Order in which the field appears format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Field Access Layers uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiDecorationColor: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calculation value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false additionalProperties: false RelatedAssetDto: required: - properties type: object properties: properties: type: object 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 SearchEntityPolicyFieldsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchEntityPolicyFieldsRequestDto' description: Represents a request DTO for searching fields additionalProperties: false description: Service request data ValueLimitRuleDto2_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 DateLimitRuleDto_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 IndexedFieldDto: required: - dataKey - fieldType - name type: object properties: dataKey: type: - string - 'null' name: type: - string - 'null' fieldType: type: - string - 'null' additionalProperties: false PolicyFieldSearchViewModelDtoItemsPageWithTotalServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PolicyFieldSearchViewModelDtoItemsPageWithTotal' 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 PolicyFieldSearchViewModelDtoItemsPageWithTotal: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/PolicyFieldSearchViewModelDto' description: The items result set paginationToken: type: - string - 'null' description: The token for retrieving the next page of results totalCount: type: integer format: int64 additionalProperties: false RegexRuleDto_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 PolicyFieldSearchViewModelDto: type: object properties: entityPolicyId: type: string description: Unique identifier of policy format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b versionNumber: type: integer description: Version number of the policy format: int32 example: 1 fieldId: type: string description: Unique identifier of field format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b fieldType: type: - string - 'null' description: Type of the field example: text fieldVersion: type: integer description: Version number of the field format: int32 example: 2 changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' description: Change type of the field example: Unchanged lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' description: Details of the lock. Null if the ChangeType is not Locked. mandatoryType: enum: - Optional - Required - Conditional type: - string - 'null' description: Mandatory type of the field example: Required name: type: - string - 'null' description: Name of the field example: First Name dataKey: type: - string - 'null' description: Data key for the field example: firstName order: type: - number - 'null' description: Order in which the field appears format: double example: 1 categories: type: - array - 'null' items: type: string description: Categories the field belongs to. Sorted alphabetically. example: - Basic Details - Personal Information targetEntities: type: - array - 'null' items: type: string description: Target entities for the field. Sorted alphabetically. example: - Client jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionNameViewModelDto' description: Jurisdictions the field applies to. Sorted alphabetically by jurisdiction name. tags: type: - array - 'null' items: type: string description: Tags for the field. Sorted alphabetically. example: - Required - Personal additionalProperties: false description: 'Represents an object for searching policy field entities, containing field metadata, categorization, and associated policy information.' BasicRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_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 DateTimePeriodFormulaSchemaDto_2: 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 CalculatedResultDto: type: object properties: result: type: - string - 'null' description: Calculation result example: '42.5' error: type: - string - 'null' description: Calculation error example: Division by zero additionalProperties: false CurrentFieldDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true currentField: type: - string - 'null' additionalProperties: false AutoCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/AutoCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' additionalProperties: false SignificanceEngineDataSource: required: - significanceEngine type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false RegexRuleDto2_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 AccessLayerDto_2: type: object properties: geographic: type: - array - 'null' items: type: string businessRelated: type: - array - 'null' items: type: string 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: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDataSource: required: - autoCreditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: array items: $ref: '#/components/schemas/AutoCreditAssessmentDto' additionalProperties: false ReferenceDto_2: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false 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 DateLimitRuleDto2_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 BasicRuleDto2_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 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 ListFieldsSummaryRequestDto: type: object properties: filters: allOf: - $ref: '#/components/schemas/ListFieldsSummaryFilters' additionalProperties: false MainEntityDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' 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/BasicRuleDto_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 ExternalProviderRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto_2' description: Static validation rule always applied when active additionalProperties: false RelatedFCRDto: required: - status type: object properties: status: type: string 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 ValueLimitRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_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 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: required: - documents type: object properties: dataSource: type: - string - 'null' readOnly: true documents: type: array items: $ref: '#/components/schemas/RelatedDocumentDto' additionalProperties: false CollectionMinimumCountRuleDto2_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 ExternalDataAdapterDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false RelatedAssetsDataSource: required: - assets type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: array items: $ref: '#/components/schemas/RelatedAssetDto' additionalProperties: false InvestmentAccountDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties of a single in-scope investment account additionalProperties: false CurrentDataGroupItemDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: type: - string - 'null' additionalProperties: false ScreeningMaterialityDataSource: required: - assessments type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: array 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: required: - properties 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 SpecialCharactersRuleDto_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 BasicRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Static validation rule always applied when active additionalProperties: false SearchEntityPolicyFieldsFiltersDto: type: object properties: filterText: type: - string - 'null' description: 'Name of the resource or entity to be filtered. It searches in the name, Data Key, Field Type, Jurisdictions and Categories. Requires at least 2 characters. Leave as null to ignore this filter.' example: First Name changeTypes: type: - array - 'null' items: type: string description: Change type of the resource. Leave as null to ignore this filter. example: - Unchanged mandatoryTypes: type: - array - 'null' items: type: string description: Mandatory type of the field. Leave as null to ignore this filter. example: - Required fieldTypes: type: - array - 'null' items: type: string description: Specifies the list of field types used in the search policy fields filters. Leave as null to ignore this filter. example: - multiselect - select jurisdictions: type: - array - 'null' items: type: string description: List of jurisdictions to be filtered. Leave as null to ignore this filter. example: - Global targetEntities: type: - array - 'null' items: type: string description: List of target entities to be filtered. Leave as null to ignore this filter. example: - Client categories: type: - array - 'null' items: type: string description: Categories the field belongs to. Leave as null to ignore this filter. example: - Basic Details - Personal Information tags: type: - array - 'null' items: type: string description: Field tags. Leave as null to ignore this filter. example: - PII additionalProperties: false description: Represents a data transfer object used for filtering fields in a policy. 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 EvaluateFieldsResponseDto: type: object properties: evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedFieldDto' description: Evaluated single data fields evaluatedCollectionDataGroups: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedCollectionDataGroupDto' description: Evaluated data group fields evaluatedCustomDataGroups: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedCustomDataGroupDto' description: Evaluated legacy custom data group fields evaluatedJurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionNameViewModelDto' description: Evaluated jurisdictions additionalProperties: false AlertDataSource: required: - attribute - source - type type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: string type: type: string attribute: type: string additionalProperties: false RelatedInvestmentManagerDataSource: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false CollectionMaximumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto_2' description: Static validation rule always applied when active additionalProperties: false RelatedProductDto: required: - properties type: object properties: properties: type: object 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 EvaluatedFieldDto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: firstName fieldType: type: - string - 'null' description: Type of the field example: text fieldTypeId: type: - string - 'null' description: ID of the field type format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldDataKey: type: - string - 'null' description: Key of the child field linked to this field example: childField linkedParentFieldDataKey: type: - string - 'null' description: Key of the parent field linked to this field example: parentField externalSearchApiProviderId: type: - string - 'null' description: External search API Provider ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c name: type: - string - 'null' description: Name of the field example: First Name description: type: - string - 'null' description: Description of the field example: Client's first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default value for the field example: John isReadOnly: type: boolean description: Whether the field is read-only example: false validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Request DTO representing validation data metadata isRequired: type: boolean description: Is the field value mandatory? order: type: - number - 'null' description: Order in which the field appears format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Field Access Layers uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiDecorationColor: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calculation value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false category: type: - string - 'null' description: Requirement business category example: Basic Details isIndexable: type: boolean description: Requirement is indexed for search example: true isMaterialData: type: boolean description: Requirement material data flag example: true additionalProperties: false AutoCreditScreeningDto: required: - properties 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 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: required: - relatedAssociations type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: array items: $ref: '#/components/schemas/RelatedAssociationDto' additionalProperties: false ListFieldsSummaryResponseDto: type: object properties: fieldsByDataKey: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/FieldSummaryDto' description: Fields summary grouped by dataKey additionalProperties: false description: Response DTO representing fields summary grouped by DataKey RelatedClientDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object 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 CollectionMaximumCountRuleDto_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 InvestmentAccountDataSource: required: - investmentAccount type: object properties: dataSource: type: - string - 'null' readOnly: true investmentAccount: type: array items: $ref: '#/components/schemas/InvestmentAccountDto' additionalProperties: false EvaluateFieldsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateFieldsResponseDto' 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 CurrentUserDataSource: required: - teamIds type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: array items: minLength: 1 type: string format: uuid isSystemUser: type: boolean additionalProperties: false CollateralDto: required: - properties type: object properties: properties: type: object 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 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/RegexRuleDto_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 EvaluatedDataGroupItemV2Dto: type: object properties: evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupFieldV2Dto' description: Evaluated data group fields additionalProperties: false ListFieldsSummaryResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ListFieldsSummaryResponseDto' description: Response DTO representing fields summary grouped by DataKey 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 RelatedDealsDataSource: required: - relatedDeals type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: array items: $ref: '#/components/schemas/RelatedDealDto' additionalProperties: false PolicyFieldViewModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PolicyFieldViewModelDto' 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 CurrentProductMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true isAgency: type: - string - 'null' lifecycleStatus: type: - string - 'null' additionalProperties: false GetIndexedDataFieldsResponse: required: - collectionFields - singleFields type: object properties: singleFields: type: - array - 'null' items: $ref: '#/components/schemas/IndexedFieldDto' collectionFields: type: - array - 'null' items: $ref: '#/components/schemas/IndexedCollectionFieldDto' additionalProperties: false ListFieldsSummaryRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ListFieldsSummaryRequestDto' description: The service request DTO additionalProperties: false description: Service request data SinglePropertyDto2: type: object properties: value: type: - string - 'null' valueId: type: - string - 'null' additionalProperties: false ScreeningMaterialityAssessmentDto: required: - adverseMediaJurisdictions - enforcementsJurisdictions - otherJurisdictions - pepJurisdictions - sanctionsJurisdictions 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 items: type: string description: PEP jurisdictions associated with this assessment. sanctionsJurisdictions: type: array items: type: string description: Sanctions jurisdictions associated with this assessment. adverseMediaJurisdictions: type: array items: type: string description: Adverse media jurisdictions associated with this assessment. enforcementsJurisdictions: type: array items: type: string description: Enforcements jurisdictions associated with this assessment. otherJurisdictions: type: array 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 EventIngressDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false FieldSummaryDto: type: object properties: name: type: - string - 'null' description: Field name example: First Name names: type: - array - 'null' items: type: string description: Requirement names in case of different duplicates example: - First Name - Name description: type: - string - 'null' description: Requirement description example: This is the client first name fieldType: type: - string - 'null' description: Field type example: text fieldTypeId: type: - string - 'null' description: Field type ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c categories: type: - array - 'null' items: type: string description: All business categories for the field example: - Basic Details jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionNameViewModelDto' description: All jurisdictions for the field isSensitiveData: type: boolean description: Field sensitive data flag example: true linkChildFieldDataKey: type: - string - 'null' description: Linked child field data key example: productCategory linkedParentFieldDataKey: type: - string - 'null' description: Linked Parent field data key example: productCategory externalSearchApiProviderId: type: - string - 'null' description: External Search API Provider ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c additionalProperties: false NumberFormulaSchemaDto_2: 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 ChangedFieldDto: type: object properties: key: type: - string - 'null' additionalProperties: false RelatedPartiesDataSource: required: - relatedParties type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: array items: $ref: '#/components/schemas/RelatedPartyDto' additionalProperties: false DateLimitRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto_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 EvaluatedDataGroupColumnDto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: firstName fieldType: type: - string - 'null' description: Type of the field example: text fieldTypeId: type: - string - 'null' description: ID of the field type format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c name: type: - string - 'null' description: Name of the field example: Product Type description: type: - string - 'null' description: Description of the field example: Client's first name order: type: - number - 'null' description: Order in which the field appears format: double example: 2 isConditional: type: boolean description: Is data group field conditional? example: false additionalProperties: false GetIndexedDataFieldsResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/GetIndexedDataFieldsResponse' 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 InvestmentAccountRelatedFundShareClassDataSource: required: - properties 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: required: - assessments - lastAssessment type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: minItems: 1 type: array items: $ref: '#/components/schemas/AlertAssessmentDto' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto' lastAssessmentOutcome: type: - string - 'null' lastAssessmentDisposition: type: - string - 'null' additionalProperties: false ExternalProviderRuleDto2_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 ConditionalValueDto_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: 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 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 SpecialCharactersRuleDto2_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 ValueLimitRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' description: Static validation rule always applied when active additionalProperties: false CurrentJourneysDataSource: required: - inProgressJourneyTypes type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: array 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 FieldValidationErrorDto: type: object properties: validator: type: - string - 'null' description: Type of the validator that returned error message example: mandatory message: type: - string - 'null' description: Error message configured by the user in the Policy example: This field is required additionalProperties: false CollectionMaximumCountRuleDto2_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 SearchEntityPolicyFieldsRequestDto: type: object properties: sortBy: enum: - Name - DataKey - FieldType - ChangeType - MandatoryType - TargetEntities - Categories - Jurisdictions - Tags - Order type: - string - 'null' description: The column by which the results should be sorted. example: Name sortDirection: enum: - Ascending - Descending type: - string - 'null' description: The direction in which the results should be sorted (e.g., Ascending or Descending). example: Ascending pageSize: maximum: 100 type: integer description: The maximum number of records to be returned in a single page of the query result. format: int32 example: 100 exclusiveMinimum: 0 paginationToken: type: - string - 'null' description: 'A token used to represent the current position in a paginated result set. It is used primarily to fetch the next set of results in a query or search operation.' filters: allOf: - $ref: '#/components/schemas/SearchEntityPolicyFieldsFiltersDto' description: Filters applied to narrow down the search results for policy fields. additionalProperties: false description: Represents a request DTO for searching fields RelatedUnderlyingPrincipalOwnerDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false BaseEvaluatedFieldDto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: firstName fieldType: type: - string - 'null' description: Type of the field example: text fieldTypeId: type: - string - 'null' description: ID of the field type format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldDataKey: type: - string - 'null' description: Key of the child field linked to this field example: childField linkedParentFieldDataKey: type: - string - 'null' description: Key of the parent field linked to this field example: parentField externalSearchApiProviderId: type: - string - 'null' description: External search API Provider ID format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c name: type: - string - 'null' description: Name of the field example: First Name description: type: - string - 'null' description: Description of the field example: Client's first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default value for the field example: John isReadOnly: type: boolean description: Whether the field is read-only example: false validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto_2' description: Request DTO representing validation data metadata isRequired: type: boolean description: Is the field value mandatory? order: type: - number - 'null' description: Order in which the field appears format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' description: Field Access Layers uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiDecorationColor: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calculation value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false additionalProperties: false ManualCreditAssessmentV2DataSource: required: - creditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: array items: $ref: '#/components/schemas/CreditAssessmentDto' additionalProperties: false EvaluatedCustomDataGroupDto: type: object properties: dataKey: type: - string - 'null' description: Data key for the field example: product dataGroupId: type: string description: The UiD of the data group format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f dataGroupVersionNumber: type: integer description: The version number of the data group format: int32 example: 1 dataGroupName: type: - string - 'null' description: Data group name example: Products name: type: - string - 'null' description: Name of the field example: Product description: type: - string - 'null' description: Description of the field example: This is the product object order: type: - number - 'null' description: Order in which the field appears format: double example: 1 isConditional: type: boolean description: Is requirement conditional example: false category: type: - string - 'null' description: Categories the field belongs to example: Basic Details singleFields: type: - array - 'null' items: $ref: '#/components/schemas/BaseEvaluatedFieldDto' description: Single custom data group fields customNestedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedCustomDataGroupDto' description: Nested custom data group fields additionalProperties: false RelatedFCRsDataSource: required: - fcRs type: object properties: dataSource: type: - string - 'null' readOnly: true fcRs: type: array items: $ref: '#/components/schemas/RelatedFCRDto' additionalProperties: false ValueLimitRuleDto_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 AlertAssessmentDto: required: - category type: object properties: category: type: string additionalProperties: false AccountRelatedFundDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false ReviewAndApprovalDataSource: required: - reviewAndApprovals type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: array items: $ref: '#/components/schemas/ReviewAndApprovalDto' additionalProperties: false CreditAssessmentDto: required: - properties - taskId type: object properties: properties: type: object 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 description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false RelatedDocumentDto: required: - document type: object properties: document: allOf: - $ref: '#/components/schemas/RelatedDocumentVersionedDto' additionalProperties: false CollateralDataSource: required: - collaterals type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: array items: $ref: '#/components/schemas/CollateralDto' additionalProperties: false RelatedDealDto: required: - properties type: object properties: properties: type: object 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 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/DateLimitRuleDto_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 RelatedAssociationDto: required: - properties 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: required: - properties type: object properties: properties: type: object 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: required: - products type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: array items: $ref: '#/components/schemas/RelatedProductDto' additionalProperties: false ListFieldsSummaryFilters: required: - categories type: object properties: journeyLevelDataOnly: type: boolean categories: uniqueItems: true type: - array - 'null' items: maxLength: 250 minLength: 1 type: string targetEntities: uniqueItems: true type: - array - 'null' items: type: string additionalProperties: false AccountRelatedFundsDataSource: required: - accountRelatedFunds type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: array items: $ref: '#/components/schemas/AccountRelatedFundDto' additionalProperties: false CurrentProductDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object 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 CollectionMinimumCountRuleDto_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 ManualCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/ManualCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' additionalProperties: false PolicyFieldViewModelDto: type: object properties: entityPolicyId: type: string format: uuid versionNumber: type: integer format: int32 fieldId: type: string format: uuid fieldVersion: type: integer format: int32 changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' name: type: - string - 'null' description: type: - string - 'null' dataKey: type: - string - 'null' fieldType: type: - string - 'null' fieldTypeId: type: - string - 'null' format: uuid linkChildFieldDataKey: type: - string - 'null' linkedParentFieldDataKey: type: - string - 'null' externalSearchApiProviderId: type: - string - 'null' format: uuid formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto_2' dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto_2' order: type: - number - 'null' format: double defaultValue: type: - string - 'null' classification: type: - string - 'null' categories: type: - array - 'null' items: type: string targetEntities: type: - array - 'null' items: type: string isReadOnly: type: boolean isJourneyLevelData: type: boolean isIndexable: type: boolean isSensitiveData: type: boolean isMaterialData: type: boolean uiDecoration: type: - string - 'null' uiDecorationColor: type: - string - 'null' accessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto_2' references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto_2' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_2' validationRules: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata tags: type: - array - 'null' items: type: string clearValueIfTriggerConditionNotMet: type: boolean jurisdictionIds: type: - array - 'null' items: type: string format: uuid dataProtectionJurisdictionId: type: - string - 'null' format: uuid additionalProperties: false EvaluateFieldsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateFieldsRequestDto' description: The service request DTO additionalProperties: false description: Service request data EvaluateFieldsRequestDto: type: object properties: journeyId: type: - string - 'null' description: Unique identifier for the journey format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b targetEntity: enum: - Client - Related Party type: - string - 'null' description: Target entities for the field example: Client evaluateJurisdictions: type: boolean description: Whether to evaluate jurisdictions automatically example: false jurisdictions: type: - array - 'null' items: type: string format: uuid description: 'A collection of unique identifiers that represent jurisdictions associated with the policy field' example: - 0e5a0bae-bd18-474f-8da7-0afcb3eb987b categories: type: - array - 'null' items: type: string description: Categories the field belongs to example: - Basic Details - Personal Information dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Data sources for field evaluation properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties for field evaluation disableFilteringForConditionalValues: type: boolean description: Whether to disable filtering for conditional values example: false enableAccessLayersFiltering: type: boolean description: Whether to enable access layers filtering example: true returnValidationErrors: type: boolean description: Whether to return validation errors example: true journeyLevelDataOnly: type: boolean description: Whether to return only journey level data example: false skipValuesEvaluation: type: boolean description: 'Skip evaluation of default value, conditional value and calculated fields if value is true. Use ''true'' for readonly/completed tasks. The default value will be false.' example: false additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-policycommand-v2-0-openapi.json - fenergo-policyquery-v4-0-openapi.json