{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Risk Query", "description": "**Risk Query API**:


Risk Query API provides endpoints in order to retrieve all configured risk related models and their versions, as well as to perform risk assessment calculations.


**Risk Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/riskquery" } ], "paths": { "/api/risk-assessment": { "post": { "tags": [ "RiskAssessment" ], "summary": "Generate a new Risk Assessment", "description": "\nThis method will calculate the risk and generate a risk assessment based \r\n on the options and data defined in the request DTO.

Required permissions:
Following permissions are required: RiskCalculatorAccess", "operationId": "RiskAssessment", "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": "The Fenergo.Nebula.Risk.Query.Application.Dto.RiskAssessmentDto model defining the risk data for the assessment", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/EntityRiskAssessmentServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EntityRiskAssessmentServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EntityRiskAssessmentServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/risk-assessment/{taskId}": { "get": { "tags": [ "RiskAssessment" ], "summary": "Get Risk Assessment by task id", "description": "\nThis method will retrieve risk assessment by assigned task id .

Required permissions:
Following permissions are required: RiskCalculatorAccess", "operationId": "GetRiskAssessmentByTaskId", "parameters": [ { "name": "taskId", "in": "path", "description": "Id of the task for returning risk assessment", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/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/risk-assessment/taskResults": { "post": { "tags": [ "RiskAssessment" ], "summary": "Get multiple Risk Assessments", "description": "\nThis method will retrieve risk assessments for provided taskIds

Required permissions:
Following permissions are required: RiskCalculatorAccess", "operationId": "GetRiskAssessments", "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": "The Fenergo.Nebula.Risk.Query.Application.Dto.RiskAssessmentsRequest consist the collection of taskIds that we want to fetch risk assessements for", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentsRequestServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentsRequestServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentsRequestServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/risk-assessment/related-parties/{taskId}": { "post": { "tags": [ "RiskAssessment" ], "summary": "Get Risk Assessments for Related Parties by task id and entity ids", "description": "\nThis method will retrieve risk assessments for related parties based on the given task id and entity ids.

Required permissions:
Following permissions are required: RiskCalculatorAccess", "operationId": "GetRiskAssessmentsForRelatedParties", "parameters": [ { "name": "taskId", "in": "path", "description": "Id of the task for returning related parties risk assessments", "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" } ], "requestBody": { "description": "Ids of the entity for returning related party risk assessment", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelListDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelListDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelListDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/risk-assessment/related-parties/{taskId}/entity/{entityId}": { "get": { "tags": [ "RiskAssessment" ], "summary": "Get Risk Assessment for Related Party by task id and entity id", "description": "\nThis method will retrieve a specific risk assessment for a related party based on the given task id and entity id.

Required permissions:
Following permissions are required: RiskCalculatorAccess", "operationId": "GetRiskAssessmentDetailsForRelatedParty", "parameters": [ { "name": "taskId", "in": "path", "description": "Id of the task for returning related party risk assessment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "entityId", "in": "path", "description": "Id of the entity for returning related party risk assessment", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/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/risk-calculator-options": { "get": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Get all Risk Calculator Option Models", "description": "\nThis method returns all risk calculator options for the given tenant.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetAllRiskCalculatorOptionModels", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } }, "post": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Get the Risk Calculator Options for a given Scope", "description": "\nThis method will query which risk calculator options are a match for the given\r\n scope parameters, and return a list of all options that match, including those that\r\n are flagged as Always Return.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "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": "The Fenergo.Nebula.Risk.Query.Application.Dto.ScopingQueryDto to search options by", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScopingQueryDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScopingQueryDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ScopingQueryDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OptionsInScopeServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OptionsInScopeServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OptionsInScopeServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "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" } ] } } } }, "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/risk-calculator-options/{id}": { "get": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Get an existing Risk Calculator Option model", "description": "\nThis method returns the risk calculator option model data for a given model id.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetRiskCalculatorOptionModelById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No model was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/risk-configuration": { "get": { "tags": [ "RiskConfiguration" ], "summary": "Get all RiskConfiguration models", "description": "\nThis method returns all risk configuration models for the given tenant.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetAllRiskConfigurationModels", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/risk-configuration/{id}": { "get": { "tags": [ "RiskConfiguration" ], "summary": "Get the active version of an existing RiskConfiguration model", "description": "\nThis method returns the active, currently in effect, published version for a given risk configuration model.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetRiskConfigurationModelById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No active version was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/risk-configuration/{id}/version/{versionNumber}": { "get": { "tags": [ "RiskConfiguration" ], "summary": "Get the specified version of an existing RiskConfiguration model", "description": "\nThis method returns the, specified by number, version for a given risk configuration model.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetRiskConfigurationModelByVersionNumber", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Model Id is invalid", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/risk-configuration/configuration-collection/{id}": { "get": { "tags": [ "RiskConfiguration" ], "summary": "Get the specified risk configuration collection", "description": "\nThis method returns the, specified by id, risk configuration collection data.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetRiskConfigurationCollectionById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the collection to get", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Specified collection was 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/risk-configuration/configuration-collection/{id}/configuration-item/{itemName}": { "get": { "tags": [ "RiskConfiguration" ], "summary": "Get the specified item of a risk configuration collection", "description": "\nThis method returns the specified collection item of the given risk configuration collection.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetRiskConfigurationItemFromCollectionByItemName", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the collection the item belongs to", "required": true, "schema": { "type": "string" } }, { "name": "itemName", "in": "path", "description": "The name of the item to get", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationItemServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationItemServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationItemServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Specified collection or item was 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/risk-export": { "post": { "tags": [ "RiskExport" ], "description": "

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "RiskConfigurationExport", "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": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskExportRequestDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskExportRequestDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskExportRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationExportDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationExportDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationExportDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "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" } ] } } } }, "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/risk-model": { "get": { "tags": [ "RiskModel" ], "summary": "Get all Risk Models", "description": "\nThis method returns all risk models for the given tenant.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetAllRiskModels", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/risk-model/{id}": { "get": { "tags": [ "RiskModel" ], "summary": "Get the active version of an existing Risk model", "description": "\nThis method returns the active, currently in effect, published version for a given risk model.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetRiskModelById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No active version was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/risk-model/{id}/version/{versionNumber}": { "get": { "tags": [ "RiskModel" ], "summary": "Get the specified version of an existing Risk model", "description": "\nThis method returns the, specified by number, version for a given risk model.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetRiskModelByVersionNumber", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelVersionDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Model Id is invalid", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get all scoping rule sets", "description": "\nReturns the list of all scoping rule sets.

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetAllScopingRuleSetsLite", "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 lite scoping rule sets is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/scoping-rule-set/{scopingRuleSetId}": { "get": { "tags": [ "ScopingRuleSet" ], "summary": "Get the current scoping rule set version by scopingRuleSetId", "description": "\nReturns the active, currently in effect, published version of scoping rule set for a given rule set id.

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

Required permissions:
Following permissions are required: RiskConfigurationAccess", "operationId": "GetScopingRuleSetVersionByRuleSetIdAndVersionNumber", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Scoping rule set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Scoping rule set is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Scoping rule set with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/threshold-model": { "get": { "tags": [ "ThresholdModel" ], "summary": "Get all Threshold models", "description": "\nThis method returns all threshold models for the given tenant.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetAllThresholdModels", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/threshold-model/{id}": { "get": { "tags": [ "ThresholdModel" ], "summary": "Get the active version of an existing Threshold model", "description": "\nThis method returns the active, currently in effect, published version for a given threshold model.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetThresholdModelById", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } } } }, "400": { "description": "Model Id is invalid", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "No active version was found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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/threshold-model/{id}/version/{versionNumber}": { "get": { "tags": [ "ThresholdModel" ], "summary": "Get the specified version of an existing Threshold model", "description": "\nThis method returns the, specified by number, version for a given threshold model.

Required permissions:
At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess", "operationId": "GetThresholdModelByVersionNumber", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "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": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelVersionDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Model Id is invalid", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "An exception occurred while processing the command" }, "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" } ] } } } }, "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": { "AggregateRiskAssessment": { "type": "object", "properties": { "entityRiskRating": { "type": "number", "format": "double" }, "entityRiskCategory": { "type": "string", "nullable": true }, "entityRiskThresholdColor": { "type": "string", "nullable": true }, "riskFactorGroupAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupRiskAssessment" }, "nullable": true }, "riskModelName": { "type": "string", "nullable": true }, "riskModelVersion": { "type": "integer", "format": "int32", "nullable": true }, "riskConfigurationModelName": { "type": "string", "nullable": true }, "riskConfigurationModelVersion": { "type": "integer", "format": "int32", "nullable": true }, "thresholdModelName": { "type": "string", "nullable": true }, "thresholdModelVersion": { "type": "integer", "format": "int32", "nullable": true }, "aggregateId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AggregateRiskAssessmentError": { "type": "object", "properties": { "riskModelId": { "type": "string", "nullable": true }, "riskModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "riskConfigurationModelId": { "type": "string", "nullable": true }, "riskConfigurationModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "thresholdModelId": { "type": "string", "nullable": true }, "thresholdModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true }, "aggregateId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AggregateRiskAssessmentErrorViewModelDto": { "type": "object", "properties": { "aggregateId": { "type": "string", "description": "Unique identifier of the aggregate", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "riskModelId": { "type": "string", "description": "Unique identifier of the risk model", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskModelVersionNumber": { "type": "integer", "description": "Version number of the risk model", "format": "int32", "nullable": true, "example": 1 }, "riskConfigurationModelId": { "type": "string", "description": "Unique identifier of the risk configuration model", "nullable": true, "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "riskConfigurationModelVersionNumber": { "type": "integer", "description": "Version number of the risk configuration model", "format": "int32", "nullable": true, "example": 2 }, "thresholdModelId": { "type": "string", "description": "Unique identifier of the threshold model", "nullable": true, "example": "a8e4a96e-696a-4d04-89e9-faa74738fc43" }, "thresholdModelVersionNumber": { "type": "integer", "description": "Version number of the threshold model", "format": "int32", "nullable": true, "example": 1 }, "message": { "type": "string", "description": "Error message describing the assessment failure", "nullable": true, "example": "Unable to calculate risk due to missing data" } }, "additionalProperties": false, "description": "Represents an aggregate risk assessment error" }, "AggregateRiskAssessmentViewModelDto": { "type": "object", "properties": { "aggregateId": { "type": "string", "description": "Unique identifier of the aggregate", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityRiskRating": { "type": "number", "description": "The overall risk rating for the entity", "format": "double", "example": 2.5 }, "entityRiskCategory": { "type": "string", "description": "The risk category for the entity", "nullable": true, "example": "Medium" }, "entityRiskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes.", "nullable": true, "example": "#FF0000" }, "riskFactorGroupAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupRiskAssessmentViewModelDto" }, "description": "List of risk factor group assessments", "nullable": true }, "riskModelName": { "type": "string", "description": "Name of the risk model used", "nullable": true, "example": "Global Risk Model" }, "riskModelVersion": { "type": "integer", "description": "Version of the risk model used", "format": "int32", "nullable": true, "example": 1 }, "riskConfigurationModelName": { "type": "string", "description": "Name of the risk configuration model used", "nullable": true, "example": "Global Configuration Model" }, "riskConfigurationModelVersion": { "type": "integer", "description": "Version of the risk configuration model used", "format": "int32", "nullable": true, "example": 2 }, "thresholdModelName": { "type": "string", "description": "Name of the threshold model used", "nullable": true, "example": "Global Threshold Model" }, "thresholdModelVersion": { "type": "integer", "description": "Version of the threshold model used", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Represents an aggregate risk assessment" }, "AggregateTaskResultLink": { "type": "object", "properties": { "riskTaskId": { "type": "string", "format": "uuid" }, "aggregateId": { "type": "string", "format": "uuid" }, "referenceAggregateId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AggregateTaskResultLinkViewModelDto": { "type": "object", "properties": { "riskTaskId": { "type": "string", "description": "Unique identifier of the risk task", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "aggregateId": { "type": "string", "description": "Unique identifier of the aggregate", "format": "uuid", "example": "80e92251-db0c-47e0-8e50-490d4bd1db6e" }, "referenceAggregateId": { "type": "string", "description": "Unique identifier of the reference aggregate", "format": "uuid", "example": "90f82251-db0c-47e0-8e50-490d4bd1db7f" } }, "additionalProperties": false, "description": "Represents a link to a reused aggregate task result" }, "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 }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "EntityRiskAssessment": { "type": "object", "properties": { "entityRiskRating": { "type": "number", "format": "double" }, "entityRiskCategory": { "type": "string", "nullable": true }, "entityRiskThresholdColor": { "type": "string", "nullable": true }, "riskFactorGroupAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupRiskAssessment" }, "nullable": true }, "riskModelName": { "type": "string", "nullable": true }, "riskModelVersion": { "type": "integer", "format": "int32", "nullable": true }, "riskConfigurationModelName": { "type": "string", "nullable": true }, "riskConfigurationModelVersion": { "type": "integer", "format": "int32", "nullable": true }, "thresholdModelName": { "type": "string", "nullable": true }, "thresholdModelVersion": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "EntityRiskAssessmentServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskAssessment" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EntityRiskAssessmentViewModelDto": { "type": "object", "properties": { "entityRiskRating": { "type": "number", "description": "The overall risk rating for the entity", "format": "double", "example": 2.5 }, "entityRiskCategory": { "type": "string", "description": "The risk category for the entity", "nullable": true, "example": "Medium" }, "entityRiskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes.", "nullable": true, "example": "#FF0000" }, "riskFactorGroupAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupRiskAssessmentViewModelDto" }, "description": "List of risk factor group assessments", "nullable": true }, "riskModelName": { "type": "string", "description": "Name of the risk model used", "nullable": true, "example": "Global Risk Model" }, "riskModelVersion": { "type": "integer", "description": "Version of the risk model used", "format": "int32", "nullable": true, "example": 1 }, "riskConfigurationModelName": { "type": "string", "description": "Name of the risk configuration model used", "nullable": true, "example": "Global Configuration Model" }, "riskConfigurationModelVersion": { "type": "integer", "description": "Version of the risk configuration model used", "format": "int32", "nullable": true, "example": 2 }, "thresholdModelName": { "type": "string", "description": "Name of the threshold model used", "nullable": true, "example": "Global Threshold Model" }, "thresholdModelVersion": { "type": "integer", "description": "Version of the threshold model used", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Represents entity risk assessment data" }, "ExcludedAggregateAssessment": { "type": "object", "properties": { "aggregateId": { "type": "string", "format": "uuid" }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetRiskRelatedPartiesResultRequestDto": { "type": "object", "properties": { "entityIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "GetRiskRelatedPartiesResultRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRiskRelatedPartiesResultRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "InputValueRiskAssessment": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "riskCategory": { "type": "string", "nullable": true }, "riskThresholdColor": { "type": "string", "nullable": true }, "riskRating": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "weightedRiskRating": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "InputValueRiskAssessmentViewModelDto": { "type": "object", "properties": { "value": { "type": "string", "description": "The input value", "nullable": true, "example": "750" }, "riskCategory": { "type": "string", "description": "Risk category for the input value", "nullable": true, "example": "Low" }, "riskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes", "nullable": true, "example": "#FF0000" }, "riskRating": { "type": "number", "description": "Risk rating for the input value", "format": "double", "nullable": true, "example": 1 }, "weight": { "type": "number", "description": "Weight of the input value", "format": "double", "nullable": true, "example": 1 }, "weightedRiskRating": { "type": "number", "description": "Weighted risk rating for the input value", "format": "double", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Represents an input value risk assessment" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "OptionsInScope": { "type": "object", "properties": { "modelsInScope": { "type": "array", "items": { "$ref": "#/components/schemas/RiskCalculatorOption" }, "nullable": true } }, "additionalProperties": false }, "OptionsInScopeServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/OptionsInScope" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "OverrideScoresDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the factor to override", "nullable": true, "example": "Product Type" }, "score": { "type": "number", "description": "The score that the calculated risk level should be overwritten with", "format": "double", "example": 5.04 } }, "additionalProperties": false, "description": "Risk factor override data" }, "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": { } }, "RiskAssessmentDto": { "required": [ "riskConfigurationModelId", "riskModelId", "thresholdModelId" ], "type": "object", "properties": { "riskModelId": { "type": "string", "description": "The UiD of the selected risk model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskModelVersionNumber": { "type": "integer", "description": "The version number of the RiskModel to use (optional)", "format": "int32", "nullable": true, "example": 1 }, "thresholdModelId": { "type": "string", "description": "The UiD of the selected threshold model", "format": "uuid", "example": "a8e4a96e-696a-4d04-89e9-faa74738fc43" }, "thresholdModelVersionNumber": { "type": "integer", "description": "The version number of the ThresholdModel to use (optional)", "format": "int32", "nullable": true, "example": 4 }, "riskConfigurationModelId": { "type": "string", "description": "The UiD of the selected risk configuration model", "format": "uuid", "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "riskConfigurationModelVersionNumber": { "type": "integer", "description": "The version number of the RiskConfigurationModel to use (optional)", "format": "int32", "nullable": true, "example": 1 }, "inputData": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorValueDto" }, "description": "A list of risk factor values", "nullable": true }, "overrideScores": { "type": "array", "items": { "$ref": "#/components/schemas/OverrideScoresDto" }, "description": "A list of risk factor override scores", "nullable": true }, "riskFactorSelectedAlgorithms": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorSelectedAlgorithmDto" }, "description": "A list of selected risk factor calculation algorithms", "nullable": true } }, "additionalProperties": false, "description": "Risk assessment generation input data" }, "RiskAssessmentDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentDto" } ], "description": "Risk assessment generation input data", "nullable": true } }, "additionalProperties": false }, "RiskAssessmentError": { "type": "object", "properties": { "riskModelId": { "type": "string", "nullable": true }, "riskModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "riskConfigurationModelId": { "type": "string", "nullable": true }, "riskConfigurationModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "thresholdModelId": { "type": "string", "nullable": true }, "thresholdModelVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RiskAssessmentErrorViewModelDto": { "type": "object", "properties": { "riskModelId": { "type": "string", "description": "Unique identifier of the risk model", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskModelVersionNumber": { "type": "integer", "description": "Version number of the risk model", "format": "int32", "nullable": true, "example": 1 }, "riskConfigurationModelId": { "type": "string", "description": "Unique identifier of the risk configuration model", "nullable": true, "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "riskConfigurationModelVersionNumber": { "type": "integer", "description": "Version number of the risk configuration model", "format": "int32", "nullable": true, "example": 2 }, "thresholdModelId": { "type": "string", "description": "Unique identifier of the threshold model", "nullable": true, "example": "a8e4a96e-696a-4d04-89e9-faa74738fc43" }, "thresholdModelVersionNumber": { "type": "integer", "description": "Version number of the threshold model", "format": "int32", "nullable": true, "example": 1 }, "message": { "type": "string", "description": "Error message describing the assessment failure", "nullable": true, "example": "Unable to calculate risk due to missing data" } }, "additionalProperties": false, "description": "Represents a risk assessment error" }, "RiskAssessmentsRequest": { "type": "object", "properties": { "taskIds": { "type": "array", "items": { "type": "string" }, "description": "Collection of task ids which risk assessments are requested", "nullable": true } }, "additionalProperties": false, "description": "Risk assessments request" }, "RiskAssessmentsRequestServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentsRequest" } ], "description": "Risk assessments request", "nullable": true } }, "additionalProperties": false }, "RiskCalculatorOption": { "type": "object", "properties": { "riskModelId": { "type": "string", "format": "uuid" }, "configurationModelId": { "type": "string", "format": "uuid" }, "thresholdModelId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "RiskCalculatorOptionModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "name": { "type": "string", "nullable": true }, "alwaysReturnModel": { "type": "boolean" }, "riskCalculatorOptions": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOption" } ], "nullable": true }, "scopeParameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RiskCalculatorOptionModelIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RiskCalculatorOptionModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskCalculatorOptionModelServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModel" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationCollection": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentRiskConfigurationId": { "type": "string", "format": "uuid" }, "parentVersionNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "collectionType": { "type": "string", "nullable": true }, "configurationItems": { "type": "array", "items": { "$ref": "#/components/schemas/RiskConfigurationItem" }, "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/Threshold" }, "nullable": true }, "hasCustomThresholds": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "RiskConfigurationCollectionServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollection" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationExportDto": { "type": "object", "properties": { "signedUrl": { "type": "string", "nullable": true }, "validUntil": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RiskConfigurationExportDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationExportDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "riskLevel": { "type": "number", "format": "double" }, "minRangeValue": { "type": "number", "format": "double" }, "maxRangeValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "RiskConfigurationItemServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationItem" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the risk configuration model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/RiskConfigurationModelVersionDto" }, "description": "A list of the model versions metadata and calculated properties", "nullable": true } }, "additionalProperties": false, "description": "RiskConfiguration model with all version metadata" }, "RiskConfigurationModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RiskConfigurationModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationModelVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "parentRiskConfigurationModelId": { "type": "string", "description": "The UiD of the risk configuration model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "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" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "name": { "type": "string", "description": "Display name of the model", "nullable": true, "example": "Global Configuration Model" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "riskConfigurationCollections": { "type": "array", "items": { "$ref": "#/components/schemas/RiskConfigurationCollection" }, "description": "The list of risk configuration collections that belong to the version", "nullable": true }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\r\nat the time of the query", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "RiskConfiguration model version data" }, "RiskConfigurationModelVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelVersionDto" } ], "description": "RiskConfiguration model version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskExportRequestDto": { "required": [ "riskConfigurationModelId", "riskModelId", "thresholdModelId" ], "type": "object", "properties": { "riskModelId": { "type": "string", "description": "The UiD of the selected risk model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskModelVersionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The version number of the RiskModel to use", "format": "int32", "example": 1 }, "thresholdModelId": { "type": "string", "description": "The UiD of the selected threshold model", "format": "uuid", "example": "a8e4a96e-696a-4d04-89e9-faa74738fc43" }, "thresholdModelVersionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The version number of the ThresholdModel to use", "format": "int32", "example": 4 }, "riskConfigurationModelId": { "type": "string", "description": "The UiD of the selected risk configuration model", "format": "uuid", "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "riskConfigurationModelVersionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The version number of the RiskConfigurationModel to use", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Risk assessment generation input data" }, "RiskExportRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskExportRequestDto" } ], "description": "Risk assessment generation input data", "nullable": true } }, "additionalProperties": false }, "RiskFactor": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "overrideScore": { "type": "number", "format": "double", "nullable": true }, "isMandatory": { "type": "boolean" }, "selectedRiskLevel": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "selectedRiskValue": { "type": "string", "nullable": true, "readOnly": true }, "riskLevelCalculationAlgorithm": { "type": "string", "nullable": true }, "inputValues": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorInputValue" }, "nullable": true } }, "additionalProperties": false }, "RiskFactorGroup": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "riskLevelCalculationAlgorithm": { "type": "string", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "riskFactors": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactor" }, "nullable": true }, "childRiskFactorGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroup" }, "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/Threshold" }, "nullable": true } }, "additionalProperties": false }, "RiskFactorGroupRiskAssessment": { "type": "object", "properties": { "riskFactorGroupName": { "type": "string", "nullable": true }, "riskRating": { "type": "number", "format": "double", "nullable": true }, "riskCategory": { "type": "string", "nullable": true }, "riskThresholdColor": { "type": "string", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "weightedRiskRating": { "type": "number", "format": "double", "nullable": true }, "calculationAlgorithm": { "type": "string", "nullable": true }, "calculatedRiskFactorName": { "type": "string", "nullable": true }, "riskFactorAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorRiskAssessment" }, "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/Threshold" }, "nullable": true } }, "additionalProperties": false }, "RiskFactorGroupRiskAssessmentViewModelDto": { "type": "object", "properties": { "riskFactorGroupName": { "type": "string", "description": "Name of the risk factor group", "nullable": true, "example": "Financial Risk" }, "riskRating": { "type": "number", "description": "Risk rating for the group", "format": "double", "nullable": true, "example": 3 }, "riskCategory": { "type": "string", "description": "Risk category for the group", "nullable": true, "example": "High" }, "riskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes", "nullable": true, "example": "#FF0000" }, "weight": { "type": "number", "description": "Weight of the risk factor group", "format": "double", "nullable": true, "example": 0.5 }, "weightedRiskRating": { "type": "number", "description": "Weighted risk rating for the group", "format": "double", "nullable": true, "example": 1.5 }, "calculationAlgorithm": { "type": "string", "description": "Algorithm used for calculation", "nullable": true, "example": "Average" }, "calculatedRiskFactorName": { "type": "string", "description": "Name of the calculated risk factor", "nullable": true, "example": "Calculated Financial Risk" }, "riskFactorAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorRiskAssessmentViewModelDto" }, "description": "List of individual risk factor assessments", "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/ThresholdViewModelDto" }, "description": "Thresholds used for this risk factor group assessment", "nullable": true } }, "additionalProperties": false, "description": "Represents a risk factor group assessment" }, "RiskFactorInputValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true, "readOnly": true }, "weight": { "type": "number", "format": "double", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "RiskFactorRiskAssessment": { "type": "object", "properties": { "riskFactorName": { "type": "string", "nullable": true }, "riskCategory": { "type": "string", "nullable": true }, "riskThresholdColor": { "type": "string", "nullable": true }, "riskRating": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "weightedRiskRating": { "type": "number", "format": "double", "nullable": true }, "overrideScore": { "type": "number", "format": "double", "nullable": true }, "calculatedInputValueValue": { "type": "string", "nullable": true }, "riskLevelCalculationAlgorithm": { "type": "string", "nullable": true }, "inputValueAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/InputValueRiskAssessment" }, "nullable": true } }, "additionalProperties": false }, "RiskFactorRiskAssessmentViewModelDto": { "type": "object", "properties": { "riskFactorName": { "type": "string", "description": "Name of the risk factor", "nullable": true, "example": "Credit Score" }, "riskCategory": { "type": "string", "description": "Risk category for the factor", "nullable": true, "example": "Low" }, "riskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes.", "nullable": true, "example": "#FF0000" }, "riskRating": { "type": "number", "description": "Risk rating for the factor", "format": "double", "nullable": true, "example": 1 }, "weight": { "type": "number", "description": "Weight of the risk factor", "format": "double", "nullable": true, "example": 0.3 }, "weightedRiskRating": { "type": "number", "description": "Weighted risk rating for the factor", "format": "double", "nullable": true, "example": 0.3 }, "overrideScore": { "type": "number", "description": "Manual override score", "format": "double", "nullable": true, "example": 2 }, "calculatedInputValueValue": { "type": "string", "description": "Calculated input value", "nullable": true, "example": "750" }, "riskLevelCalculationAlgorithm": { "type": "string", "description": "Algorithm used for risk level calculation", "nullable": true, "example": "Weighted Average" }, "inputValueAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/InputValueRiskAssessmentViewModelDto" }, "description": "List of input value assessments", "nullable": true } }, "additionalProperties": false, "description": "Represents an individual risk factor assessment" }, "RiskFactorSelectedAlgorithmDto": { "type": "object", "properties": { "factorName": { "type": "string", "description": "Display name of the risk factor", "nullable": true, "example": "Product Type" }, "riskLevelCalculationAlgorithm": { "type": "string", "description": "The selected algorithm to use (min, max, avg, sum)", "nullable": true, "example": "avg" } }, "additionalProperties": false, "description": "The algorithm to use, for risk level calculation, \r\nwhen a risk factor has multiple input values" }, "RiskFactorValueDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the risk factor", "nullable": true, "example": "Product Type" }, "value": { "type": "string", "description": "Value of the risk factor", "nullable": true, "example": "Loan" }, "weight": { "type": "number", "description": "The risk level calculation weight of the factor", "format": "double", "nullable": true, "example": 1.2 } }, "additionalProperties": false, "description": "Risk factor value" }, "RiskModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the risk model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelVersionDto" }, "description": "A list of the model versions metadata and calculated properties", "nullable": true } }, "additionalProperties": false, "description": "RiskModel with all version metadata" }, "RiskModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RiskModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskModelVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "parentRiskModelId": { "type": "string", "description": "The UiD of the risk model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 2 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Rejected" }, "name": { "type": "string", "description": "Display name of the model", "nullable": true, "example": "Global Risk Model" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "riskFactorGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroup" }, "description": "The list of risk factor groups that belong to the version", "nullable": true }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\r\nat the time of the query", "example": false }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "RiskModel version data" }, "RiskModelVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskModelVersionDto" } ], "description": "RiskModel version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskTaskResultModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid", "nullable": true }, "entityRiskAssessmentData": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskAssessment" } ], "nullable": true }, "failedAssessmentData": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentError" } ], "nullable": true }, "aggregateRiskAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateRiskAssessment" }, "nullable": true }, "failedAggregateAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateRiskAssessmentError" }, "nullable": true }, "reusedAggregateTaskResults": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateTaskResultLink" }, "nullable": true }, "excludedAggregateAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/ExcludedAggregateAssessment" }, "nullable": true }, "runId": { "type": "string", "nullable": true }, "runStartedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "RiskTaskResultModelIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RiskTaskResultModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskTaskResultModelItemDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Unique identifier of the entity being assessed", "format": "uuid", "example": "80e92251-db0c-47e0-8e50-490d4bd1db6e" }, "riskRating": { "type": "number", "description": "Risk rating of assessed entity", "format": "double", "nullable": true, "example": 1 }, "riskCategory": { "type": "string", "description": "Risk category of assessed entity", "nullable": true, "example": "Low" }, "riskThresholdColor": { "type": "string", "description": "Optional hex color code for UI visualization purposes", "nullable": true, "example": "#FF0000" } }, "additionalProperties": false, "description": "Represents the overview of a risk task assessment" }, "RiskTaskResultModelListDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RiskTaskResultModelItemDto" }, "description": "Collection of risk assessment overviews for related parties", "nullable": true } }, "additionalProperties": false, "description": "Container for multiple risk assessment overviews for related parties" }, "RiskTaskResultModelListDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskTaskResultModelListDto" } ], "description": "Container for multiple risk assessment overviews for related parties", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskTaskResultModelServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskTaskResultModel" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskTaskResultModelViewModelDto": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Unique identifier of the task", "format": "uuid", "example": "0e5a0bae-bd18-474f-8da7-0afcb3eb987b" }, "entityId": { "type": "string", "description": "Unique identifier of the entity being assessed", "format": "uuid", "nullable": true, "example": "80e92251-db0c-47e0-8e50-490d4bd1db6e" }, "entityRiskAssessmentData": { "allOf": [ { "$ref": "#/components/schemas/EntityRiskAssessmentViewModelDto" } ], "description": "The risk assessment data for the entity", "nullable": true }, "failedAssessmentData": { "allOf": [ { "$ref": "#/components/schemas/RiskAssessmentErrorViewModelDto" } ], "description": "Error data if the assessment failed", "nullable": true }, "aggregateRiskAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateRiskAssessmentViewModelDto" }, "description": "List of aggregate risk assessments", "nullable": true }, "failedAggregateAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateRiskAssessmentErrorViewModelDto" }, "description": "List of failed aggregate assessment errors", "nullable": true }, "reusedAggregateTaskResults": { "type": "array", "items": { "$ref": "#/components/schemas/AggregateTaskResultLinkViewModelDto" }, "description": "List of reused aggregate task result links", "nullable": true } }, "additionalProperties": false, "description": "Represents the result of a risk task assessment" }, "RiskTaskResultModelViewModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskTaskResultModelViewModelDto" } ], "description": "Represents the result of a risk task assessment", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ScopingQueryDto": { "type": "object", "properties": { "scopingQuery": { "type": "array", "items": { "$ref": "#/components/schemas/ScopingQueryParametersDto" }, "description": "The list of risk calculator option scope parameters to query by", "nullable": true } }, "additionalProperties": false, "description": "A risk calculator option query by scope parameters" }, "ScopingQueryDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScopingQueryDto" } ], "description": "A risk calculator option query by scope parameters", "nullable": true } }, "additionalProperties": false }, "ScopingQueryParametersDto": { "type": "object", "properties": { "queryParameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "A set of risk calculator option scope parameters", "nullable": true, "example": { "ProductType": "HomeLoan", "Country": "Ireland" } } }, "additionalProperties": false, "description": "The risk calculator option scope parameters to query by" }, "ScopingRuleSetLiteDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the scoping rule set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Scoping rule set name", "example": "Global" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ScopingRuleSetLiteVersionDto" }, "description": "Versions associated to the scoping rule set", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Represents a lite version of a Scoping Rule Set" }, "ScopingRuleSetLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScopingRuleSetLiteDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ScopingRuleSetLiteVersionDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the scoping rule set version", "format": "uuid", "example": "228313c6-91e6-4b05-a537-5a1ab906418f" }, "scopingRuleSetId": { "type": "string", "description": "The UiD of the scoping rule set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of scoping rule set", "example": "Global Scoping Rules" }, "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, "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\r\nat the time of the query (not necessarily published)", "example": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Represents a lite version of a Scoping Rule Set version" }, "ScopingRuleSetVersionDto": { "required": [ "name", "signees" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the scoping rule set version", "format": "uuid", "example": "228313c6-91e6-4b05-a537-5a1ab906418f" }, "scopingRuleSetId": { "type": "string", "description": "The UiD of the scoping rule set that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of scoping rule set", "example": "Global Scoping Rules" }, "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, "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\r\nat the time of the query (not necessarily published)", "example": true }, "version": { "type": "integer", "description": "Version number for given Aggregate (concurrency check)", "format": "int32", "nullable": true, "example": 1 }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/SigneeDto" }, "description": "The defined list of signees for the version" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the schema can be used", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing scoping rule set version data" }, "ScopingRuleSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScopingRuleSetVersionDto" } ], "description": "Response DTO representing scoping rule set version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SigneeDto": { "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, "description": "Defines a version Signee" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "Threshold": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "minimumValue": { "type": "number", "format": "double", "nullable": true }, "maximumValue": { "type": "number", "format": "double", "nullable": true }, "nextReviewPeriod": { "type": "integer", "format": "int32", "nullable": true }, "thresholdColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ThresholdModelDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the threshold model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ThresholdModelVersionDto" }, "description": "A list of the model versions metadata and calculated properties", "nullable": true } }, "additionalProperties": false, "description": "ThresholdModel with all version metadata" }, "ThresholdModelDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ThresholdModelDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ThresholdModelVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "baee4b61-7ebb-48b2-a44b-18ce814b703b" }, "parentThresholdModelId": { "type": "string", "description": "The UiD of the threshold model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 2 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "name": { "type": "string", "description": "Display name of the model", "nullable": true, "example": "Standard Threshold Model" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/Threshold" }, "description": "The list of thresholds that belong to the version", "nullable": true }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\r\nat the time of the query", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "type": "string", "description": "Optional description of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.", "nullable": true, "example": "Example Notes" } }, "additionalProperties": false, "description": "ThresholdModel version data" }, "ThresholdModelVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelVersionDto" } ], "description": "ThresholdModel version data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ThresholdViewModelDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the threshold", "nullable": true, "example": "Low" }, "minimumValue": { "type": "number", "description": "Minimum value of the threshold range", "format": "double", "nullable": true, "example": 1 }, "maximumValue": { "type": "number", "description": "Maximum value of the threshold range", "format": "double", "nullable": true, "example": 1.999 }, "nextReviewPeriod": { "type": "integer", "description": "The period in months for the next review of the client", "format": "int32", "nullable": true, "example": 1 }, "thresholdColor": { "type": "string", "description": "Optional UI color assigned to this threshold range for visualization purposes.\r\nMust be a valid hex value in the form #RRGGBB.", "nullable": true, "example": "#FF0000" } }, "additionalProperties": false, "description": "Represents a threshold used in risk assessment" }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }