Fenergo Risk Calculator Option Model API

openapi: 3.2.0
info:
  title: Fenergo Risk Calculator Option Model API
  version: '1.0'
  description: 'Operations tagged RiskCalculatorOptionModel 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: RiskCalculatorOptionModel
paths:
  /api/risk-calculator-options:
    post:
      tags:
      - RiskCalculatorOptionModel
      summary: Create a new RiskCalculatorOption
      description: 'This method will create a new RiskCalculatorOption model.

        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
    get:
      tags:
      - RiskCalculatorOptionModel
      summary: Get all Risk Calculator Option Models
      description: 'This method returns all risk calculator options for the given tenant.


        Required permissions:

        Following permissions are required: RiskConfigurationAccess'
      operationId: GetAllRiskCalculatorOptionModels
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelIEnumerableServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /riskcommand
  /api/risk-calculator-options/{id}:
    put:
      tags:
      - RiskCalculatorOptionModel
      summary: Update an existing RiskCalculatorOption
      description: 'This method will update an existing RiskCalculatorOption

        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: 'This 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
    get:
      tags:
      - RiskCalculatorOptionModel
      summary: Get an existing Risk Calculator Option model
      description: 'This method returns the risk calculator option model data for a given model id.


        Required permissions:

        Following permissions are required: RiskConfigurationAccess'
      operationId: GetRiskCalculatorOptionModelById
      parameters:
      - name: id
        in: path
        description: The Id of the existing model
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskCalculatorOptionModelServiceResponse'
        '400':
          description: Model Id is invalid
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: No model was found
                  type: Error
                  errorCode: Error Code
        '500':
          description: An exception occurred while processing the command
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /riskcommand
components:
  schemas:
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    RiskCalculatorOptionModelDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskCalculatorOptionModelDto'
          description: A Risk Calculator Option for given Scope parameters
      additionalProperties: false
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    RiskCalculatorOptionModelDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskCalculatorOptionModelDto'
          description: A Risk Calculator Option for given Scope parameters
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    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

            (a set of Ids that make up a Risk Calculation Option)'
        alwaysReturnModel:
          type: boolean
          description: If set to true, then this is a global option without scope parameters
          example: false
        scopeParameters:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: The scope parameters of the model
          example:
            ProductType: HomeLoan
            Country: Ireland
      additionalProperties: false
      description: A Risk Calculator Option for given Scope parameters
    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
    OptionsInScope:
      type: object
      properties:
        modelsInScope:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskCalculatorOption'
      additionalProperties: false
    RiskCalculatorOption:
      type: object
      properties:
        riskModelId:
          type: string
          format: uuid
        configurationModelId:
          type: string
          format: uuid
        thresholdModelId:
          type: string
          format: uuid
      additionalProperties: false
    ScopingQueryParametersDto:
      type: object
      properties:
        queryParameters:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: A set of risk calculator option scope parameters
          example:
            ProductType: HomeLoan
            Country: Ireland
      additionalProperties: false
      description: The risk calculator option scope parameters to query by
    RiskCalculatorOptionModelServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskCalculatorOptionModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    OptionsInScopeServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/OptionsInScope'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ScopingQueryDto:
      type: object
      properties:
        scopingQuery:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ScopingQueryParametersDto'
          description: The list of risk calculator option scope parameters to query by
      additionalProperties: false
      description: A risk calculator option query by scope parameters
    ScopingQueryDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ScopingQueryDto'
          description: A risk calculator option query by scope parameters
      additionalProperties: false
    RiskCalculatorOptionModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tenant:
          type:
          - string
          - 'null'
        version:
          type: integer
          format: int32
        isLocked:
          type: boolean
        name:
          type:
          - string
          - 'null'
        alwaysReturnModel:
          type: boolean
        riskCalculatorOptions:
          allOf:
          - $ref: '#/components/schemas/RiskCalculatorOption'
        scopeParameters:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    RiskCalculatorOptionModelIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskCalculatorOptionModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  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