{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Policy Query", "description": "Policy Query API is part of FenX eco-system to query for Requirement Sets, Requirements, Data Groups and Data Group Fields Instances. All the operations require valid access token obtained from Identity service.", "version": "2.0" }, "servers": [ { "url": "/policyquery" } ], "paths": { "/api/v2/data-group": { "get": { "tags": [ "DataGroup" ], "summary": "Get data groups", "description": "This endpoint is obsolete and was terminated on 2024-08-01. Use /api/data-group/lite instead.
\nReturns the list of all data groups.

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetAllDataGroups", "parameters": [ { "name": "onlyPublishedAndArchived", "in": "query", "description": "Flag that indicate that we will return only versions with status Published and\nArchived", "schema": { "type": "boolean" } }, { "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. The list of data groups is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupDtoIEnumerableServiceResponse" } } } }, "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" } ] } } } } }, "deprecated": true } }, "/api/v2/data-group/latest": { "get": { "tags": [ "DataGroup" ], "summary": "Get latest data groups with published or archived status", "description": "\nReturns the list of data groups with publish or archived status .

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetLatestDataGroups", "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. The list of data groups is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupVersionDtoListServiceResponse" } } } }, "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/v2/data-group/lite": { "get": { "tags": [ "DataGroup" ], "summary": "Get data groups lite", "description": "\nReturns the list of all data groups versions without fields.

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetDataGroupsLite", "parameters": [ { "name": "onlyPublishedAndArchived", "in": "query", "description": "Flag that indicate that we will return only versions with status Published and\nArchived", "schema": { "type": "boolean" } }, { "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. The list of data groups is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupLiteDtoIEnumerableServiceResponse" } } } }, "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/v2/data-group/{dataGroupId}": { "get": { "tags": [ "DataGroup" ], "summary": "Get data group by id", "description": "\nReturns the active, currently in effect, published data group version for a given id.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetDataGroupById", "parameters": [ { "name": "dataGroupId", "in": "path", "description": "Data group 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. Data group is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupVersionDtoServiceResponse" } } } }, "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. Data group 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/v2/data-group/{dataGroupId}/version/{versionNumber}": { "get": { "tags": [ "DataGroup" ], "summary": "Get data group by id and version", "description": "\nReturns data group for a given id and version number.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetDataGroupVersionById", "parameters": [ { "name": "dataGroupId", "in": "path", "description": "Data group id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Data group 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. Data group is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupVersionDtoServiceResponse" } } } }, "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. Data group 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/v2/data-group/{dataGroupId}/version/{versionNumber}/field/{id}": { "get": { "tags": [ "DataGroup" ], "summary": "Get data group field by id", "description": "\nReturns data group field by given data group id, data group version number and data group field id.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetDataGroupFieldById", "parameters": [ { "name": "dataGroupId", "in": "path", "description": "Data group id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Data group version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "Data group field 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. Data group field is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupFieldDtoServiceResponse" } } } }, "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. Data group/data group field 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/v2/data-group/versions": { "post": { "tags": [ "DataGroup" ], "summary": "Get data groups by id and version numbers", "description": "\nReturns list of data groups for a given id and version numbers.

Required permissions:
At least one of the following permissions is required: PolicyConfigurationAccess, PolicySearch", "operationId": "GetDataGroups", "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": "List of Data Group data with versions", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetDataGroupsRequestDtoServiceRequest" } ], "description": "Service request data" } } }, "required": true }, "responses": { "200": { "description": "Success. Data group is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataGroupDtoIEnumerableServiceResponse" } } } }, "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. Data group 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/v2/requirement-set/light": { "post": { "tags": [ "GetRequirenmentSetsByIdsLight" ], "summary": "Gets light version of requirement sets based on entity requirements", "description": "

Required permissions:
Following permissions are required: PolicySearch", "operationId": "GetRequirenmentSetsByIdsLight", "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": "List of entity requirements with offboarded jurisdictions included", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRequirementSetsByIdsLightRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. List of light requirement sets data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetLightDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement sets with given ids don't 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/v2/requirement-set/{setId}/version/{versionNumber}/light": { "get": { "tags": [ "GetRequirementSetVersionLightById" ], "summary": "Get light requirement set by id and version", "description": "\nReturns light requirement set for a given id and version number.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementSetVersionLightById", "parameters": [ { "name": "setId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "Requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "excludeRequirements", "in": "query", "description": "Flag indicating if query should return light requirements of version", "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. Requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetVersionLightDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set 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/v2/requirement-set/{versionId}/requirements": { "get": { "tags": [ "GetRequirementsByVersionIdPaged" ], "summary": "Get paged requirements by set version id", "description": "\nReturns requirements for a given version id.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementsByVersionIdPaged", "parameters": [ { "name": "versionId", "in": "path", "description": "Requirement set version id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageSize", "in": "query", "description": "Maximum page size", "schema": { "type": "integer", "format": "int32", "default": 500 } }, { "name": "paginationToken", "in": "query", "description": "Pagination token", "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. Requirements are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementDtoItemsPageServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirements with given version id do 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/v2/requirement-set/merged-data-fields": { "post": { "tags": [ "GetMergedRequirementSetsDataFields" ], "summary": "Gets summary of data fields from all jurisdictions merged by property name", "description": "

Required permissions:
Following permissions are required: PolicySearch", "operationId": "GetMergedRequirementSetsDataFields", "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 requirements", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. Data fields summary grouped by property name is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse" } } } }, "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/v2/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: PolicySearch", "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" } ], "description": "Service request data" } } } }, "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/v2/requirement-set/{setId}/version/{versionNumber}/export": { "get": { "tags": [ "ExportRequirementSetVersionById" ], "summary": "Export policy requirement set by id and version", "description": "\nReturns a PDF export for a policy requirement set for a given id and version number.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "ExportRequirementSetVersionById", "parameters": [ { "name": "setId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "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. A Signed S3 URL for the Requirement set PDF export will be returned via WebSocket" }, "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/v2/requirement-set": { "get": { "tags": [ "RequirementSet" ], "summary": "Get requirement sets", "description": "

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetAllRequirementSets", "parameters": [ { "name": "includeRequirements", "in": "query", "description": "Flag to include requirements in the response.", "schema": { "type": "boolean", "default": false } }, { "name": "versionsLimit", "in": "query", "description": "Optional limit on versions returned per jurisdiction. When omitted, all versions are returned.", "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. List of requirement sets data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetDtoIEnumerableServiceResponse" } } } }, "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/v2/requirement-set/{setId}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get requirement set by id", "description": "\nReturns the active, currently in effect, published requirement set version for a given id.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementSetById", "parameters": [ { "name": "setId", "in": "path", "description": "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. Requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set 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/v2/requirement-set/{setId}/version/{versionNumber}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get requirement set by id and version", "description": "\nReturns requirement set for a given id and version number.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementSetVersionById", "parameters": [ { "name": "setId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "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. Requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set 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/v2/requirement-set/{setId}/version/{versionNumber}/field/{id}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get requirement by id", "description": "\nReturns requirement by given requirement set id, requirement set version number and requirement id.

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementById", "parameters": [ { "name": "setId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "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. Requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set/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/v2/requirement-set/jurisdictions": { "get": { "tags": [ "RequirementSet" ], "summary": "Get jurisdictions", "description": "

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "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/v2/requirements-in-scope": { "post": { "tags": [ "RequirementsInScope" ], "summary": "Get requirements in scope", "description": "\nReturns deduplicated requirements that are in scope for a given search criteria.

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

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

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

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "operationId": "GetRequirementsByTags", "parameters": [ { "name": "tags", "in": "query", "description": "List of tags", "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 requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementDtoListServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "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/v2/tag": { "get": { "tags": [ "Tag" ], "summary": "Get list of published tags for tenant", "description": "\nReturns list of published tags for tenant

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "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/v2/tag/requirement-set/{setId}": { "get": { "tags": [ "Tag" ], "summary": "Get list of tags in Requirement Set", "description": "\nReturns list of tags in Requirement Set

Required permissions:
Following permissions are required: PolicyConfigurationAccess", "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/v2/validation-rule/validation-rules": { "post": { "tags": [ "ValidationRule" ], "summary": "Get validation data by jurisdiction(s)", "description": "\nReturns validation data of requirements and data groups by requirement set jurisdiction(s).

Required permissions:
Following permissions are required: PolicySearch", "operationId": "GetValidationRules", "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": "Get validation data request.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetValidationRulesRequestDtoServiceRequest" } ], "description": "Service request data" } } } }, "responses": { "200": { "description": "Success. The list of validation data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationRuleListServiceResponse" } } } }, "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" } ] } } } } } } } }, "components": { "schemas": { "AccessLayerDto": { "type": "object", "properties": { "geographic": { "type": "array", "items": { "type": "string" }, "nullable": true }, "businessRelated": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties", "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" }, "nullable": true } }, "additionalProperties": false }, "AlertAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/AlertAssessmentDto" }, "nullable": true }, "lastAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDto" } ], "nullable": true }, "lastAssessmentOutcome": { "type": "string", "nullable": true }, "lastAssessmentDisposition": { "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 }, "AssociatedVersionedJurisdictionDto": { "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" }, "isOffboarded": { "type": "boolean", "description": "Flag to determine if previously inherited jurisdiction is now offboarded" } }, "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" }, "description": "Generic properties setup in policy for manual credit assessment", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "assessmentOutcome": { "type": "string", "description": "Assessment Outcome of this manual credit assessment", "nullable": true }, "providerInternalIdentifier": { "type": "string", "description": "Provider Internal Identifier", "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", "description": "Entity Id", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "description": "The outcome recorded for a manual screening task.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for auto credit screening", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "providerInternalIdentifier": { "type": "string", "description": "Provider Internal Identifier", "nullable": true } }, "additionalProperties": false }, "BasicRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "BasicRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "BasicRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/BasicRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "BasicRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Request DTO representing basic validation rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "BasicRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Static validation rule always applied when active", "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" }, "description": "Generic properties setup in policy", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "CollectionMinimumCountRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minimum count validation rule metadata" }, "CollectionMinimumCountRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minimum count validation rule metadata" }, "CollectionMinimumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Name of the field to evaluate", "nullable": true, "example": "EntityType" }, "value": { "type": "array", "items": { "type": "string" }, "description": "List of values", "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "description": "List of value ids", "nullable": true }, "valueType": { "type": "string", "description": "Type of the value", "nullable": true, "example": "text" }, "dataSource": { "type": "string", "description": "Data source from which field is retrieved. If empty then Entity Data properties will be used.", "nullable": true, "example": "entityDataMetadata" }, "operation": { "type": "string", "description": "Logical operation to be performed to match the values", "nullable": true, "example": "equal" }, "logicalOperation": { "type": "string", "description": "Logical operation to be performed on the operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "description": "Field value used for conditional limit validation", "nullable": true } }, "additionalProperties": false, "description": "Represents condition" }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true } }, "additionalProperties": false, "description": "Represents condition root" }, "ConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "type": "string", "description": "Value that should be returned when conditions are met", "nullable": true, "example": "Relationship Manager" }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 }, "valueId": { "type": "string", "description": "Value Id that should be returned when conditions are met", "nullable": true, "example": "RM" } }, "additionalProperties": false }, "CreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for manual credit assessment", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "assessmentOutcome": { "type": "string", "description": "Assessment Outcome of this manual credit assessment", "nullable": true }, "assessmentComment": { "type": "string", "description": "Assessment Comment of this credit assessment", "nullable": true }, "taskId": { "type": "string", "description": "Task Id", "nullable": true }, "taskDataKey": { "type": "string", "description": "Task Data Key", "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" }, "description": "Generic properties setup in product policy", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "lifecycleStatus": { "type": "string", "description": "System field used in backend for status of a product in lifecycle", "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, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "linkChildFieldPropertyName": { "type": "string", "description": "Linked child field property name", "nullable": true, "example": "productCategory" }, "linkedParentFieldPropertyName": { "type": "string", "description": "Linked Parent field property name", "nullable": true, "example": "productCategory" }, "externalSearchApiProviderId": { "type": "string", "description": "External search api provider id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" }, "propertyTypeVersion": { "type": "integer", "description": "Property version", "format": "int32", "nullable": true, "deprecated": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/NumberFormulaSchemaDto" } ], "description": "Number formula schema", "nullable": true }, "dateTimePeriodFormulaSchema": { "allOf": [ { "$ref": "#/components/schemas/DateTimePeriodFormulaSchemaDto" } ], "description": "Date formula schema", "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" ] }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true } }, "additionalProperties": false, "description": "Response DTO representing data field summary" }, "DataGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the data group", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupVersionDto" }, "description": "Versions associated to this data group", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing data group data" }, "DataGroupDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DataGroupFieldDto": { "type": "object", "properties": { "identifier": { "type": "string", "description": "The UiD of the data group field", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Data group field name", "nullable": true, "example": "Product Type" }, "type": { "type": "string", "description": "Data group field type", "nullable": true, "example": "DataGroup" }, "order": { "type": "number", "description": "Data group field order", "format": "double", "nullable": true, "example": 2 }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data group field data field", "nullable": true }, "isSensitiveData": { "type": "boolean", "description": "Data group field sensitive data flag", "example": true }, "isCoreDefinition": { "type": "boolean", "description": "Data group field core definition flag", "example": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRule" } ], "description": "Data group field validation data", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Request DTO representing validation data metadata", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Data group field conditions list", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "defaultValue": { "type": "string", "description": "Default value for this data field", "nullable": true, "example": "Australia" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "description": "List of conditional values", "nullable": true }, "hasEvaluatedConditionalValue": { "type": "boolean", "description": "Does this field has evaluated conditional value?" }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "evaluatedConditionalValueId": { "type": "string", "description": "Evaluated conditional value Id", "nullable": true }, "description": { "type": "string", "description": "Data group field description", "nullable": true, "example": "This is the field description" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags", "nullable": true, "example": [ "internal" ] }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceDto" }, "description": "Data group field references list. Gated by the `DataGroupPolicyReferencesEnabled` feature flag:\nalways null when the flag is disabled for the tenant; when enabled, reflects\nwhatever references are stored for the field, which may itself be null if none exist.", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing data group field data" }, "DataGroupFieldDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DataGroupFieldDto" } ], "description": "Response DTO representing data group field data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DataGroupIdentifierDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Data Group UiD", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumbers": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Data Group Version Numbers", "nullable": true, "example": [ 1, 2 ] } }, "additionalProperties": false }, "DataGroupLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the data group", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupVersionLiteDto" }, "description": "Versions associated to this data group", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing data group data lite" }, "DataGroupLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupLiteDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DataGroupVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the data group version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "groupId": { "type": "string", "description": "The UiD of the data group that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Data group Name", "nullable": true, "example": "Product" }, "description": { "type": "string", "description": "Data group description", "nullable": true, "example": "Set of fields for capturing Product" }, "primaryDataGroupField": { "type": "string", "description": "Property name for 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" }, "cardinality": { "type": "boolean", "description": "Data group cardinality flag", "example": false }, "template": { "type": "string", "description": "Data group template", "nullable": true, "example": "Product" }, "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 }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed\nthat version notes won't contain 'personal identifiable information'. Please note that having many versions with\nvery long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" }, "dataGroupFields": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupFieldDto" }, "description": "List of data group fields", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing data group version data" }, "DataGroupVersionDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupVersionDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DataGroupVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DataGroupVersionDto" } ], "description": "Response DTO representing data group version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DataGroupVersionLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the data group version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "groupId": { "type": "string", "description": "The UiD of the data group that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Data group Name", "nullable": true, "example": "Product" }, "description": { "type": "string", "description": "Data group description", "nullable": true, "example": "Set of fields for capturing Product" }, "primaryDataGroupField": { "type": "string", "description": "Property name for 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" }, "cardinality": { "type": "boolean", "description": "Data group cardinality flag", "example": false }, "template": { "type": "string", "description": "Data group template", "nullable": true, "example": "Product" }, "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 }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed\nthat version notes won't contain 'personal identifiable information'. Please note that having many versions with\nvery long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Response DTO representing data group version lite data" }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "description": "DataSource for EntityDraft information beside generic properties", "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "description": "DataSource for EventIngress event details", "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "description": "DataSource for detecting changed EntityDraft properties in comparasion with verified Entity", "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "description": "DataSource for new Related Client properties added in Association task", "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "description": "DataSource for new Related Product properties added in Manage Product task", "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "description": "DataSource for single, current data group row item. Can be used only for Data Group field conditions.", "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "description": "DataSource for External Data Adapter (Ongoing Monitoring) event details", "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "description": "DataSource for entity association details", "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "description": "DataSource for manual credit assessment", "nullable": true }, "reviewAndApproval": { "allOf": [ { "$ref": "#/components/schemas/ReviewAndApprovalDataSource" } ], "description": "DataSource for review and approval", "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "description": "DataSource for auto credit assessment", "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "description": "DataSource for entity current journeys", "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "description": "DataSource for auto credit screening", "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "description": "DataSource for product scoping", "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "description": "DataSource for related deals", "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "description": "DataSource for main entity properties used for condition evaluation", "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "description": "DataSource for related assets", "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "description": "DataSource for related associations", "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "description": "DataSource for account related funds", "nullable": true }, "investmentAccountFund": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountFundDataSource" } ], "description": "DataSource for investment account fund", "nullable": true }, "investmentAccountRelatedFundShareClass": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource" } ], "description": "DataSource for investment account related fund share class", "nullable": true }, "investmentAccount": { "allOf": [ { "$ref": "#/components/schemas/InvestmentAccountDataSource" } ], "description": "DataSource for in-scope investment accounts, evaluated across all accounts on the entity", "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "description": "DataSource for draft properties using journey level data requirements used for journey scoping", "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "description": "DataSource for related parties entity properties", "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "description": "DataSource for condtional limit validation", "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "description": "DataSource for significance engine", "nullable": true }, "alert": { "allOf": [ { "$ref": "#/components/schemas/AlertDataSource" } ], "description": "DataSource for Transaction Monitoring Alert", "nullable": true }, "relatedFCRs": { "allOf": [ { "$ref": "#/components/schemas/RelatedFCRsDataSource" } ], "description": "DataSource for related FCRs in product domain", "nullable": true }, "relatedInvestmentManager": { "allOf": [ { "$ref": "#/components/schemas/RelatedInvestmentManagerDataSource" } ], "description": "Related Investment Manager data source for product domain", "nullable": true }, "relatedUnderlyingPrincipalOwner": { "allOf": [ { "$ref": "#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource" } ], "description": "Data Source for Related UP Owners", "nullable": true }, "alertAssessment": { "allOf": [ { "$ref": "#/components/schemas/AlertAssessmentDataSource" } ], "description": "DataSource for Transaction Monitoring Alert assessment outcomes", "nullable": true }, "currentProductMetadata": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductMetadataDataSource" } ], "description": "DataSource for Product Metadata", "nullable": true }, "currentUser": { "allOf": [ { "$ref": "#/components/schemas/CurrentUserDataSource" } ], "description": "DataSource for current user", "nullable": true }, "relatedDocuments": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentsDataSource" } ], "description": "DataSource for related documents", "nullable": true }, "screeningMateriality": { "allOf": [ { "$ref": "#/components/schemas/ScreeningMaterialityDataSource" } ], "description": "DataSource for Screening Materiality Assessment outcomes for the entity being evaluated (main entity or a specific related party).", "nullable": true } }, "additionalProperties": false }, "DataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto" } ], "description": "Special characters validation rule - does not allow special characters,\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoValidationRuleDto" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set selection range", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to use external provider for validation", "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to use external provider for validation of one field with other fields as context", "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set if field should be read only", "nullable": true }, "conditionalLimit": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that validates the dynamic value against provided condition", "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" } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "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 } }, "additionalProperties": false }, "DateLimitRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minDate": { "type": "string", "description": "Minimum date", "format": "date-time", "nullable": true, "example": "2020-01-01T14:48:00.000Z" }, "maxDate": { "type": "string", "description": "Maximum date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" } }, "additionalProperties": false, "description": "Request DTO representing date limit rule metadata" }, "DateLimitRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minDate": { "type": "string", "description": "Minimum date", "format": "date-time", "nullable": true, "example": "2020-01-01T14:48:00.000Z" }, "maxDate": { "type": "string", "description": "Maximum date", "format": "date-time", "nullable": true, "example": "2021-01-01T14:48:00.000Z" } }, "additionalProperties": false, "description": "Request DTO representing date limit rule metadata" }, "DateLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/DateLimitRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "description": "Request DTO representing date limit rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "DateTimePeriodFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string", "nullable": true }, "dateTimePeriodFormulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DateTimePeriodFormulaVariableDto" }, "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" }, "EmptyRuleDto": { "type": "object", "additionalProperties": false, "description": "Request DTO representing rule with no parameters" }, "EmptyRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "EmptyRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "description": "Request DTO representing rule with no parameters", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "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" } ], "description": "Generic properties", "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluateRequirementsInScopeRequestDto": { "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, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ], "description": "Additional data sources used for evaluation", "nullable": true } }, "additionalProperties": false }, "EvaluateRequirementsInScopeRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateRequirementsInScopeRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "EventIngressDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalProviderRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExternalProviderRuleDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Id of external provider.", "format": "uuid" } }, "additionalProperties": false, "description": "Request DTO representing external provider rule metadata" }, "ExternalProviderRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "providerId": { "type": "string", "description": "Id of external provider.", "format": "uuid" } }, "additionalProperties": false, "description": "Request DTO representing external provider rule metadata" }, "ExternalProviderRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto" } ], "description": "Static validation rule always applied when active", "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" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "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, "description": "Service request data" }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Field name for the filter condition", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions applied to the field", "nullable": true } }, "additionalProperties": false }, "GetDataGroupsRequestDto": { "type": "object", "properties": { "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupIdentifierDto" }, "description": "List with DataGroup Id and Version Numbers", "nullable": true } }, "additionalProperties": false }, "GetDataGroupsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetDataGroupsRequestDto" } ], "description": "The service request DTO", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "GetMergedRequirementSetsDataFieldsRequestDto": { "type": "object", "properties": { "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Client" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Individual" }, "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" }, "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" }, "GetMergedRequirementSetsDataFieldsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsRequestDto" } ], "description": "Request DTO representing parameters to filter returned data fields", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "GetMergedRequirementSetsDataFieldsResponseDto": { "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" }, "GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDto" } ], "description": "Response DTO representing data fields summary grouped by property name", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetRequirementSetsByIdsLightRequestDto": { "type": "object", "properties": { "inScopeJurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Entitys data jurisdictions", "nullable": true }, "offboardedJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "List of Entitys offboarded jursidictions", "nullable": true }, "associatedJurisdictionsFromParents": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedVersionedJurisdictionDto" }, "description": "List of entity jursidictions associated from parents", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing light requirenment sets" }, "GetRequirementSetsByIdsLightRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRequirementSetsByIdsLightRequestDto" } ], "description": "Request DTO representing light requirenment sets", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "GetValidationRulesRequestDto": { "required": [ "entityType", "jurisdictions" ], "type": "object", "properties": { "jurisdictions": { "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "List of jurisdictions e.g. [\"Global\", \"Ireland\"]" }, "entityType": { "minLength": 1, "type": "string", "description": "The type of the entity (Individual, Company, Other, All)", "example": "Individual" }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing validation request data" }, "GetValidationRulesRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetValidationRulesRequestDto" } ], "description": "Response DTO representing validation request data", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "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" }, "InvestmentAccountDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "investmentAccount": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentAccountDto" }, "nullable": true } }, "additionalProperties": false }, "InvestmentAccountDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties of a single in-scope investment account", "nullable": true } }, "additionalProperties": false }, "InvestmentAccountFundDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Properties of the single investment account fund", "nullable": true } }, "additionalProperties": false }, "InvestmentAccountRelatedFundShareClassDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Properties of the investment account related fund share class", "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", "description": "Task Data Key", "nullable": true }, "taskId": { "type": "string", "description": "Task Id", "format": "uuid" }, "entityId": { "type": "string", "description": "Entity Id", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "description": "The outcome recorded for a manual screening task.", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy for manual credit screening", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "NumberFormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string", "nullable": true }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NumberFormulaVariableDto" }, "nullable": true } }, "additionalProperties": false }, "NumberFormulaVariableDto": { "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 }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "OwnershipValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Request DTO representing basic validation rule metadata", "nullable": true }, "partyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Request DTO representing value limit rule metadata", "nullable": true }, "addAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Request DTO representing basic validation rule metadata", "nullable": true }, "idvIsMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Request DTO representing basic validation rule metadata", "nullable": true }, "idvPartyCount": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Request DTO representing value limit rule metadata", "nullable": true }, "idvAllParties": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Request DTO representing basic validation rule metadata", "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": { } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "PropertyDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ReferenceDto": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RegexRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "isCaseSensitive": { "type": "boolean", "description": "Flag that indicate if regex is case sensitive", "example": false }, "regexValue": { "type": "string", "description": "Regex expression", "nullable": true, "example": "^[\\\\w-\\\\.]+@([\\\\w-]+\\\\.)+[\\\\w-]{2,4}$" } }, "additionalProperties": false, "description": "Request DTO representing regex rule metadata" }, "RegexRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "isCaseSensitive": { "type": "boolean", "description": "Flag that indicate if regex is case sensitive", "example": false }, "regexValue": { "type": "string", "description": "Regex expression", "nullable": true, "example": "^[\\\\w-\\\\.]+@([\\\\w-]+\\\\.)+[\\\\w-]{2,4}$" } }, "additionalProperties": false, "description": "Request DTO representing regex rule metadata" }, "RegexRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/RegexRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "RegexRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "description": "Request DTO representing regex rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "RelatedAssetDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "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", "description": "Type of this association", "nullable": true, "example": "Employee of " }, "ownershipPercentage": { "type": "number", "description": "Ownership Percentage of this association", "format": "double", "nullable": true, "example": 0.5 }, "associationToClient": { "type": "string", "description": "Association To Client", "nullable": true, "example": "Direct/Indirect" }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "description": "Generic properties", "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, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "RelatedDealDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in policy", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "RelatedDealsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDocumentDto": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/RelatedDocumentVersionedDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedDocumentVersionedDto": { "type": "object", "properties": { "documentKey": { "type": "string", "nullable": true }, "documentType": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } } }, "additionalProperties": false }, "RelatedDocumentsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDocumentDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedFCRDto": { "type": "object", "properties": { "status": { "type": "string", "description": "The status of the FCR.", "nullable": true }, "createdDate": { "type": "string", "description": "The date the FCR was created.", "format": "date-time" }, "submittedDate": { "type": "string", "description": "The date the FCR was submitted.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RelatedFCRsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "fcRs": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedFCRDto" }, "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" } ], "description": "Generic properties setup in policy", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "The properties from the actual relationship", "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Generic properties setup in product policy", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "lifecycleStatus": { "type": "string", "description": "System field used in backend for status of a product in lifecycle", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "description": "System field used in backend for product of a product relationship", "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 }, "RequirementDto": { "type": "object", "properties": { "rootVersionId": { "type": "string", "description": "The UiD of the root requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "Requirement set version number", "format": "int32", "example": 1 }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "tenant": { "type": "string", "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" }, "isSensitiveData": { "type": "boolean", "description": "Requirement sensitive data flag", "example": true }, "isMaterialData": { "type": "boolean", "description": "Requirement material data flag", "example": true }, "isCoreDefinition": { "type": "boolean", "description": "Requirement is defined as core and cannot be deleted or altered", "example": false }, "jurisdiction": { "type": "string", "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 }, "dataProtectionJurisdiction": { "type": "string", "description": "Jurisdiction for data protection", "nullable": true, "example": "Global" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "defaultValue": { "type": "string", "description": "Default Value", "nullable": true, "example": "Not Available" }, "isReadOnly": { "type": "boolean", "description": "Is requirement readonly", "example": false }, "isIndexable": { "type": "boolean", "description": "Is requirement indexable", "example": true }, "isJourneyLevelData": { "type": "boolean", "description": "Is journey level data", "example": false }, "isMandatoryIndexable": { "type": "boolean", "description": "Is requirement mandatory indexable", "example": true }, "isMandatory": { "type": "boolean", "description": "Is requirement mandatory", "example": false }, "documentDescription": { "type": "string", "description": "Document Description", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "Document Data Key", "nullable": true }, "documentAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Document Access Layers", "nullable": true }, "acceptableDocumentDataKeys": { "type": "array", "items": { "type": "string" }, "description": "List of acceptable Document Types for the Document Requirement", "nullable": true }, "fieldAccessLayers": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "Field Access Layers", "nullable": true }, "isMasked": { "type": "boolean", "description": "Flag indicating if field is masked due to missing Sensitive Data Access layers", "example": false }, "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": "Request DTO representing validation data metadata", "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?" }, "evaluatedConditionalValueId": { "type": "string", "description": "Evaluated conditional value Id", "nullable": true }, "evaluatedConditionalValue": { "type": "string", "description": "Evaluated conditional value", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags", "nullable": true }, "clearValueIfTriggerConditionNotMet": { "type": "boolean", "description": "Indicates whether the field value should be cleared when trigger conditions are not met", "example": false }, "aggregateVersion": { "type": "integer", "description": "Requirement aggregate version", "format": "int32", "nullable": true, "example": 1 }, "uiDecoration": { "type": "string", "description": "Determines how the requirement should be rendered", "nullable": true }, "uiColorDecoration": { "type": "string", "description": "Determines with what colour requirement should be rendered", "nullable": true }, "portalGuidance": { "type": "string", "description": "Portal guidance", "nullable": true, "example": "Provide at least one director RP" }, "isLocked": { "type": "boolean", "description": "True if the aggregate is locked (obsolete)", "example": false, "deprecated": true }, "discriminator": { "type": "string", "description": "Data group field core definition flag (obsolete)", "nullable": true, "example": "true", "deprecated": true }, "version": { "type": "integer", "description": "Requirement aggregate version (obsolete)", "format": "int32", "example": true, "deprecated": true }, "partyCount": { "type": "integer", "description": "Requirement party count", "format": "int32", "nullable": true, "example": 1, "deprecated": true }, "partyType": { "type": "string", "description": "Requirement party type", "nullable": true, "example": "Shareholder", "deprecated": true }, "sourceEntityType": { "type": "string", "description": "Any of the related party entity types selected can be counted toward this requirement", "nullable": true, "example": "Individual", "deprecated": true } }, "additionalProperties": false, "description": "Request DTO representing requirement metadata" }, "RequirementDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "RequirementDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementDtoItemsPage" } ], "description": "Query Result Page", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementDto" } ], "description": "Request DTO representing requirement metadata", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementLightDto": { "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" }, "RequirementSetId": { "type": "string", "description": "The UiD of the current requirement set version", "format": "uuid", "example": "c060f297-70a2-4d4c-9360-9b5b39060ff0" }, "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" }, "entityType": { "type": "string", "description": "Requirement entity type", "nullable": true, "example": "Individual" }, "name": { "type": "string", "description": "Requirement name", "nullable": true, "example": "First Name" }, "targetEntity": { "type": "string", "description": "Requirement target entity", "nullable": true, "example": "Client" }, "type": { "type": "string", "description": "Requirement type", "nullable": true, "example": "Data" }, "dataFieldPropertyName": { "type": "string", "description": "Data Field Property Name", "nullable": true }, "dataFieldPropertyType": { "type": "string", "description": "Data Field Property Type", "nullable": true }, "dataFieldPropertyTypeId": { "type": "string", "description": "Data Field Property Type Id", "format": "uuid", "nullable": true }, "isMandatory": { "type": "boolean", "description": "Is requirement mandatory", "example": false }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "documentDescription": { "type": "string", "description": "Document Description", "nullable": true, "example": "Driver License" }, "documentDataKey": { "type": "string", "description": "Document Data Key", "nullable": true }, "relatedPartyEntityTypes": { "type": "array", "items": { "type": "string" }, "description": "Types of Related Party Entity e.g. [\"Individual\"]", "nullable": true }, "jurisdiction": { "type": "string", "description": "Requirement jurisdiction", "nullable": true, "example": "Global" }, "ownershipValidationRule": { "allOf": [ { "$ref": "#/components/schemas/OwnershipValidationRuleDto" } ], "description": "Ownership Validation Rule", "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 }, "idvName": { "type": "string", "description": "Idv Name", "nullable": true, "example": "IdentityRequirement" }, "uboThreshold": { "type": "number", "description": "UBO Threshold", "format": "double", "nullable": true, "example": 0.6 } }, "additionalProperties": false, "description": "Request light DTO representing requirement metadata" }, "RequirementSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the requirement set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementSetVersionDto" }, "description": "Versions associated to this requirement set", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "status": { "type": "string", "description": "Requirement Set status", "nullable": true, "example": "Active" }, "jurisdiction": { "type": "string", "description": "Jurisdiction of the requirement set", "nullable": true, "example": "Global" } }, "additionalProperties": false, "description": "Response DTO representing requirement set data" }, "RequirementSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementSetDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "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" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementSetLightDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the requirement set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "Requirement set name", "nullable": true, "example": "Fenergo Comprehensive Standard Policy Requirements" }, "status": { "type": "string", "description": "The status of requirement set", "nullable": true, "example": "In Scope" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 1 }, "jurisdiction": { "type": "string", "description": "Jurisdiction of the requirement set", "nullable": true, "example": "Global" }, "jurisdictionContext": { "type": "string", "description": "The jurisdiction context of requirement set", "nullable": true, "example": "Inherent" } }, "additionalProperties": false, "description": "Response DTO representing light version of jurisdiction set" }, "RequirementSetLightDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementSetLightDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementSetVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "requirementSetStatus": { "type": "string", "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/RequirementDto" }, "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 }, "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 }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed\nthat version notes won't contain 'personal identifiable information'. Please note that having many versions with\nvery long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "Response DTO representing requirement set version data" }, "RequirementSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetVersionDto" } ], "description": "Response DTO representing requirement set version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementSetVersionLightDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the requirement set version", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "requirementSetStatus": { "type": "string", "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/RequirementLightDto" }, "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 }, "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" }, "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 }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed\nthat version notes won't contain 'personal identifiable information'. Please note that having many versions with\nvery long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" }, "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" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true } }, "additionalProperties": false }, "RequirementSetVersionLightDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetVersionLightDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "RequirementsInScopeRequestV2Dto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of requirement", "nullable": true, "example": "Data" }, "name": { "type": "string", "description": "Exact name of the requirement", "nullable": true, "example": "Fenergo Comprehensive Standard Policy Requirements" }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the requirement in specific version. Null versionId will get the latest.", "nullable": true }, "isMandatory": { "type": "boolean", "description": "Mandatory flag of the requirement", "nullable": true, "example": true }, "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Company" }, "isMaterialData": { "type": "boolean", "description": "Materiality flag of the requirement", "nullable": true, "example": true }, "isSensitiveData": { "type": "boolean", "description": "Sensitive data flag of the 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": "Do not filter requirements that have evaluated conditional values by categories" }, "enableBasicDataRequirementsFiltering": { "type": "boolean", "description": "Filter data requirements only by basic properties: Target entity and Entity type" }, "disableDeduplication": { "type": "boolean", "description": "Disable Requirements deduplication based on data key", "example": true } }, "additionalProperties": false, "description": "Request DTO representing requirements search filter" }, "RequirementsInScopeRequestV2DtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementsInScopeRequestV2Dto" } ], "description": "Request DTO representing requirements search filter", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "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" }, "description": "Generic properties setup in policy for review and approval task", "nullable": true, "example": { "firstName": { "type": "Single", "value": "Tom" }, "dateOfBirth": { "type": "Single", "value": "2021-07-15" }, "address": { "type": "Collection", "dataGroupId": "dfde9f06-040a-4127-b9a0-2c802a6502fc", "collections": { "54a25d24-1a4b-45c6-a5b4-980e5d3a1df5": { "properties": { "country": "Ireland", "city": "Dublin", "street": "Mayor Street" } }, "47010265-3b85-4407-be61-90d04525f020": { "properties": { "country": "Ireland", "city": "Dublin", "street": "E Wall Rd" } } } } } }, "approvalOutcome": { "type": "string", "description": "The Approval Outcome of the task", "nullable": true }, "approvalReason": { "type": "string", "description": "The Reason of the approval decision.", "nullable": true }, "taskId": { "type": "string", "description": "Task Id", "nullable": true }, "taskDataKey": { "type": "string", "description": "Task Data Key", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityAssessmentDto": { "type": "object", "properties": { "mainEntity": { "type": "boolean", "description": "Whether this assessment is for the main entity (true) or a related party (false)." }, "materialityOutcome": { "type": "string", "description": "Overall materiality outcome of the screening assessment (e.g. \"Material\", \"Non-Material\").", "nullable": true }, "pepMaterialityStatus": { "type": "string", "description": "PEP (Politically Exposed Person) materiality status.", "nullable": true }, "sanctionsMaterialityStatus": { "type": "string", "description": "Sanctions materiality status.", "nullable": true }, "adverseMediaMaterialityStatus": { "type": "string", "description": "Adverse media materiality status.", "nullable": true }, "enforcementsMaterialityStatus": { "type": "string", "description": "Enforcements materiality status.", "nullable": true }, "otherMaterialityStatus": { "type": "string", "description": "Other (non-categorised) materiality status.", "nullable": true }, "pepJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "PEP jurisdictions associated with this assessment.", "nullable": true }, "sanctionsJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Sanctions jurisdictions associated with this assessment.", "nullable": true }, "adverseMediaJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Adverse media jurisdictions associated with this assessment.", "nullable": true }, "enforcementsJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Enforcements jurisdictions associated with this assessment.", "nullable": true }, "otherJurisdictions": { "type": "array", "items": { "type": "string" }, "description": "Other jurisdictions associated with this assessment.", "nullable": true }, "sanctionsProceedDecision": { "type": "string", "description": "Sanctions ok-to-proceed decision text returned by Screening (e.g. \"Ok to proceed\", \"Not to proceed\").", "nullable": true } }, "additionalProperties": false }, "ScreeningMaterialityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assessments": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningMaterialityAssessmentDto" }, "nullable": true } }, "additionalProperties": false, "description": "Data source for Screening Materiality Assessment outcomes.\nContains a list of assessments — one per entity in the batch (main entity and related parties)." }, "SearchRequirementsDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Exact name of the requirement", "nullable": true, "example": "Fenergo Comprehensive Standard Policy Requirements" }, "type": { "type": "string", "description": "Type of requirement", "nullable": true, "example": "Data" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the requirement in specific version. Null versionId will get the latest.", "nullable": true }, "category": { "type": "array", "items": { "type": "string" }, "description": "List of 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 requirement", "nullable": true, "example": true }, "isSensitiveData": { "type": "boolean", "description": "Sensitive data flag of the requirement", "nullable": true, "example": true }, "isMaterialData": { "type": "boolean", "description": "Materiality flag of the 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 requirements search filter" }, "SearchRequirementsDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SearchRequirementsDto" } ], "description": "Request DTO representing requirements search filter", "nullable": true } }, "additionalProperties": false, "description": "Service request data" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "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 }, "SpecialCharactersRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "description": "Array of special characters, which will be ignored by validation e.g. [\"!\",\"@\",\"#\"]", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing special characters rule metadata" }, "SpecialCharactersRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "excludedCharacters": { "type": "array", "items": { "type": "string" }, "description": "Array of special characters, which will be ignored by validation e.g. [\"!\",\"@\",\"#\"]", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing special characters rule metadata" }, "SpecialCharactersRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false }, "StringListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "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 }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRule" } ], "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 } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto2" } ], "description": "Special characters validation rule - does not allow special characters,\nbut allows define array of characters which can be ignored by the validation", "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow numbers", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto2" } ], "description": "Validation rule that validates the value against provided regex", "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set minimum and maximum count of characters", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set number range", "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow future dates", "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Validation rule that does not allow past dates", "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto2" } ], "description": "Validation rule that allows to set date range", "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto2" } ], "description": "Validation rule that allows to set selection range", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true }, "externalProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "description": "Validation rule that allows to use external provider for validation", "nullable": true }, "externalDataGroupProvider": { "allOf": [ { "$ref": "#/components/schemas/ExternalProviderRuleDto2" } ], "description": "Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection", "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" }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "linkedParentFieldPropertyName": { "type": "string", "nullable": true }, "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 } }, "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\n\"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\n\"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": "Request DTO representing validation data metadata", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation rule metadata" }, "ValidationRuleListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationRule" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "description": "Value of DataSource used to filter field values", "nullable": true }, "field": { "type": "string", "description": "Field value used to validate conditional value", "nullable": true } }, "additionalProperties": false }, "ValueLimitRule": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minValue": { "type": "integer", "description": "Minimum value", "format": "int32", "nullable": true, "example": 1 }, "maxValue": { "type": "integer", "description": "Maximum value", "format": "int32", "nullable": true, "example": 10 } }, "additionalProperties": false, "description": "Request DTO representing value limit rule metadata" }, "ValueLimitRuleDto2": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minValue": { "type": "integer", "description": "Minimum value", "format": "int32", "nullable": true, "example": 1 }, "maxValue": { "type": "integer", "description": "Maximum value", "format": "int32", "nullable": true, "example": 10 } }, "additionalProperties": false, "description": "Request DTO representing value limit rule metadata" }, "ValueLimitRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true }, "dynamicRules": { "type": "array", "items": { "$ref": "#/components/schemas/ValueLimitRuleDtoConditionalValueDto" }, "description": "Conditional validation rules", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDtoConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Request DTO representing value limit rule metadata", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "ValueLimitRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "staticRule": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Static validation rule always applied when active", "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": [ ] } ] }