openapi: 3.2.0 info: title: Fenergo Threshold Model API version: '1.0' description: 'Operations tagged ThresholdModel across 2 of this provider''s published API definitions: fenergo-riskcommand-v1-0-openapi.json, fenergo-riskquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /riskcommand - url: /riskquery security: - Bearer: [] tags: - name: ThresholdModel paths: /api/threshold-model: post: tags: - ThresholdModel summary: Create a new ThresholdModel description: 'This method will create a new ThresholdModel with a first draft version. The new version will initialize with the DTO data and have the default status of Draft 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 get: tags: - ThresholdModel summary: Get all Threshold models description: 'This method returns all threshold models for the given tenant. Required permissions: At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess' operationId: GetAllThresholdModels parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/ThresholdModelDtoIEnumerableServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /riskcommand /api/threshold-model/{id}: post: tags: - ThresholdModel summary: Create a new Version for an existing ThresholdModel description: 'This method will create a new ThresholdModel version. The new version will initialize with the DTO data. It will be assigned the next available version number, 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: 'This method will update an existing ThresholdModel version. Only 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: 'This 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 get: tags: - ThresholdModel summary: Get the active version of an existing Threshold model description: 'This method returns the active, currently in effect, published version for a given threshold model. Required permissions: At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess' operationId: GetThresholdModelById parameters: - name: id in: path description: The Id of the existing model required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' '400': description: Model Id is invalid content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: No active version was found type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /riskcommand /api/threshold-model/{id}/version/{versionNumber}/clone: post: tags: - ThresholdModel summary: Clone an existing Version of a ThresholdModel to a new model description: 'This method will clone the selected version of an existing ThresholdModel and create a new model with a single version. The new version will contain all the data of the original selected one, 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 servers: - url: /riskcommand /api/threshold-model/{id}/version/{versionNumber}/sign: put: tags: - ThresholdModel summary: Sign an existing Version of a ThresholdModel description: 'This method will Sign the selected version of an existing ThresholdModel. 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 servers: - url: /riskcommand /api/threshold-model/{id}/version/{versionNumber}/archive: put: tags: - ThresholdModel summary: Archive an existing Version of a ThresholdModel description: 'This 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 servers: - url: /riskcommand /api/threshold-model/{id}/version/{versionNumber}/submit: put: tags: - ThresholdModel summary: Submit an existing Version of a ThresholdModel for Approval description: 'This method will submit the selected version of an existing ThresholdModel 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 servers: - url: /riskcommand /api/threshold-model/{id}/version/{versionNumber}: delete: tags: - ThresholdModel summary: Delete an existing Version of a ThresholdModel description: 'This method will Delete the selected version of an existing ThresholdModel. If the version is the last one, then the version number of it will become the next available one for the model. 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 get: tags: - ThresholdModel summary: Get the specified version of an existing Threshold model description: 'This method returns the, specified by number, version for a given threshold model. Required permissions: At least one of the following permissions is required: RiskConfigurationAccess, RiskCalculatorAccess' operationId: GetThresholdModelByVersionNumber parameters: - name: id in: path description: The Id of the existing model required: true schema: type: string - name: versionNumber in: path description: The version number to retrieve required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/ThresholdModelVersionDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Model Id is invalid type: Error errorCode: Error Code '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /riskcommand components: schemas: Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ModelVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ModelVersionSignResponse' description: Contains the new version Status, after a version sign operation messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ThresholdDto: required: - name type: object properties: name: minLength: 1 type: string description: Display name of the threshold example: Low minimumValue: type: - number - 'null' description: Minimum value of the threshold range format: double example: -10 maximumValue: type: - number - 'null' description: Maximum value of the threshold range format: double example: 1.999 nextReviewPeriod: type: - integer - 'null' description: The period in months for the next review of the client format: int32 example: 1 thresholdColor: pattern: ^#[0-9A-Fa-f]{6}$ type: - string - 'null' description: 'Optional UI color assigned to this threshold range for visualization purposes. Must be a valid hex value in the form #RRGGBB.' example: '#FF0000' additionalProperties: false description: A range of values that define a threshold ThresholdModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ThresholdModelDto' description: ThresholdModel version wrapper messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string Decision: enum: - Approve - Reject type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ThresholdModelDto: required: - thresholdModelVersion type: object properties: id: type: - string - 'null' description: The UiD of the threshold model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f thresholdModelVersion: allOf: - $ref: '#/components/schemas/ThresholdModelVersionDto' description: The version of the model additionalProperties: false description: ThresholdModel version wrapper 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 Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: 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 - 'null' items: $ref: '#/components/schemas/ThresholdDto' description: The list of threshold ranges that belong to this version 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 - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version notes: maxLength: 2000 type: - string - 'null' 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. example: Example Notes additionalProperties: false description: A ThresholdModel version ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false ThresholdModelDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ThresholdModelDto' description: ThresholdModel version wrapper additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Threshold: type: object properties: name: type: - string - 'null' minimumValue: type: - number - 'null' format: double maximumValue: type: - number - 'null' format: double nextReviewPeriod: type: - integer - 'null' format: int32 thresholdColor: type: - string - 'null' additionalProperties: false ThresholdModelDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ThresholdModelDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ThresholdModelDto_2: type: object properties: id: type: string description: The UiD of the threshold model format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versions: type: - array - 'null' items: $ref: '#/components/schemas/ThresholdModelVersionDto_2' description: A list of the model versions metadata and calculated properties additionalProperties: false description: ThresholdModel with all version metadata ThresholdModelVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ThresholdModelVersionDto_2' description: ThresholdModel version data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ThresholdModelVersionDto_2: type: object properties: id: type: string description: The UiD of the version format: uuid example: baee4b61-7ebb-48b2-a44b-18ce814b703b parentThresholdModelId: type: string description: The UiD of the threshold model that the version belongs to format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: The versions number format: int32 example: 2 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time effectiveUntil: type: - string - 'null' description: The calculated date that the version ceases being active format: date-time publicationDate: type: - string - 'null' description: The date that the version got published format: date-time status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft name: type: - string - 'null' description: Display name of the model example: Standard Threshold Model created: type: string description: The creation date of the version format: date-time thresholds: type: - array - 'null' items: $ref: '#/components/schemas/Threshold' description: The list of thresholds that belong to the version isActive: type: boolean description: 'The calculated flag to annotate whether this is the model''s active version at the time of the query' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version notes: type: - string - 'null' 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. example: Example Notes additionalProperties: false description: ThresholdModel version data securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-riskcommand-v1-0-openapi.json - fenergo-riskquery-v1-0-openapi.json