openapi: 3.2.0
info:
  title: Risk Modeler Utility V1 API
  description: This documentation provides information on the Risk Modeler 2.0 public API.
  version: March, 2023
servers:
- url: https://{host}/riskmodeler
  description: Risk Intelligence Analytics Platform
  variables:
    host:
      enum:
      - api-euw1.rms.com
      - api-use1.rms.com
      default: api-euw1.rms.com
      description: 'Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com.'
security:
- RMS_Auth: []
tags:
- name: UtilityV1
paths:
  /v1/utils/convert/criteriatoquery:
    post:
      operationId: convertPolicyCriteriaToQueryString
      summary: Convert policy condition to query
      description: ''
      requestBody:
        description: List of policy condition criteria.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PolicyConditionCriteria'
        required: true
      responses:
        '200':
          description: Policy condition criteria is successfully converted into a query string.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryEntity'
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
  /v1/utils/convert/portfoliocriteriatoquery:
    post:
      operationId: convertPortfolioCriteriaToQueryString
      summary: Convert portfolio condition to query
      description: ''
      requestBody:
        description: List of policy condition criteria.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PortfolioConditionCriteria'
        required: true
      responses:
        '200':
          description: Policy condition criteria is successfully converted into a query string.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryEntity'
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
  /v1/faclayers:
    get:
      operationId: getFacultatives
      summary: Get facultataives
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: 'Filters query results by evaluating the value of expressions. Supports four types of operators:

          * Comparison: `q=[attribute][comparison operator][value]` e.g. `id=100`, `id!=100`, `id>100`

          * Logical: `q=[expression][logical operator][expression]` e.g. `id=100 AND name="xyz"` , `id=100 OR type="abc"`

          * List: `q=[attribute][list operator][values list]` e.g. `id IN (1,2,3]`, `name NOT IN ("abc","xyz")`

          * Matching: `q=[attribute][comparison operator][pattern]`, e.g. `name LIKE "abc "` , `type NOT LIKE " xyz* "`

          To learn more, see [Query Exposure Data](https://developer.rms.com/rms-developers/docs/query-exposure-data).'
        schema:
          type: string
      - name: sort
        in: query
        description: Specify comma-delimited field names followed by `ASC` (to display the results in alphabetical or numerical ascending order) or `DESC` (to display the results in descending order.)
        schema:
          type: string
      - name: limit
        in: query
        description: Number of records to display per page.
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: 'Number of pages that are offset before the initial page of records returned. By default, _0_.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of facultataives in the data source is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacultativeSearchResult'
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Facultative Cessions" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
    post:
      operationId: createFacultative
      summary: Create facultative
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Facultative'
        required: true
      responses:
        '201':
          description: New facultative is created in the data source is successfully.
          headers:
            Location:
              description: Location of the new Facultative
              style: simple
              schema:
                type: string
                format: URI
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "Edit Facultative Cessions" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: Conflict. Resource already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
  /v1/faclayers/{id}:
    get:
      operationId: getFacultativeById
      summary: Get facultative by ID
      description: ''
      parameters:
      - name: id
        in: path
        description: ID of the faclutative.
        required: true
        schema:
          type: string
          maxLength: 2147483647
          minLength: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Facultative by Id in the data source is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facultative'
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Facultative Cessions" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Facultative not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
    put:
      operationId: updateFacultative
      summary: Update facultative
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of the facultative.
        required: true
        schema:
          type: string
          maxLength: 2147483647
          minLength: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Facultative'
        required: true
      responses:
        '204':
          description: Facultative is updated in the data source is successfully.
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "Edit Facultative Cessions" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
    delete:
      operationId: deleteFacultative
      summary: Delete facultative
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of the facultative.
        required: true
        schema:
          type: string
          maxLength: 2147483647
          minLength: 1
      responses:
        '204':
          description: Deleted. Facultative is deleted from the data source successfully.
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "Edit Facultative Cessions" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - UtilityV1
  /v1/globaledit/dryrun:
    post:
      operationId: dryRun
      summary: Update exposures dry run
      description: ''
      parameters:
      - name: exposureId
        in: query
        description: ID of exposure.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: exposureType
        in: query
        description: 'Exposure type: ACCOUNT or PORTFOLIO.'
        required: true
        schema:
          type: string
          enum:
          - PORTFOLIO
          - ACCOUNT
          - LOCATION
          - POLICY
          - STEP_POLICY
          - TREATY
          - AGGPORTFOLIO
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        '201':
          description: The bulk edit dry run was successfully performed.
          content:
            application/json:
              schema:
                type: string
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      tags:
      - UtilityV1
  /v1/globaledit:
    post:
      operationId: globalEdit
      summary: Update exposures
      description: ''
      parameters:
      - name: exposureId
        in: query
        description: ID of exposure.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: exposureType
        in: query
        description: 'Exposure type: `ACCOUNT` or `PORTFOLIO`.'
        required: true
        schema:
          type: string
          enum:
          - PORTFOLIO
          - ACCOUNT
          - LOCATION
          - POLICY
          - STEP_POLICY
          - TREATY
          - AGGPORTFOLIO
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        '202':
          description: 'Accepted: A `BULK_EDIT` job was added to the workflow engine queue for processing. Returns a URL in the `Location` header that enables you to track the status of the job e.g. `/{host}/v1/workflows/100000`. Send periodic HTTP GET requests to the URL for the job status. See [Workflow Engine](https://developer.rms.com/rms-developers/docs/workflow-engine).

            '
          headers:
            Location:
              description: workflowId
              style: simple
              schema:
                type: string
                format: URI
        '400':
          description: 'Bad Request: Please check that you are provided all required values.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      tags:
      - UtilityV1
components:
  schemas:
    FacultativeSearchResult:
      type: object
      properties:
        searchTotalMatch:
          type: integer
          format: int64
        searchItems:
          type: array
          items:
            $ref: '#/components/schemas/Facultative'
    PolicyConditionCriteria:
      type: object
      properties:
        id:
          type: integer
          format: int32
        logic:
          type: string
        openPar:
          type: string
        field:
          type: string
        operator:
          type: string
        value:
          type: string
        closePar:
          type: string
    PortfolioConditionCriteria:
      type: object
      properties:
        id:
          type: integer
          format: int32
        logic:
          type: string
        openPar:
          type: string
        field:
          type: string
        operator:
          type: string
        value:
          type: string
        closePar:
          type: string
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        logId:
          type: string
    Facultative:
      type: object
      properties:
        id:
          type: string
          maxLength: 20
          minLength: 0
          pattern: ^\w([\w-]*\w|)$
        name:
          type: string
          maxLength: 40
          minLength: 0
      required:
      - name
    QueryEntity:
      type: object
      properties:
        q:
          type: string
  securitySchemes:
    RMS_Auth:
      type: apiKey
      name: Authorization
      in: header
      description: An API key is a token that enables a client application to make requests to tenant applications running on Intelligent Risk Platform.
      x-default: XXXXXXXXXX
x-readme:
  explorer-enabled: false
  samples-languages:
  - curl
  - java
  - csharp
  - node
  - python
  proxy-enabled: true
  samples-enabled: true