{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Product Policy Query", "description": "Product Policy Query API is part of FenX eco-system to query for Product Requirement Sets, Requirements, Data Groups and Data Group Fields Instances. All the operations require valid access token obtained from Identity service.", "version": "1.0" }, "servers": [ { "url": "/productpolicyquery" } ], "paths": { "/api/product-requirement-set": { "get": { "tags": [ "ProductRequirementSet" ], "summary": "Get requirement sets", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetAllProductRequirementSets", "parameters": [ { "name": "includeRequirements", "in": "query", "description": "Flag to include product requirements in the response.", "schema": { "type": "boolean", "default": false } }, { "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. List of product requirement sets data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementSetDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/{setId}": { "get": { "tags": [ "ProductRequirementSet" ], "summary": "Get product requirement set by id", "description": "\nReturns the active, currently in effect, published product requirement set version for a given id.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetProductRequirementSetById", "parameters": [ { "name": "setId", "in": "path", "description": "Product requirement set id", "required": true, "schema": { "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. Product requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Product Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/{setId}/version/{versionNumber}": { "get": { "tags": [ "ProductRequirementSet" ], "summary": "Get product requirement set by id and version", "description": "\nReturns product requirement set for a given id and version number.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetProductRequirementSetVersionById", "parameters": [ { "name": "setId", "in": "path", "description": "Product requirement set id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Product requirement set version number", "required": true, "schema": { "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. Product requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Product requirement set with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/{setId}/version/{versionNumber}/field/{id}": { "get": { "tags": [ "ProductRequirementSet" ], "summary": "Get requirement by id", "description": "\nReturns requirement by given product requirement set id, requirement set version number and requirement id.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetProductRequirementById", "parameters": [ { "name": "setId", "in": "path", "description": "Product requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Product requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "Product requirement id", "required": true, "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. Product requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Product requirement set/requirement with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/jurisdictions": { "get": { "tags": [ "ProductRequirementSet" ], "summary": "Get jurisdictions", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetJurisdictions", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of available jurisdictions is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetJurisdictionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/merged-data-fields": { "post": { "tags": [ "GetMergedProductRequirementSetsDataFields" ], "summary": "Gets summary of data fields from all jurisdictions merged by property name", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetMergedProductRequirementSetsDataFields", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Parameters used for filtering retrived requirements", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMergedProductRequirementSetsDataFieldsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Data fields summary grouped by property name is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMergedProductRequirementSetsDataFieldsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-set/fields/grouped-lookup-options": { "post": { "tags": [ "GetFieldsGroupedLookupOptions" ], "summary": "Gets grouped lookup options for fields based on specified criteria", "description": "

Required permissions:
Following permissions are required: ProductConfigurationSearch", "operationId": "GetFieldsGroupedLookupOptions", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request containing filter parameters for field lookup options", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FieldsGroupedLookupOptionsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Grouped lookup options for fields are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldsGroupedLookupOptionsDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirements-in-scope/evaluate": { "post": { "tags": [ "ProductRequirementsInScope" ], "summary": "Evaluate Product Requirements in scope", "description": "\nReturns nonconditional and evaluated conditional Product Requirements that are in scope for a given search criteria and entity parameters.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateProductRequirementsInScope", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Evaluate Product Requirements in scope request with a set of criteria to search Product Requirements and evaluate conditions", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsInScopeRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of Product Requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirements-in-scope/evaluate-all-requirements": { "post": { "tags": [ "ProductRequirementsInScope" ], "summary": "Evaluate All Product Requirements in scope", "description": "\nReturns all Product Requirements that are in scope for a given search criteria and entity parameters.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "EvaluateAllProductRequirements", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Evaluate Product Requirements in scope request with a set of criteria to search Product Requirements and evaluate conditions", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateAllProductRequirementsInScopeRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of Product Requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluatedAllProductRequirementsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirements-in-scope/search": { "post": { "tags": [ "ProductRequirementsInScope" ], "summary": "Search Product Requirements", "description": "\nReturns Product Requirements that are in scope for a given search criteria.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "SearchProductRequirements", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Product Requirements in scope request with a set of criteria to search", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchProductRequirementsDtoServiceRequest" } ] } } } }, "responses": { "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "200": { "description": "Success. List of Product Requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirements-in-scope": { "post": { "tags": [ "ProductRequirementsInScope" ], "summary": "Get product requirements in scope", "description": "\nReturns deduplicated Product Requirements that are in scope for a given search criteria.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetProductRequirementsInScope", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Product Requirements in scope request with a set of criteria to search", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ProductRequirementsInScopeRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of Product Requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirements-in-scope/evaluation-definitions": { "post": { "tags": [ "ProductRequirementsInScope" ], "summary": "Get evaluation definitions", "description": "\nReturns the versioned requirement sets matching the supplied pinned version IDs, plus the\n active version of any set that has activation conditions. Requirements are optionally\n filtered by type.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetEvaluationDefinitions", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Pinned jurisdictions and optional requirement type filter", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetEvaluationDefinitionsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. List of evaluation definition sets is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationDefinitionSetDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-tag/requirements": { "get": { "tags": [ "ProductRequirementTag" ], "summary": "Get product requirements by tags list", "description": "\nReturns the list of product requirements that carry any of the supplied tags for the current tenant, across all requirement sets.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetProductRequirementsByTags", "parameters": [ { "name": "tags", "in": "query", "description": "List of tags to search by", "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. List of product requirements matching the tags is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequirementDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-tag": { "get": { "tags": [ "ProductRequirementTag" ], "summary": "Get all published tags for the current tenant", "description": "\nReturns the distinct list of all published tags for the current tenant across all requirement sets.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetTagsByTenant", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of tags is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/product-requirement-tag/requirement-set/{setId}": { "get": { "tags": [ "ProductRequirementTag" ], "summary": "Get tags for a specific requirement set", "description": "\nReturns the list of tags published against the given requirement set for the current tenant.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetTagsByRequirementSetId", "parameters": [ { "name": "setId", "in": "path", "description": "Requirement set id", "required": true, "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. List of tags is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get scopingRule sets", "description": "

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetAllScopingRuleSets", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of scoping rule sets data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set/{setId}": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get scoping rule set by id", "description": "\nReturns the active, currently in effect, published scoping rule set version for a given id.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetScopingRuleSetById", "parameters": [ { "name": "setId", "in": "path", "description": "Scoping rule set id", "required": true, "schema": { "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. scoping rule set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Product Requirement set with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set/{setId}/version/{versionNumber}": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get scoping rule set by id and version", "description": "\nReturns scoping rule set for a given id and version number.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetScopingRuleSetVersionById", "parameters": [ { "name": "setId", "in": "path", "description": "scoping rule set id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "scoping rule set version number", "required": true, "schema": { "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. scoping rule set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. scoping rule set with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set/activeVersions": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get active scoping rule sets", "description": "\nReturns active scoping rule sets.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetActiveScopingRuleSetVersions", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. scoping rule set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set/activeVersions/{type}": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get active scoping rule sets by type", "description": "\nReturns active scoping rule sets by type.

Required permissions:
At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess", "operationId": "GetActiveScopingRuleSetVersionsByType", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleType" } ] } }, { "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. scoping rule set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccessLayer": { "type": "object", "properties": { "businessRelated": { "type": "array", "items": { "type": "string" }, "nullable": true }, "geographic": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "description": "Collection of geographic access layers e.g. [\"Global\"]", "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "description": "Collection of business related access layers e.g. [\"Global\"]", "nullable": true } }, "additionalProperties": false, "description": "DTO representing associated access layers" }, "AccountRelatedFundDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" }, "nullable": true } }, "additionalProperties": false }, "ActiveScopingRuleSetVersionResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the scoping ruleset version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the scoping rule set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The Name of the Scoping Rule Set", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setStatus": { "type": "string", "description": "Product requirement set status", "nullable": true, "example": "Active" }, "uniqueIdentifier": { "type": "string", "description": "Product requirement set jurisdiction", "nullable": true, "example": "Global" }, "separateJourneyPerProduct": { "type": "boolean", "description": "Product requirement set separateJourneyPerProduct", "example": false }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "type": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleType" } ], "description": "Type of the scoping rule", "example": "ProductJourney" } }, "additionalProperties": false, "description": "Response DTO representing light scoping rule set version data" }, "ActiveScopingRuleSetVersionResponseDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveScopingRuleSetVersionResponseDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" }, "nullable": true }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ], "nullable": true }, "lastAssessmentOutcome": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlertDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "source": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "attribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AutoCreditAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleConditionalValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRule2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRuleConditionalValue" }, "nullable": true } }, "additionalProperties": false }, "BasicRuleConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/BasicRule2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BasicRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "BasicRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRule2" } ], "nullable": true } }, "additionalProperties": false }, "CalculatedResultDto": { "type": "object", "properties": { "result": { "type": "string", "description": "Calculation result", "nullable": true }, "error": { "type": "string", "description": "Calculation error", "nullable": true } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRule2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRule2" } ], "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Condition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true } }, "additionalProperties": false }, "ConditionDefinition": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true }, "isCondition": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "assessmentComment": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CurrentProductDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentProductMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "isAgency": { "type": "string", "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentUserDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "teamIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isSystemUser": { "type": "boolean" } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataField": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "propertyTypeVersion": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "linkedParentFieldPropertyName": { "type": "string", "nullable": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchema" } ], "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchema" } ], "nullable": true }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "externalSearchApiProviderId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked Parent field property name", "nullable": true, "example": "productCategory" }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchemaDto" } ], "description": "Formula schema", "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto" } ], "description": "Date formula schema", "nullable": true }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "description": "External search API provider id", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing data field data" }, "DataFieldSummaryDto": { "type": "object", "properties": { "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked Parent field property name", "nullable": true, "example": "productCategory" }, "externalSearchApiProviderId": { "type": "string", "description": "External search api provider id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "mergedNames": { "type": "string", "description": "Merged requirement names in case of different duplicates", "nullable": true, "example": "First Name | Name", "deprecated": true }, "names": { "type": "array", "items": { "type": "string" }, "description": "Requirement names in case of different duplicates", "nullable": true, "example": [ "First Name", "Name" ] }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "All requirement business categories for property", "nullable": true, "example": [ "Basic Details" ] }, "jurisdictions": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "All requirement jurisdictions for property", "nullable": true, "example": [ "Global" ] } }, "additionalProperties": false, "description": "Response DTO representing data field summary" }, "DataGroupColumnDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "name": { "type": "string", "description": "Data group field name", "nullable": true, "example": "Product Type" }, "description": { "type": "string", "description": "Data group field description", "nullable": true, "example": "This is the field description" }, "order": { "type": "number", "description": "Data group field order", "format": "double", "nullable": true, "example": 2 }, "isConditional": { "type": "boolean", "description": "Is data group field conditional", "example": false } }, "additionalProperties": false }, "DataGroupField": { "allOf": [ { "$ref": "#/components/schemas/Requirement" }, { "type": "object", "properties": { "versionId": { "type": "string", "format": "uuid" }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataField" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRule" } ], "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRules" } ], "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isReadOnly": { "type": "boolean" }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValue" }, "nullable": true } }, "additionalProperties": false } ] }, "DataRequirement": { "allOf": [ { "$ref": "#/components/schemas/Requirement" }, { "type": "object", "properties": { "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataField" } ], "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRule" } ], "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRules" } ], "nullable": true }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayer" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isSecondaryIdentifier": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isIndexable": { "type": "boolean" }, "isTotalProductColumn": { "type": "boolean" }, "isJourneyLevelData": { "type": "boolean" }, "clearValueIfTriggerConditionNotMet": { "type": "boolean" }, "isMandatoryIndexable": { "type": "boolean", "readOnly": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValue" }, "nullable": true }, "defaultDateType": { "type": "string", "nullable": true }, "uiDecoration": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "nullable": true }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "nullable": true }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "nullable": true }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "nullable": true } }, "additionalProperties": false }, "DataValidationRules": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleConditionalValidationRule" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleValidationRule" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleConditionalValidationRule" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleValidationRule" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleValidationRule" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleConditionalValidationRule2" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleConditionalValidationRule" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleValidationRule" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleValidationRule" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleValidationRule" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleValidationRule" } ], "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleConditionalValidationRule" } ], "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleConditionalValidationRule" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true }, "validationRulesByType": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IValidationRuleModel" }, "nullable": true, "readOnly": true }, "activeValidationRuleTypes": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleValidationRule" } ], "nullable": true } }, "additionalProperties": false }, "DataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow todays date", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "DateLimitRangeData": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "relativeTo": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "offset": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "offsetPeriod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateLimitRangeDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "relativeTo": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true }, "offset": { "type": "string", "nullable": true }, "periodType": { "type": "string", "nullable": true }, "offsetPeriod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateLimitRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DateLimitRule3": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeData" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleConditionalValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleConditionalValue" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleConditionalValidationRule2": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule3" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleConditionalValue2" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateLimitRuleConditionalValue2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule3" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto3": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto4": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true }, "rangeFrom": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true }, "rangeTo": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRangeDto" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto3" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValidationRuleDto2": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto4" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto2" }, "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto3" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto4" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateTimePeriodFormulaSchema": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "formulaString": { "type": "string", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "dateTimePeriodFormulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DateTimePeriodFormulaVariable" }, "nullable": true } }, "additionalProperties": false }, "DateTimePeriodFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "description": "Formula set id", "format": "uuid", "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "versionNumber": { "type": "integer", "description": "Formula set version number", "format": "int32", "nullable": true, "example": 1 }, "formulaString": { "type": "string", "description": "Formula string will be used to perform calculation", "nullable": true, "example": "$1 + $2" }, "dateTimePeriodFormulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DateTimePeriodFormulaVariableDto" }, "description": "Metadata argument in formula string", "nullable": true } }, "additionalProperties": false }, "DateTimePeriodFormulaVariable": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "timePeriodKind": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DateTimePeriodFormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "timePeriodKind": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "DocumentRequirement": { "allOf": [ { "$ref": "#/components/schemas/Requirement" }, { "type": "object", "properties": { "isMandatory": { "type": "boolean" }, "documentDescription": { "type": "string", "nullable": true }, "documentDataKey": { "type": "string", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayer" } ], "nullable": true } }, "additionalProperties": false } ] }, "ESignatureDocumentRequirement": { "allOf": [ { "$ref": "#/components/schemas/Requirement" }, { "type": "object", "properties": { "isMandatory": { "type": "boolean" }, "documentDescription": { "type": "string", "nullable": true }, "documentDataKey": { "type": "string", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "documentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayer" } ], "nullable": true } }, "additionalProperties": false } ] }, "EmptyRule": { "type": "object", "additionalProperties": false }, "EmptyRuleConditionalValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/EmptyRule" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/EmptyRuleConditionalValue" }, "nullable": true } }, "additionalProperties": false }, "EmptyRuleConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/EmptyRule" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmptyRuleDto": { "type": "object", "additionalProperties": false }, "EmptyRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "EmptyRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EntityAssociationDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluateAllProductRequirementsInScopeRequestDto": { "type": "object", "properties": { "requirementTypes": { "type": "array", "items": { "type": "string" }, "description": "List of requirement types [Data, Document, OwnershipAndControl]", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the requirement in specific version", "nullable": true }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Company" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties used for condition evaluation", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true }, "journeyId": { "type": "string", "format": "uuid", "nullable": true }, "productId": { "type": "string", "format": "uuid", "nullable": true }, "isReadOnly": { "type": "boolean" }, "preserveCategoryDuplicates": { "type": "boolean" }, "cutOffDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EvaluateAllProductRequirementsInScopeRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateAllProductRequirementsInScopeRequestDto" } ] } }, "additionalProperties": false }, "EvaluateProductRequirementsInScopeRequestDto": { "type": "object", "properties": { "requirementTypes": { "type": "array", "items": { "type": "string" }, "description": "List of requirement types [Data, Document, OwnershipAndControl]", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the requirement in specific version", "nullable": true }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Company" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties used for condition evaluation", "nullable": true }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true } }, "additionalProperties": false }, "EvaluateProductRequirementsInScopeRequestDtoServiceRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateProductRequirementsInScopeRequestDto" } ] } }, "additionalProperties": false }, "EvaluatedAllProductRequirementsResponseDto": { "type": "object", "properties": { "evaluatedSingleDataRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedSingleDataRequirementDto" }, "description": "Evaluated single data requirements", "nullable": true }, "evaluatedDataGroupRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupRequirementDto" }, "description": "Evaluated data group requirements", "nullable": true }, "evaluatedCustomRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedCustomRequirementDto" }, "description": "Evaluated legacy custom data group requirements", "nullable": true }, "evaluatedDocumentRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDocumentRequirementDto" }, "description": "Evaluated document requirements", "nullable": true }, "evaluatedOwnershipAndControlRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedOwnershipAndControlRequirementDto" }, "description": "Evaluated ownership and control requirements", "nullable": true } }, "additionalProperties": false }, "EvaluatedAllProductRequirementsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluatedAllProductRequirementsResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EvaluatedCustomRequirementDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name of custom data group requirement", "nullable": true, "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", "description": "Data group name", "nullable": true, "example": "Products" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "Product" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the product object" }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "singleFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataFieldDto" }, "description": "Single custom data group fields", "nullable": true }, "customNestedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedCustomRequirementDto" }, "description": "Nested custom data group fields", "nullable": true } }, "additionalProperties": false }, "EvaluatedDataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked parent field property name", "nullable": true, "example": "productCategory" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "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" } ], "description": "Field Access Layers", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calcualtion value", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation in order to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.", "nullable": true }, "conditionalLimitError": { "type": "string", "description": "Conditional limit error", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "description": "Provider Id for Search Field that will be used to fetch options for the field", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "shouldClearValue": { "type": "boolean", "description": "Indicates the field value should be cleared because its trigger condition is not met", "example": false } }, "additionalProperties": false }, "EvaluatedDataGroupFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked parent field property name", "nullable": true, "example": "productCategory" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "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" } ], "description": "Field Access Layers", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calcualtion value", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation in order to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.", "nullable": true }, "conditionalLimitError": { "type": "string", "description": "Conditional limit error", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "description": "Provider Id for Search Field that will be used to fetch options for the field", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "shouldClearValue": { "type": "boolean", "description": "Indicates the field value should be cleared because its trigger condition is not met", "example": false } }, "additionalProperties": false }, "EvaluatedDataGroupItemDto": { "type": "object", "properties": { "evaluatedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupFieldDto" }, "description": "Evaluated data group fields", "nullable": true } }, "additionalProperties": false }, "EvaluatedDataGroupRequirementDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name of data group requirement", "nullable": true, "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", "description": "Data group name", "nullable": true, "example": "Addresses" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "Mailing addresses" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client mailing addresses" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to data group", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "primaryDataGroupField": { "type": "string", "description": "Property name of primary data group field", "nullable": true, "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", "items": { "$ref": "#/components/schemas/DataGroupColumnDto" }, "description": "All data group columns", "nullable": true }, "evaluatedItems": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EvaluatedDataGroupItemDto" }, "description": "Evaluated data group items", "nullable": true, "example": { "itemId": { } } }, "isConditional": { "type": "boolean", "description": "Is requirement conditional", "example": false }, "externalSearchApiProviderId": { "type": "string", "description": "Provider Id for Search Field that will be used to fetch options for the field", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" } }, "additionalProperties": false }, "EvaluatedDocumentRequirementDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Requirement Id", "format": "uuid" }, "name": { "type": "string", "description": "Document name", "nullable": true, "example": "Driving Licence" }, "dataKey": { "type": "string", "description": "Document datakey", "nullable": true, "example": "drivingLicence" }, "description": { "type": "string", "description": "Document description", "nullable": true, "example": "Driving Licence document" }, "category": { "type": "string", "description": "Document business category", "nullable": true, "example": "Basic Details" }, "isRequired": { "type": "boolean", "description": "Is document mandatory" }, "isConditional": { "type": "boolean", "description": "Is document conditional", "example": false } }, "additionalProperties": false }, "EvaluatedOwnershipAndControlRequirementDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Requirement Id", "format": "uuid" }, "name": { "type": "string", "description": "Ownership and control requirement name", "nullable": true, "example": "Add 1 Controlling Person" }, "dataKey": { "type": "string", "description": "Ownership and control requirement datakey", "nullable": true, "example": "addControllingPerson" }, "description": { "type": "string", "description": "Ownership and control requirement description", "nullable": true, "example": "Add 1 Controlling Person" }, "category": { "type": "string", "description": "Ownership and control requirement business category", "nullable": true, "example": "Related Party Basic Details" }, "isRequired": { "type": "boolean", "description": "Is Ownership and control requirement mandatory" }, "isConditional": { "type": "boolean", "description": "Is Ownership and control requirement conditional", "example": false }, "partyTypes": { "type": "array", "items": { "type": "string" }, "description": "Ownership and control requirement party types", "nullable": true } }, "additionalProperties": false }, "EvaluatedSingleDataRequirementDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked parent field property name", "nullable": true, "example": "productCategory" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "hasEvaluatedDefaultValue": { "type": "boolean", "description": "Does this field has evaluated default value?" }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true }, "isRequired": { "type": "boolean", "description": "Is the field value mandatory" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "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" } ], "description": "Field Access Layers", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calcualtion value", "nullable": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "timeZoneId": { "type": "string", "description": "Time zone id used for date values validation in order to determine exact Today time range", "nullable": true, "example": "Europe/Warsaw" }, "customActionProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Properties which can be passed to a custom action function in the UI, provided as\nbasic string key-value pairs to allow action functions to be created generically.", "nullable": true }, "conditionalLimitError": { "type": "string", "description": "Conditional limit error", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "description": "Provider Id for Search Field that will be used to fetch options for the field", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "shouldClearValue": { "type": "boolean", "description": "Indicates the field value should be cleared because its trigger condition is not met", "example": false }, "jurisdiction": { "type": "string", "description": "Requirement jurisdiction", "nullable": true, "example": "Global" }, "isIndexable": { "type": "boolean", "description": "Requirement is indexed for search", "example": true } }, "additionalProperties": false }, "EvaluationDefinitionSetDto": { "type": "object", "properties": { "versionId": { "type": "string", "format": "uuid" }, "jurisdiction": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/SlimProductRequirementDto" }, "nullable": true } }, "additionalProperties": false }, "EvaluationDefinitionSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluationDefinitionSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EventIngressDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalProviderRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRule2": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDto2": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "ExternalProviderRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRule2" } ], "nullable": true } }, "additionalProperties": false }, "FieldsGroupedLookupOptionsDto": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/GroupedLookupOptionsDto" }, "description": "Collection of grouped lookup options", "nullable": true } }, "additionalProperties": false, "description": "Response DTO containing grouped lookup options for fields" }, "FieldsGroupedLookupOptionsDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FieldsGroupedLookupOptionsDto" } ], "description": "Response DTO containing grouped lookup options for fields", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FieldsGroupedLookupOptionsRequestDto": { "type": "object", "properties": { "draftRequirementSetVersionId": { "type": "string", "description": "Draft Requirement Set Version Id", "format": "uuid", "nullable": true, "example": "e8aa237d-a534-48a1-922e-a933a14460cc" }, "excludeRequirementId": { "type": "string", "description": "Excludes the currently edited requirement ID from the results. This applies only when `DraftRequirementSetVersionId` is defined.", "format": "uuid", "nullable": true }, "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Client" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Individual" }, "journeyLevelDataOnly": { "type": "boolean", "description": "Flag indicating if returned requirements will be Journey Level Data only", "example": false } }, "additionalProperties": false, "description": "Request DTO representing parameters to filter returned data fields" }, "FieldsGroupedLookupOptionsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FieldsGroupedLookupOptionsRequestDto" } ], "description": "Request DTO representing parameters to filter returned data fields", "nullable": true } }, "additionalProperties": false }, "FilterCondition": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "nullable": true } }, "additionalProperties": false }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaSchema": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "formulaString": { "type": "string", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormulaVariable" }, "nullable": true } }, "additionalProperties": false }, "FormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "description": "Formula set id", "format": "uuid", "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "versionNumber": { "type": "integer", "description": "Formula set version number", "format": "int32", "nullable": true, "example": 1 }, "formulaString": { "type": "string", "description": "Formula string will be used to perform calculation", "nullable": true, "example": "$1 + $2" }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormulaVariableDto" }, "description": "Metadata argument in formula string", "nullable": true } }, "additionalProperties": false }, "FormulaVariable": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterCondition" }, "nullable": true } }, "additionalProperties": false }, "FormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "propertyName": { "type": "string", "nullable": true }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConditionDto" }, "nullable": true } }, "additionalProperties": false }, "GetEvaluationDefinitionsRequestDto": { "type": "object", "properties": { "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "nullable": true }, "requirementTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GetEvaluationDefinitionsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetEvaluationDefinitionsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetMergedProductRequirementSetsDataFieldsRequestDto": { "type": "object", "properties": { "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Product" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Product" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Requirement business categories", "nullable": true, "example": [ "Basic Details" ] }, "forceMergeFromRequirementSetVersionId": { "type": "string", "description": "Id of requirement set version (can be draft) forced to merge with other latest published requirement sets", "format": "uuid", "nullable": true, "example": "228313c6-91e6-4b05-a537-5a1ab906418f" } }, "additionalProperties": false, "description": "Request DTO representing parameters to filter returned data fields" }, "GetMergedProductRequirementSetsDataFieldsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMergedProductRequirementSetsDataFieldsRequestDto" } ], "description": "Request DTO representing parameters to filter returned data fields", "nullable": true } }, "additionalProperties": false }, "GetMergedProductRequirementSetsDataFieldsResponseDto": { "type": "object", "properties": { "dataFieldsByPropertyName": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataFieldSummaryDto" }, "description": "Data fields summary grouped by property name", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing data fields summary grouped by property name" }, "GetMergedProductRequirementSetsDataFieldsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMergedProductRequirementSetsDataFieldsResponseDto" } ], "description": "Response DTO representing data fields summary grouped by property name", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GroupedLookupOptionsDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "The identifier key for the data field", "nullable": true, "example": "legalEntityName" }, "fieldTypeId": { "type": "string", "description": "The unique identifier for the field type", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "fieldType": { "type": "string", "description": "Field type associated with this data key", "nullable": true, "example": "[\"multiselect\", \"select\"]" }, "names": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Collection of display names used for this field across different contexts", "nullable": true, "example": [ "Business Name", "Business Name 1" ] }, "jurisdictions": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Collection of jurisdiction names where this field is used", "nullable": true, "example": [ "California", "New York", "Texas" ] } }, "additionalProperties": false, "description": "Represents grouped lookup options for a field with associated metadata" }, "IValidationRuleModel": { "type": "object", "properties": { "isActive": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "InvestmentAccountFundDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "JourneyLevelDataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "MainEntityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "type": "object", "properties": { "taskDataKey": { "type": "string", "nullable": true }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "OwnershipAndControlRequirement": { "allOf": [ { "$ref": "#/components/schemas/Requirement" }, { "type": "object", "properties": { "ownershipDataKey": { "type": "string", "nullable": true }, "partyType": { "type": "string", "nullable": true, "deprecated": true }, "partyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "uboThreshold": { "type": "number", "format": "double", "nullable": true }, "sourceEntityType": { "type": "string", "nullable": true, "deprecated": true }, "relatedPartyEntityTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "directAssociationsOnly": { "type": "boolean" }, "idvOn": { "type": "boolean" }, "idvName": { "type": "string", "nullable": true }, "idvTooltip": { "type": "string", "nullable": true }, "isMandatory": { "type": "boolean", "deprecated": true }, "partyCount": { "type": "integer", "format": "int32", "nullable": true, "deprecated": true }, "ownershipValidationRule": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationRule" } ], "nullable": true } }, "additionalProperties": false } ] }, "OwnershipValidationData": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "partyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "addAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "idvIsMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "idvPartyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "idvAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true } }, "additionalProperties": false }, "OwnershipValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory requirement", "nullable": true }, "partyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "What is the minimum number of relationships that need to be added in order for this requirement to be fulfilled?", "nullable": true }, "addAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Is the unwrapping requirement non-calculable?", "nullable": true }, "idvIsMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory ID&V", "nullable": true }, "idvPartyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "What is the minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled?", "nullable": true }, "idvAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Do all entities that meet the criteria of this requirement need to be ID&Vd?", "nullable": true } }, "additionalProperties": false }, "OwnershipValidationRule": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "ownershipValidationData": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationData" } ], "nullable": true } }, "additionalProperties": false }, "OwnershipValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the ownership validation rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set", "format": "uuid", "example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3" }, "ownershipValidationData": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationDataDto" } ], "description": "Ownership Validation Data - set of validation rules specific to ownership requirement", "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProductRequirementDto": { "type": "object", "properties": { "rootVersionId": { "type": "string", "description": "The UiD of the root requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "Requirement set version number", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "tenant": { "type": "string", "description": "The UiD of the tenant", "nullable": true, "example": "c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1" }, "category": { "type": "string", "description": "Requirement business category", "nullable": true, "example": "Basic Details" }, "description": { "type": "string", "description": "Requirement description", "nullable": true, "example": "This is the client first name" }, "template": { "type": "string", "description": "Requirement template", "nullable": true, "example": "Product" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Individual" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "isSecondaryIdentifier": { "type": "boolean", "description": "Requirement Secondary Identifier flag", "example": true }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "isMaterialData": { "type": "boolean", "description": "Requirement material data flag", "example": true }, "isCoreDefinition": { "type": "boolean", "description": "Requirement is defined as core\nand cannot be deleted or altered", "example": false }, "jurisdiction": { "type": "string", "description": "Requirement jurisdiction", "nullable": true, "example": "Global" }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "description": "Requirement references list", "nullable": true }, "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Client" }, "classification": { "type": "string", "description": "Requirement classification", "nullable": true, "example": "Customer Profiling" }, "type": { "type": "string", "description": "Requirement type", "nullable": true, "example": "Data" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Requirement conditions list", "nullable": true }, "RequirementSetId": { "type": "string", "description": "The UiD of the current requirement set version", "format": "uuid", "example": "c060f297-70a2-4d4c-9360-9b5b39060ff0" }, "versionId": { "type": "string", "description": "The UiD of the current requirement set version", "format": "uuid", "example": "e060f297-70a2-4d4c-9360-9b5b39060ff0" }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data Field", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "defaultDateType": { "type": "string", "description": "Default Date Type e.g. Standard Default Value", "nullable": true, "example": "true" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "isIndexable": { "type": "boolean", "description": "Is requirement indexable", "example": true }, "isMandatoryIndexable": { "type": "boolean", "description": "Is requirement mandatory indexable", "example": true }, "isMandatory": { "type": "boolean", "description": "Is requirement mandatory", "example": false }, "documentDescription": { "type": "string", "description": "Document Description", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "Document Data Key", "nullable": true }, "acceptableDocumentTypes": { "type": "array", "items": { "type": "string" }, "description": "Acceptable document types for the e-signature document requirement", "nullable": true }, "documentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document Access Layers", "nullable": true }, "ownershipDataKey": { "type": "string", "description": "Ownership Data Key", "nullable": true, "example": "DataKey" }, "partyTypes": { "type": "array", "items": { "type": "string" }, "description": "Party Types e.g. [\"Director\"]", "nullable": true }, "uboThreshold": { "type": "number", "description": "UBO Threshold", "format": "double", "nullable": true, "example": 0.6 }, "relatedPartyEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "Types of Related Party Entity e.g. [\"Individual\"]", "nullable": true }, "directAssociationsOnly": { "type": "boolean", "description": "Is Only direct association", "example": false }, "idvOn": { "type": "boolean", "description": "Is Idv On", "example": false }, "idvName": { "type": "string", "description": "Idv Name", "nullable": true, "example": "IdentityRequirement" }, "idvTooltip": { "type": "string", "description": "Idv Tooltip", "nullable": true, "example": "Identity Requirement" }, "ownershipValidationRule": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationRuleDto" } ], "description": "Ownership Validation Rule", "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "description": "Validation Rule", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Requirement validation rules V2", "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "description": "List of conditional values", "nullable": true }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "hasCalculatedValue": { "type": "boolean", "description": "Does this field has calculated value?" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "description": "Calcualtion value", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags", "nullable": true }, "isTotalProductColumn": { "type": "boolean", "description": "Specifies is field is going to be displayed with a total summation", "example": true }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered\nnull", "nullable": true }, "dataProtectionJurisdiction": { "type": "string", "description": "Jurisdiction for data protection", "nullable": true, "example": "Global" }, "aggregateVersion": { "type": "integer", "description": "Requirement aggregate version", "format": "int32", "nullable": true, "example": 1 }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "clearValueIfTriggerConditionNotMet": { "type": "boolean", "description": "When enabled, the field value is cleared if its trigger condition is not met", "example": true } }, "additionalProperties": false, "description": "Request DTO representing requirement metadata" }, "ProductRequirementDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRequirementDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductRequirementDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProductRequirementDto" } ], "description": "Request DTO representing requirement metadata", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductRequirementSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the product requirement set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRequirementSetVersionDto" }, "description": "Versions associated to this product requirement set", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Product Requirement Set status", "nullable": true, "example": "Active" }, "jurisdiction": { "type": "string", "description": "Jurisdiction of the product requirement set", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Response DTO representing product requirement set data" }, "ProductRequirementSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRequirementSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductRequirementSetVersionDto": { "type": "object", "properties": { "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "readOnly": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The UiD of the requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "requirementSetStatus": { "type": "string", "description": "Requirement set status", "nullable": true, "example": "Active" }, "name": { "type": "string", "description": "Requirement set name", "nullable": true, "example": "Fenergo Comprehensive Standard Policy Requirements" }, "jurisdiction": { "type": "string", "description": "Requirement set jurisdiction", "nullable": true, "example": "Global" }, "defaultDataProtectionJurisdiction": { "type": "string", "description": "Default jurisdiction for data protection", "nullable": true, "example": "Global" }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/Requirement" }, "description": "List of requirements", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the requirement set can be applied", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing product requirement set version data" }, "ProductRequirementSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProductRequirementSetVersionDto" } ], "description": "Response DTO representing product requirement set version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProductRequirementsInScopeRequestDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of product requirement", "nullable": true, "example": "Data" }, "name": { "type": "string", "description": "Exact name of the product requirement", "nullable": true, "example": "Fenergo Comprehensive Standard Product Requirements" }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of product requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the product requirement in specific version. Null versionId will get the latest.", "nullable": true }, "isMandatory": { "type": "boolean", "description": "Mandatory flag of the product requirement", "nullable": true, "example": true }, "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Company" }, "isMaterialData": { "type": "boolean", "description": "Materiality flag of the product requirement", "nullable": true, "example": true }, "isSensitiveData": { "type": "boolean", "description": "Sensitive data flag of the product requirement", "nullable": true, "example": true }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data field definition", "nullable": true }, "isIndexable": { "type": "boolean", "description": "Requirement is data indexed for search flag", "nullable": true, "example": true }, "includeConditions": { "type": "boolean", "description": "Include conditions flag.\nIf true, include the Requirements containing conditions.\nIf false, only the Requirements without conditions will be returned.\nfalse" }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "disableFilteringForConditionalValues": { "type": "boolean", "description": "Filter product requirements containing conditional values only by basic properties: Target entity and Entity type", "example": true }, "enableBasicDataRequirementsFiltering": { "type": "boolean", "description": "Filter data requirements only by basic properties: Target entity and Entity type" }, "disableDeduplication": { "type": "boolean", "description": "Disable Requirements deduplication based on data key", "example": true } }, "additionalProperties": false, "description": "Request DTO representing product requirements search filter" }, "ProductRequirementsInScopeRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProductRequirementsInScopeRequestDto" } ], "description": "Request DTO representing product requirements search filter", "nullable": true } }, "additionalProperties": false }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "Reference": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReferenceDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Reference type", "nullable": true, "example": "FATCA" }, "description": { "type": "string", "description": "Reference description", "nullable": true, "example": "Foreign Account Tax Compliance Act" }, "url": { "type": "string", "description": "Reference URL", "nullable": true, "example": "www.irs.gov" } }, "additionalProperties": false, "description": "Request DTO representing reference metadata" }, "RegexRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleConditionalValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/RegexRule2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/RegexRuleConditionalValue" }, "nullable": true } }, "additionalProperties": false }, "RegexRuleConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/RegexRule2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/RegexRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RelatedAssetDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssetsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssociationDto": { "type": "object", "properties": { "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedClientDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedInvestmentManagerDataSource": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "dataSource": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedUnderlyingPrincipalOwnerDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "Requirement": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "type": "string", "nullable": true, "readOnly": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "rootVersionId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "template": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isSensitiveData": { "type": "boolean" }, "isMaterialData": { "type": "boolean" }, "isCoreDefinition": { "type": "boolean" }, "jurisdiction": { "type": "string", "nullable": true }, "dataProtectionJurisdiction": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/Reference" }, "nullable": true }, "targetEntity": { "type": "string", "nullable": true }, "classification": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RequirementSetId": { "type": "string", "format": "uuid" } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "Data": "#/components/schemas/DataRequirement", "Document": "#/components/schemas/DocumentRequirement", "eSignature Document": "#/components/schemas/ESignatureDocumentRequirement", "Ownership and Control": "#/components/schemas/OwnershipAndControlRequirement", "DataGroup": "#/components/schemas/DataGroupField" } } }, "RequirementListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Requirement" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RequirementSetJurisdictionDto": { "type": "object", "properties": { "availableJurisdictions": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of available jurisdictions in which requirement sets are created", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing requirement sets jurisdictions available" }, "RequirementSetJurisdictionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetJurisdictionDto" } ], "description": "Response DTO representing requirement sets jurisdictions available", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "reviewAndApprovals": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewAndApprovalDto" }, "nullable": true } }, "additionalProperties": false }, "ReviewAndApprovalDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "approvalOutcome": { "type": "string", "nullable": true }, "approvalReason": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ScopingRuleSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the scoping rule set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ScopingRuleSetVersionDto" }, "description": "Versions associated to this scoping rule set", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Product Requirement Set status", "nullable": true, "example": "Active" }, "uniqueIdentifier": { "type": "string", "description": "UniqueIdentifier of the scoping rule set", "nullable": true, "example": "Global" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleType" } ], "description": "Type of the scoping rule", "example": "ProductJourney" } }, "additionalProperties": false, "description": "Response DTO representing scoping rule set data" }, "ScopingRuleSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScopingRuleSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ScopingRuleSetVersionDto": { "type": "object", "properties": { "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "readOnly": true, "example": "2021-01-01T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Published" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The UiD of the scopingRule set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the scopingRule set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "scopingRuleSetStatus": { "type": "string", "description": "ScopingRule set status", "nullable": true, "example": "Active" }, "name": { "type": "string", "description": "ScopingRule set name", "nullable": true, "example": "Fenergo Comprehensive Standard Policy ScopingRules" }, "uniqueIdentifier": { "type": "string", "description": "ScopingRule set UniqueIdentifier", "nullable": true, "example": "Global" }, "separateJourneyPerProduct": { "type": "boolean", "description": "ScopingRule set SeparateJourneyPerProduct", "example": false }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the scopingRule set can be applied", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleType" } ], "description": "Type of the scoping rule", "example": "ProductJourney" } }, "additionalProperties": false, "description": "Response DTO representing scoping rule set version data" }, "ScopingRuleSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleSetVersionDto" } ], "description": "Response DTO representing scoping rule set version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ScopingRuleType": { "enum": [ "TaskDisplay", "ProductJourney" ], "type": "string" }, "SearchProductRequirementsDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Exact name of the product requirement", "nullable": true, "example": "Fenergo Comprehensive Standard Policy Requirements" }, "type": { "type": "string", "description": "Type of product requirement", "nullable": true, "example": "Data" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the product requirement in specific version. Null versionId will get the latest.", "nullable": true }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of product requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Company" }, "isMandatory": { "type": "boolean", "description": "Mandatory flag of the product requirement", "nullable": true, "example": true }, "isSensitiveData": { "type": "boolean", "description": "Sensitive data flag of the product requirement", "nullable": true, "example": true }, "isMaterialData": { "type": "boolean", "description": "Materiality flag of the product requirement", "nullable": true, "example": true }, "isIndexable": { "type": "boolean", "description": "Requirement is data indexed for search flag", "nullable": true, "example": true }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data field definition", "nullable": true }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "includeConditions": { "type": "boolean", "description": "Include conditions flag.\nIf true, include the Requirements containing conditions.\nIf false, only the Requirements without conditions will be returned.\nfalse" } }, "additionalProperties": false, "description": "Request DTO representing product requirements search filter" }, "SearchProductRequirementsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchProductRequirementsDto" } ], "description": "Request DTO representing product requirements search filter", "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SignificanceEngineDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDto" } ], "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "singleFields": { "type": "array", "items": { "type": "string" }, "nullable": true }, "collections": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SlimDataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "linkedParentFieldPropertyName": { "type": "string", "nullable": true }, "externalSearchApiProviderId": { "type": "string", "format": "uuid", "nullable": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchemaDto" } ], "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto" } ], "nullable": true } }, "additionalProperties": false }, "SlimDataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2" } ], "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "nullable": true } }, "additionalProperties": false, "description": "Slimmed validation rules DTO for the evaluation-definitions endpoint.\nOnly includes rules that the client-side evaluation engine reads.\nRules that are inactive (isActive=false, no dynamicRules) are omitted via\nthe mapper — properties are null and serialized away by JsonIgnore.\nExternalProvider and ExternalDataGroupProvider are stripped entirely\n(not consumed by the frontend eval engine)." }, "SlimProductRequirementDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "jurisdiction": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "targetEntity": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "references": { "type": "array", "items": { }, "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "isReadOnly": { "type": "boolean", "nullable": true }, "isSensitiveData": { "type": "boolean", "nullable": true }, "isSecondaryIdentifier": { "type": "boolean", "nullable": true }, "clearValueIfTriggerConditionNotMet": { "type": "boolean", "nullable": true }, "isMandatory": { "type": "boolean", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "defaultDateType": { "type": "string", "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "nullable": true }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/SlimDataFieldDto" } ], "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/SlimDataValidationRulesDto" } ], "description": "Slimmed validation rules DTO for the evaluation-definitions endpoint.\nOnly includes rules that the client-side evaluation engine reads.\nRules that are inactive (isActive=false, no dynamicRules) are omitted via\nthe mapper — properties are null and serialized away by JsonIgnore.\nExternalProvider and ExternalDataGroupProvider are stripped entirely\n(not consumed by the frontend eval engine).", "nullable": true } }, "additionalProperties": false, "description": "Slimmed requirement DTO for the evaluation-definitions endpoint.\nContains only the fields the client-side evaluation engine needs.\nReduces payload from ~265 KB to ~51 KB (81% reduction) for a typical product." }, "SpecialCharactersRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRule2" } ], "nullable": true } }, "additionalProperties": false }, "StringListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationData": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRule" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRule" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRule" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRule" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRule" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRule" } ], "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRule" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule" } ], "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow todays date", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "ValidationRule": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "propertyId": { "type": "string", "format": "uuid" }, "propertyName": { "type": "string", "nullable": true }, "friendlyName": { "type": "string", "nullable": true }, "validationType": { "type": "string", "nullable": true }, "isDataGroup": { "type": "boolean" }, "dataGroupId": { "type": "string", "format": "uuid", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationData" } ], "nullable": true }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "linkedParentFieldPropertyName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationRuleDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the validation rule", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set/data group", "format": "uuid", "example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3" }, "propertyId": { "type": "string", "description": "The UiD of the requirement/data group field", "format": "uuid", "example": "450df9bf-b2d3-48cf-ab8d-481c69b74373" }, "propertyTypeId": { "type": "string", "description": "The Guid containing the property type id", "format": "uuid", "nullable": true, "example": "450df9bf-b2d3-48cf-ab8d-481c69b74373" }, "linkChildFieldPropertyName": { "type": "string", "description": "The string containing the property name child of this property, only has value when propertyType is set to \"selectLink\"", "nullable": true, "example": "country" }, "linkedParentFieldPropertyName": { "type": "string", "description": "The string containing the property name parent of this property, only has value when propertyType is set to \"LinkedSelectV2\" or \"LinkedMultiSelectV2\"", "nullable": true, "example": "country" }, "dataGroupId": { "type": "string", "description": "The UiD of the of data group - is set only when requirement/data group field propertyType is set to \"dataGroup\"", "format": "uuid", "nullable": true, "example": "8eb83ec6-1539-46a9-b0ba-c5138a09580c" }, "isDataGroup": { "type": "boolean", "description": "Flag indicating it is validation rules for data group field", "example": true }, "propertyName": { "type": "string", "description": "Requirement/data group field property name", "nullable": true, "example": "firstName" }, "friendlyName": { "type": "string", "description": "Requirement/data group field friendly Name", "nullable": true, "example": "First Name" }, "validationType": { "type": "string", "description": "Validation type", "nullable": true, "example": "text" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation rule metadata" }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValueLimitRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRule2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleConditionalValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValueLimitRuleConditionalValue" }, "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleConditionalValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinition" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValueDto" }, "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ValueLimitRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleValidationRule": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRule2" } ], "nullable": true } }, "additionalProperties": false }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction of the requirement", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction of the requirement", "format": "uuid", "nullable": true, "example": "894e1443-dd7a-4b9d-b253-430c2de80524" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }