openapi: 3.2.0
info:
  title: Risk Modeler Pate 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: PateV1
paths:
  /v1/pate-treaties:
    post:
      operationId: createPateTreaty
      summary: Create PATE treaty
      description: ''
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pate'
        required: true
      responses:
        '201':
          description: The PATE Treaty resource was successfully created.
          headers:
            Location:
              description: Location of the PATE Treaty resource.
              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 "Post Analysis Treaty Execution" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PateV1
  /v1/pate-treaties/{pateId}:
    get:
      operationId: getPateById
      summary: Get PATE treaty
      description: ''
      parameters:
      - name: pateId
        in: path
        description: Pate ID of pate.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Treaty for a specified account are successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pate'
        '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 Results" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PateV1
    put:
      operationId: updatePateTreaty
      summary: Update PATE treaty
      description: ''
      parameters:
      - name: pateId
        in: path
        description: ID of the PATE treaty to be updated.
        required: true
        schema:
          type: integer
          format: int64
          minimum: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pate'
        required: true
      responses:
        '204':
          description: The PATE Treaty resource was successfully updated.
        '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 "Post Analysis Treaty Execution" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PateV1
    delete:
      operationId: deletePateTreaty
      summary: Delete PATE treaty
      description: ''
      parameters:
      - name: pateId
        in: path
        description: ID number of the pate treaty.
        required: true
        schema:
          type: integer
          format: int64
          minimum: 1
      responses:
        '204':
          description: The PATE Treaty resource is successfully deleted
        '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 "Post Analysis Treaty Execution" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PateV1
components:
  schemas:
    ExposureValue:
      type: object
      properties:
        id:
          type: integer
          format: int32
        code:
          type: string
        name:
          type: string
    LossOccurrence:
      type: object
      properties:
        id:
          type: integer
          format: int32
        treatyId:
          type: integer
          format: int32
        regionPeril:
          $ref: '#/components/schemas/ExposureValue'
        lossOccurrenceTime:
          type: integer
          format: int32
        lossOccurrenceRadius:
          type: integer
          format: int32
        radiusUnit:
          $ref: '#/components/schemas/ExposureValue'
        multiLossOccurrence:
          $ref: '#/components/schemas/ExposureValue'
      required:
      - treatyId
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        logId:
          type: string
    LineOfBusiness:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
          maxLength: 20
          minLength: 0
      required:
      - name
    Producer:
      description: Agent or brokerage firm that produced a policy.
      type: object
      properties:
        id:
          type: string
          maxLength: 20
          minLength: 0
          pattern: ^\w([\w-]*\w|)$
        name:
          type: string
          maxLength: 40
          minLength: 0
      required:
      - name
    Pate:
      type: object
      properties:
        treatyId:
          type: integer
          format: int32
        treatyNumber:
          type: string
          maxLength: 20
          minLength: 0
        treatyName:
          type: string
          maxLength: 40
          minLength: 0
        cedant:
          $ref: '#/components/schemas/Cedant'
        producer:
          $ref: '#/components/schemas/Producer'
        treatyType:
          $ref: '#/components/schemas/ExposureValue'
        currency:
          $ref: '#/components/schemas/ExposureValue'
        attachBasis:
          $ref: '#/components/schemas/ExposureValue'
        attachLevel:
          $ref: '#/components/schemas/ExposureValue'
        premium:
          type: number
          format: double
        occurLimit:
          type: number
          format: double
        attachPt:
          type: number
          format: double
        riskLimit:
          type: number
          format: double
        retentAmt:
          type: number
          format: double
        pcntPlaced:
          type: number
          format: double
        effectDate:
          type: string
        expireDate:
          type: string
        pcntRetent:
          type: number
          format: double
        pcntRiShare:
          type: number
          format: double
        pcntCovered:
          type: number
          format: double
        priority:
          type: integer
          format: int32
        numOfReinst:
          type: integer
          format: int32
        reinstCharge:
          type: number
          format: double
        maolAmount:
          type: number
          format: double
        isValid:
          type: boolean
        userId1:
          type: string
        userId2:
          type: string
        lobs:
          type: array
          items:
            $ref: '#/components/schemas/LineOfBusiness'
        aggregateDeductible:
          type: number
          format: double
        aggregateLimit:
          type: number
          format: double
        lossOccurrences:
          type: array
          items:
            $ref: '#/components/schemas/LossOccurrence'
        analysisId:
          type: integer
          format: int32
        pateId:
          type: integer
          format: int64
        operationType:
          type: string
          enum:
          - INSERT
          - DELETE
          - UPDATE
          - COPY
          - IMPORT
        groupId:
          type: integer
          format: int32
      required:
      - attachLevel
      - cedant
      - treatyNumber
      - treatyType
    Cedant:
      description: A risk-holding party (insurer/reinsurer) that is transferring a portion of risk to another risk-holding party (reinsurer/retrocessionaire).
      type: object
      properties:
        id:
          type: string
          maxLength: 20
          minLength: 0
          pattern: ^\w([\w-]*\w|)$
        name:
          type: string
          maxLength: 40
          minLength: 0
      required:
      - name
  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