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


Risk Command API provides endpoints in order to manage and configure all risk related models and their versions.


**Risk Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/riskcommand" } ], "paths": { "/api/risk-calculator-options": { "post": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Create a new RiskCalculatorOption", "description": "\nThis method will create a new RiskCalculatorOption model.\r\n The new model will initialize with the DTO data.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskCalculatorOptions", "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": "ServiceRequest with the RiskCalculatorOptionModelDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskCalculatorOption model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceResponse" } } } }, "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-calculator-options/{id}": { "put": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Update an existing RiskCalculatorOption", "description": "\nThis method will update an existing RiskCalculatorOption\r\n with the data contained in the request DTO.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateRiskCalculatorOptions", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to update", "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": "ServiceRequest with the updated RiskCalculatorOptionModelDto", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskCalculatorOption model updated successfully" }, "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" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RiskCalculatorOptionModel" ], "summary": "Delete an existing RiskCalculatorOption", "description": "\nThis method will delete an existing RiskCalculatorOption model.

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteRiskCalculatorOptions", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "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": { "202": { "description": "RiskCalculatorOption model deleted successfully" }, "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-configuration": { "post": { "tags": [ "RiskConfiguration" ], "summary": "Create a new RiskConfiguration model", "description": "\nThis method will create a new RiskConfiguration model with a first draft version.\r\n\nThe new version will initialize with the DTO data and have the default status of Draft \r\n and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskConfigurationModel", "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": "ServiceRequest with the RiskConfigurationModelDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } } } }, "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-configuration/{id}": { "post": { "tags": [ "RiskConfiguration" ], "summary": "Create a new Version for an existing RiskConfiguration model", "description": "\nThis method will create a new RiskConfiguration model version.\r\n\nThe new version will initialize with the DTO data. It will be assigned the next available version number, \r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the new version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model version created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } } } }, "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" } } } }, "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" } ] } } } } } }, "put": { "tags": [ "RiskConfiguration" ], "summary": "Update an existing Version of a RiskConfiguration model", "description": "\nThis method will update an existing RiskConfiguration model version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateRiskConfigurationModel", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the updated version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model version updated successfully" }, "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" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RiskConfiguration" ], "summary": "Delete an existing RiskConfiguration model", "description": "\nThis method will delete an existing RiskConfiguration model as well as all its versions.

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteRiskConfigurationModel", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "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": { "202": { "description": "RiskConfiguration model deleted successfully" }, "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-configuration/{id}/version/{versionNumber}/draft": { "post": { "tags": [ "RiskConfiguration" ], "summary": "Create a draft from an existing Version of a RiskConfiguration model", "description": "\nThis method will clone the selected version of an existing RiskConfiguration model\r\n and create a new draft with the next version number.\r\n\nThe new version will contain all the data of the original selected one, \r\n will have the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskConfigurationModelVersionDraft", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "", "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" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "New draft of RiskConfiguration model created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } } } }, "400": { "description": "The Tenant header is missing", "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-configuration/{id}/version/{versionNumber}/clone": { "post": { "tags": [ "RiskConfiguration" ], "summary": "Clone an existing Version of a RiskConfiguration model to a new model", "description": "\nThis method will clone the selected version of an existing RiskConfiguration model\r\n and create a new model with a single version.\r\n\nThe new version will contain all the data of the original selected one, \r\n will have the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CloneRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to clone", "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": { "202": { "description": "RiskConfiguration model cloned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceResponse" } } } }, "400": { "description": "The Tenant header is missing", "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-configuration/{id}/version/{versionNumber}/sign": { "put": { "tags": [ "RiskConfiguration" ], "summary": "Sign an existing Version of a RiskConfiguration model", "description": "\nThis method will Sign the selected version of an existing RiskConfiguration model.\r\n The Status of the version will change according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: RiskConfigurationApprove", "operationId": "SignRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model version signed successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } } } }, "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-configuration/{id}/version/{versionNumber}/archive": { "put": { "tags": [ "RiskConfiguration" ], "summary": "Archive an existing Version of a RiskConfiguration model", "description": "\nThis method will Archive the selected version of an existing RiskConfiguration model.

Required permissions:
Following permissions are required: RiskConfigurationArchive", "operationId": "ArchiveRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.RiskConfigurationModelDto to archive", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model version archived successfully" }, "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" } } } }, "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}/submit": { "put": { "tags": [ "RiskConfiguration" ], "summary": "Submit an existing Version of a RiskConfiguration model for Approval", "description": "\nThis method will submit the selected version of an existing RiskConfiguration model\r\n for Approval.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "SubmitRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.RiskConfigurationModelDto to submit", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfiguration model version submitted successfully" }, "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" } } } }, "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}": { "delete": { "tags": [ "RiskConfiguration" ], "summary": "Delete an existing Version of a RiskConfiguration model", "description": "\nThis method will Delete the selected version of an existing RiskConfiguration model.\r\n If the version is the last one, then the version number of it will become the next available one for the model.\r\n Otherwise, the version number will be flagged as Deleted and become unavailable.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "DeleteRiskConfigurationModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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": { "202": { "description": "RiskConfiguration model version deleted successfully" }, "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-configuration/{riskConfigurationId}/configuration-collection": { "post": { "tags": [ "RiskConfiguration" ], "summary": "Create a new RiskConfigurationCollection", "description": "\nThis method will create a new RiskConfigurationCollection and\r\n add it to the selected version of an existing RiskConfiguration model.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskConfigurationCollection", "parameters": [ { "name": "riskConfigurationId", "in": "path", "description": "The Id of the RiskConfiguration model the collection belongs to", "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": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.RiskConfigurationCollectionDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfigurationCollection created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceResponse" } } } }, "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-configuration/{riskConfigurationId}/configuration-collection/{riskCollectionId}": { "put": { "tags": [ "RiskConfiguration" ], "summary": "Update an existing RiskConfigurationCollection", "description": "\nThis method will update the Items and custom Thresholds of\r\n an existing RiskConfigurationCollection.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateRiskConfigurationCollection", "parameters": [ { "name": "riskCollectionId", "in": "path", "description": "The Id of the existing collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "riskConfigurationId", "in": "path", "description": "The Id of the RiskConfiguration model the collection belongs to", "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": "ServiceRequest with the updated collection data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskConfigurationCollection updated successfully" }, "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" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RiskConfiguration" ], "summary": "Delete an existing RiskConfigurationCollection", "description": "\nThis method will delete an existing RiskConfigurationCollection and\r\n remove it from the selected version of an existing RiskConfiguration model.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "DeleteRiskConfigurationCollection", "parameters": [ { "name": "riskCollectionId", "in": "path", "description": "The Id of the existing collection", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "riskConfigurationId", "in": "path", "description": "The Id of the RiskConfiguration model the collection belongs to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "parentVersionNumber", "in": "query", "description": "The version number of the version the collection belongs to", "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": { "202": { "description": "Accepted" }, "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": { "post": { "tags": [ "RiskModel" ], "summary": "Create a new RiskModel", "description": "\nThis method will create a new RiskModel with a first draft version.\r\n\nThe new version will initialize with the DTO data and have the default status of Draft \r\n and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskModel", "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": "ServiceRequest with the RiskModelDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } } } }, "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-model/{id}": { "post": { "tags": [ "RiskModel" ], "summary": "Create a new Version for an existing RiskModel", "description": "\nThis method will create a new RiskModel version.\r\n\nThe new version will initialize with the DTO data. It will be assigned the next available version number, \r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the new version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel version created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } } } }, "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" } } } }, "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" } ] } } } } } }, "put": { "tags": [ "RiskModel" ], "summary": "Update an existing Version of a RiskModel", "description": "\nThis method will update an existing RiskModel version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the updated version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel version updated successfully" }, "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" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "RiskModel" ], "summary": "Delete an existing RiskModel", "description": "\nThis method will delete an existing RiskModel as well as all its versions.

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteRiskModel", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "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": { "202": { "description": "RiskModel deleted successfully" }, "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-model/{id}/version/{versionNumber}/clone": { "post": { "tags": [ "RiskModel" ], "summary": "Clone an existing Version of a RiskModel to a new model", "description": "\nThis method will clone the selected version of an existing RiskModel\r\n and create a new model with a single version.\r\n\nThe new version will contain all the data of the original selected one, \r\n will have the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CloneRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to clone", "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": { "202": { "description": "RiskModel cloned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskModelDtoServiceResponse" } } } }, "400": { "description": "The Tenant header is missing", "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-model/{id}/version/{versionNumber}/sign": { "put": { "tags": [ "RiskModel" ], "summary": "Sign an existing Version of a RiskModel", "description": "\nThis method will Sign the selected version of an existing RiskModel.\r\n The Status of the version will change according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: RiskConfigurationApprove", "operationId": "SignRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel version signed successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } } } }, "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-model/{id}/version/{versionNumber}/archive": { "put": { "tags": [ "RiskModel" ], "summary": "Archive an existing Version of a RiskModel", "description": "\nThis method will Archive the selected version of an existing RiskModel.

Required permissions:
Following permissions are required: RiskConfigurationArchive", "operationId": "ArchiveRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.RiskModelDto to archive", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel version archived successfully" }, "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" } } } }, "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}/submit": { "put": { "tags": [ "RiskModel" ], "summary": "Submit an existing Version of a RiskModel for Approval", "description": "\nThis method will submit the selected version of an existing RiskModel\r\n for Approval.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "SubmitRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.RiskModelDto to submit", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "RiskModel version submitted successfully" }, "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" } } } }, "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}": { "delete": { "tags": [ "RiskModel" ], "summary": "Delete an existing Version of a RiskModel", "description": "\nThis method will Delete the selected version of an existing RiskModel.\r\n If the version is the last one, then the version number of it will become the next available one for the model.\r\n Otherwise, the version number will be flagged as Deleted and become unavailable.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "DeleteRiskModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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": { "202": { "description": "RiskModel version deleted successfully" }, "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/scoping-rule-set": { "post": { "tags": [ "ScopingRuleSet" ], "summary": "Create scoping rule set", "description": "

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateScopingRuleSet", "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/CreateScopingRuleSetDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Scoping rule set created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } } } }, "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}": { "post": { "tags": [ "ScopingRuleSet" ], "summary": "Create scoping rule set version", "description": "

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateScopingRuleSetVersion", "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" } ], "requestBody": { "description": "Create scoping rule set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Scoping rule set version created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "ScopingRuleSet" ], "summary": "Delete scoping rule set and all its versions", "description": "\nDeletes an existing scoping rule set and all its versions.

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteScopingRuleSet", "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": { "202": { "description": "Success. Scoping rule set deleted" }, "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}": { "put": { "tags": [ "ScopingRuleSet" ], "summary": "Update scoping rule set version", "description": "\nUpdates an existing scoping rule set version. Only draft versions are allowed to be updated.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to update", "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" } ], "requestBody": { "description": "Update scoping rule set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Scoping rule set version updated", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse" } } } }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "ScopingRuleSet" ], "summary": "Delete scoping rule set version", "description": "

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to delete", "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": { "202": { "description": "Success. Scoping rule set version deleted" }, "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}/clone": { "post": { "tags": [ "ScopingRuleSet" ], "summary": "Clone scoping rule set version", "description": "

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CloneScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to clone", "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" } ], "requestBody": { "description": "Clone scoping rule set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Scoping rule set version cloned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse" } } } }, "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}/submit-for-approval": { "put": { "tags": [ "ScopingRuleSet" ], "summary": "Submit scoping rule set version for approval", "description": "\nSubmits the selected version of an existing scoping rule set for approval.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "SubmitScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to submit", "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": { "202": { "description": "Success. Scoping rule set version submitted" }, "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}/sign": { "put": { "tags": [ "ScopingRuleSet" ], "summary": "Sign scoping rule set version", "description": "\nSigns the selected version of an existing scoping rule set and changes the version status accordingly to the action (Approve/Reject).

Required permissions:
Following permissions are required: RiskConfigurationApprove", "operationId": "SignScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to sign", "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" } ], "requestBody": { "description": "Sign scoping rule set version request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "Success. Scoping rule set version signed", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse" } } } }, "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}/archive": { "put": { "tags": [ "ScopingRuleSet" ], "summary": "Archive scoping rule set version", "description": "\nArchives the selected version of an existing scoping rule set.

Required permissions:
Following permissions are required: RiskConfigurationArchive", "operationId": "ArchiveScopingRuleSetVersion", "parameters": [ { "name": "scopingRuleSetId", "in": "path", "description": "Scoping rule set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to archive", "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": { "202": { "description": "Success. Scoping rule set version archived" }, "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" } } } }, "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" } ] } } } }, "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": { "post": { "tags": [ "ThresholdModel" ], "summary": "Create a new ThresholdModel", "description": "\nThis method will create a new ThresholdModel with a first draft version.\r\n\nThe new version will initialize with the DTO data and have the default status of Draft \r\n and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateThresholdModel", "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": "ServiceRequest with the ThresholdModelDto to create", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } } } }, "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/threshold-model/{id}": { "post": { "tags": [ "ThresholdModel" ], "summary": "Create a new Version for an existing ThresholdModel", "description": "\nThis method will create a new ThresholdModel version.\r\n\nThe new version will initialize with the DTO data. It will be assigned the next available version number, \r\n the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CreateThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the new version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel version created successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } } } }, "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" } } } }, "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" } ] } } } } } }, "put": { "tags": [ "ThresholdModel" ], "summary": "Update an existing Version of a ThresholdModel", "description": "\nThis method will update an existing ThresholdModel version.\r\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "UpdateThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the updated version data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel version updated successfully" }, "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" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "ThresholdModel" ], "summary": "Delete an existing ThresholdModel", "description": "\nThis method will delete an existing ThresholdModel as well as all its versions.

Required permissions:
Following permissions are required: RiskConfigurationDelete", "operationId": "DeleteThresholdModel", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model to delete", "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": { "202": { "description": "ThresholdModel deleted successfully" }, "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/threshold-model/{id}/version/{versionNumber}/clone": { "post": { "tags": [ "ThresholdModel" ], "summary": "Clone an existing Version of a ThresholdModel to a new model", "description": "\nThis method will clone the selected version of an existing ThresholdModel\r\n and create a new model with a single version.\r\n\nThe new version will contain all the data of the original selected one, \r\n will have the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "CloneThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to clone", "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": { "202": { "description": "ThresholdModel cloned successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThresholdModelDtoServiceResponse" } } } }, "400": { "description": "The Tenant header is missing", "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/threshold-model/{id}/version/{versionNumber}/sign": { "put": { "tags": [ "ThresholdModel" ], "summary": "Sign an existing Version of a ThresholdModel", "description": "\nThis method will Sign the selected version of an existing ThresholdModel.\r\n The Status of the version will change according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: RiskConfigurationApprove", "operationId": "SignThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApproveActionServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel version signed successfully", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModelVersionSignResponseServiceResponse" } } } }, "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/threshold-model/{id}/version/{versionNumber}/archive": { "put": { "tags": [ "ThresholdModel" ], "summary": "Archive an existing Version of a ThresholdModel", "description": "\nThis method will Archive the selected version of an existing ThresholdModel.

Required permissions:
Following permissions are required: RiskConfigurationArchive", "operationId": "ArchiveThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.ThresholdModelDto to archive", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel version archived successfully" }, "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" } } } }, "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}/submit": { "put": { "tags": [ "ThresholdModel" ], "summary": "Submit an existing Version of a ThresholdModel for Approval", "description": "\nThis method will submit the selected version of an existing ThresholdModel\r\n for Approval.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "SubmitThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Risk.Command.Application.Dto.ThresholdModelDto to submit", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "ThresholdModel version submitted successfully" }, "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" } } } }, "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}": { "delete": { "tags": [ "ThresholdModel" ], "summary": "Delete an existing Version of a ThresholdModel", "description": "\nThis method will Delete the selected version of an existing ThresholdModel.\r\n If the version is the last one, then the version number of it will become the next available one for the model.\r\n Otherwise, the version number will be flagged as Deleted and become unavailable.

Required permissions:
Following permissions are required: RiskConfigurationEdit", "operationId": "DeleteThresholdModelVersion", "parameters": [ { "name": "id", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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": { "202": { "description": "ThresholdModel version deleted successfully" }, "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" } ] } } } } } } } }, "components": { "schemas": { "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApproveActionServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true } }, "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 }, "CloneScopingRuleSetVersionDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of new scoping rule set", "example": "Shareholder Scoping Rules" } }, "additionalProperties": false, "description": "Request DTO representing clone scoping rule set data" }, "CloneScopingRuleSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CloneScopingRuleSetVersionDto" } ], "description": "Request DTO representing clone scoping rule set data", "nullable": true } }, "additionalProperties": false }, "CloneScopingRuleSetVersionResponseDto": { "type": "object", "properties": { "scopingRuleSetId": { "type": "string", "description": "Id of the cloned scoping rule set", "format": "uuid", "example": "7084669b-0813-4faa-b1d5-b7bf6d749717" } }, "additionalProperties": false, "description": "Cloned scoping rule set response data" }, "CloneScopingRuleSetVersionResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDto" } ], "description": "Cloned scoping rule set response data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": 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, "example": { "id": "118313c6-91e6-4b05-a537-5a1ab906418f", "name": "Company-type only", "description": "Applicable only when EntityType=Company", "logicalOperation": "AND", "operands": [ { "fieldName": "EntityType", "value": [ "Company" ], "valueType": "text", "operation": "equal", "operands": [ ] } ] } }, "CreateScopingRuleSetDto": { "required": [ "effectiveFrom", "name" ], "type": "object", "properties": { "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-05T14:48:00.000Z" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the schema can be used", "nullable": true }, "name": { "minLength": 1, "type": "string", "description": "Scoping rule set name", "example": "Global" } }, "additionalProperties": false, "description": "DTO representing scoping rule set data needed for creation" }, "CreateScopingRuleSetDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetDto" } ], "description": "DTO representing scoping rule set data needed for creation", "nullable": true } }, "additionalProperties": false }, "CreateScopingRuleSetResponseDto": { "required": [ "effectiveFrom", "name", "signees" ], "type": "object", "properties": { "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-05T14:48:00.000Z" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the schema can be used", "nullable": true }, "name": { "minLength": 1, "type": "string", "description": "Scoping rule set name", "example": "Global" }, "scopingRuleSetId": { "type": "string", "description": "The UiD of scoping rule set", "format": "uuid", "example": "7084669b-0813-4faa-b1d5-b7bf6d749717" }, "versionNumber": { "type": "integer", "description": "The version number", "format": "int32", "example": 1 }, "created": { "type": "string", "description": "The creation date of the version (Read-only)", "format": "date-time", "example": "2021-01-05T14:48:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/SigneeDto" }, "description": "The defined list of signees for the version" } }, "additionalProperties": false, "description": "DTO representing scoping rule set data" }, "CreateScopingRuleSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetResponseDto" } ], "description": "DTO representing scoping rule set data", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateScopingRuleSetVersionDto": { "required": [ "effectiveFrom" ], "type": "object", "properties": { "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-05T14:48:00.000Z" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the schema can be used", "nullable": true } }, "additionalProperties": false, "description": "DTO representing scoping rule set data needed for version creation" }, "CreateScopingRuleSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateScopingRuleSetVersionDto" } ], "description": "DTO representing scoping rule set data needed for version creation", "nullable": true } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "ModelVersionSignResponse": { "type": "object", "properties": { "parentModelId": { "type": "string", "description": "The Id of the model the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "The number of the version that has been signed", "format": "int32", "example": 3 }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The new version status", "example": "Published" } }, "additionalProperties": false, "description": "Contains the new version Status, after a version sign operation" }, "ModelVersionSignResponseServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ModelVersionSignResponse" } ], "description": "Contains the new version Status, after a version sign operation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "RiskCalculatorOptionDto": { "type": "object", "properties": { "riskModelId": { "type": "string", "description": "The RiskModel Id", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "configurationModelId": { "type": "string", "description": "The RiskConfiguration model Id", "format": "uuid", "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "thresholdModelId": { "type": "string", "description": "The Threshold Model Id", "format": "uuid", "example": "a8e4a96e-696a-4d04-89e9-faa74738fc43" } }, "additionalProperties": false, "description": "A combination of Ids that make up a Risk Calculation Option" }, "RiskCalculatorOptionModelDto": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of the model", "example": "Global Risk Model" }, "riskCalculatorOption": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionDto" } ], "description": "The risk calculation options\r\n(a set of Ids that make up a Risk Calculation Option)", "nullable": true }, "alwaysReturnModel": { "type": "boolean", "description": "If set to true, then this is a global option without scope parameters", "example": false }, "scopeParameters": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "The scope parameters of the model", "nullable": true, "example": { "ProductType": "HomeLoan", "Country": "Ireland" } } }, "additionalProperties": false, "description": "A Risk Calculator Option for given Scope parameters" }, "RiskCalculatorOptionModelDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDto" } ], "description": "A Risk Calculator Option for given Scope parameters", "nullable": true } }, "additionalProperties": false }, "RiskCalculatorOptionModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskCalculatorOptionModelDto" } ], "description": "A Risk Calculator Option for given Scope parameters", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationCollectionDto": { "required": [ "name", "parentRiskConfigurationId" ], "type": "object", "properties": { "collectionId": { "type": "string", "description": "The UiD of the collection", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "parentRiskConfigurationId": { "type": "string", "description": "The UiD of the configuration model, the collection belongs to", "format": "uuid", "example": "16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9" }, "parentVersionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The version number of the model that the collection is part of", "format": "int32", "example": 2 }, "name": { "minLength": 1, "type": "string", "description": "Display name of the collection", "example": "Business Industry" }, "collectionType": { "type": "string", "description": "The type of the collection (Lookup/Numeric)", "nullable": true, "example": "Lookup" }, "configurationItems": { "type": "array", "items": { "$ref": "#/components/schemas/RiskConfigurationItemDto" }, "description": "The list of Configuration Items that belong to the collection", "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/ThresholdDto" }, "description": "The custom thresholds defined for this collection", "nullable": true } }, "additionalProperties": false, "description": "A risk configuration collection of Items and Thresholds" }, "RiskConfigurationCollectionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDto" } ], "description": "A risk configuration collection of Items and Thresholds", "nullable": true } }, "additionalProperties": false }, "RiskConfigurationCollectionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationCollectionDto" } ], "description": "A risk configuration collection of Items and Thresholds", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationItemDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Display name of the item", "example": "Tourism" }, "riskLevel": { "type": "number", "description": "The risk level assigned to the item", "format": "double", "example": 99.88 }, "minRangeValue": { "type": "number", "description": "If the type of the collection is Numeric, the minimum of valid risk level values for the item", "format": "double", "example": 3.01 }, "maxRangeValue": { "type": "number", "description": "If the type of the collection is Numeric, the maximum of valid risk level values for the item", "format": "double", "example": 142.14 } }, "additionalProperties": false, "description": "A risk configuration collection item" }, "RiskConfigurationModelDto": { "required": [ "riskConfigurationModelVersion" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the risk configuration model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskConfigurationModelVersion": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelVersionDto" } ], "description": "The version of the model" } }, "additionalProperties": false, "description": "RiskConfiguration model version wrapper" }, "RiskConfigurationModelDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDto" } ], "description": "RiskConfiguration model version wrapper", "nullable": true } }, "additionalProperties": false }, "RiskConfigurationModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskConfigurationModelDto" } ], "description": "RiskConfiguration model version wrapper", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskConfigurationModelVersionDto": { "required": [ "effectiveFrom", "name", "versionNumber" ], "type": "object", "properties": { "parentRiskConfigurationModelId": { "type": "string", "description": "The UiD of the model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of the model", "example": "Global Configuration Model" }, "versionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The number of the model version", "format": "int32", "example": 4 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "maxLength": 2000, "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": "A RiskConfiguration model Version" }, "RiskFactorDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the factor", "nullable": true, "example": "Product Type" }, "weight": { "type": "number", "description": "The risk calculation weight of the factor", "format": "double", "nullable": true, "example": 0.8 }, "riskLevelCalculationAlgorithm": { "type": "string", "description": "The risk calculation algorithm when multiple input values present", "nullable": true, "example": "sum" }, "isMandatory": { "type": "boolean", "description": "Whether it is mandatory to provide a value for this factor", "example": true } }, "additionalProperties": false, "description": "A risk model factor" }, "RiskFactorGroupDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Display name of the group", "nullable": true, "example": "Product Risk" }, "weight": { "type": "number", "description": "The risk calculation weight of the factor group", "format": "double", "nullable": true, "example": 0.3 }, "riskLevelCalculationAlgorithm": { "type": "string", "description": "The risk calculation algorithm when multiple factors are present", "nullable": true, "example": "max" }, "riskFactors": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorDto" }, "description": "The list of factors that belong to the group", "nullable": true }, "childRiskFactorGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupDto" }, "description": "The list of child factor groups", "nullable": true }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupThresholdDto" }, "description": "The list of thresholds specific to this risk factor group", "nullable": true } }, "additionalProperties": false, "description": "A group of risk model factors" }, "RiskFactorGroupThresholdDto": { "required": [ "maximumValue", "minimumValue", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Display name of the threshold", "example": "Low" }, "minimumValue": { "type": "number", "description": "Minimum value of the threshold range", "format": "double", "example": -10 }, "maximumValue": { "type": "number", "description": "Maximum value of the threshold range", "format": "double", "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": "A range of values that define a threshold" }, "RiskModelDto": { "required": [ "riskModelVersion" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the risk model", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "riskModelVersion": { "allOf": [ { "$ref": "#/components/schemas/RiskModelVersionDto" } ], "description": "The version of the model" } }, "additionalProperties": false, "description": "RiskModel version wrapper" }, "RiskModelDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDto" } ], "description": "RiskModel version wrapper", "nullable": true } }, "additionalProperties": false }, "RiskModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RiskModelDto" } ], "description": "RiskModel version wrapper", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RiskModelVersionDto": { "required": [ "effectiveFrom", "name", "versionNumber" ], "type": "object", "properties": { "parentRiskModelId": { "type": "string", "description": "The UiD of the model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of the model", "example": "Global Risk Model" }, "riskFactorGroups": { "type": "array", "items": { "$ref": "#/components/schemas/RiskFactorGroupDto" }, "description": "The list of risk factor groups that belong to this version", "nullable": true }, "versionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The number of the model version", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "maxLength": 2000, "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": "A RiskModel version" }, "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 }, "SignScopingRuleSetVersionResponseDto": { "type": "object", "properties": { "scopingRuleSetId": { "type": "string", "description": "The UiD of the scoping rule set", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "versionNumber": { "type": "integer", "description": "The number of the version that has been signed", "format": "int32", "example": 2 }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The new version status", "example": "Rejected" } }, "additionalProperties": false, "description": "Sign scoping rule set response contains the new version status" }, "SignScopingRuleSetVersionResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDto" } ], "description": "Sign scoping rule set response contains the new version status", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "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 }, "ThresholdDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Display name of the threshold", "example": "Low" }, "minimumValue": { "type": "number", "description": "Minimum value of the threshold range", "format": "double", "nullable": true, "example": -10 }, "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": { "pattern": "^#[0-9A-Fa-f]{6}$", "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": "A range of values that define a threshold" }, "ThresholdModelDto": { "required": [ "thresholdModelVersion" ], "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the threshold model", "format": "uuid", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "thresholdModelVersion": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelVersionDto" } ], "description": "The version of the model" } }, "additionalProperties": false, "description": "ThresholdModel version wrapper" }, "ThresholdModelDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDto" } ], "description": "ThresholdModel version wrapper", "nullable": true } }, "additionalProperties": false }, "ThresholdModelDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ThresholdModelDto" } ], "description": "ThresholdModel version wrapper", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ThresholdModelVersionDto": { "required": [ "effectiveFrom", "name", "versionNumber" ], "type": "object", "properties": { "parentThresholdModelId": { "type": "string", "description": "The UiD of the model that the version belongs to", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "minLength": 1, "type": "string", "description": "Display name of the model", "example": "Standard Threshold Model" }, "thresholds": { "type": "array", "items": { "$ref": "#/components/schemas/ThresholdDto" }, "description": "The list of threshold ranges that belong to this version", "nullable": true }, "versionNumber": { "maximum": 2147483647, "minimum": 1, "type": "integer", "description": "The number of the model version", "format": "int32", "example": 2 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "notes": { "maxLength": 2000, "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": "A ThresholdModel version" }, "UpdateScopingRuleSetResponseDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Scoping rule set aggregate version after update", "format": "int32", "example": 4 } }, "additionalProperties": false, "description": "Response DTO representing updated scoping rule set" }, "UpdateScopingRuleSetResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateScopingRuleSetResponseDto" } ], "description": "Response DTO representing updated scoping rule set", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UpdateScopingRuleSetVersionDto": { "required": [ "effectiveFrom" ], "type": "object", "properties": { "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-01-01T14:48:00.000Z" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the schema can be used", "nullable": true }, "version": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required\r\nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\r\non top of latest without conflicts checking", "format": "int32", "default": -1, "example": 5 } }, "additionalProperties": false, "description": "Request DTO representing set of properties which define a new version of scoping rule set" }, "UpdateScopingRuleSetVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateScopingRuleSetVersionDto" } ], "description": "Request DTO representing set of properties which define a new version of scoping rule set", "nullable": true } }, "additionalProperties": false }, "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": [ ] } ] }