openapi: 3.2.0
info:
  title: Risk Modeler Policy 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: PolicyV1
paths:
  /v1/policies:
    get:
      operationId: searchPolicies
      summary: Get policies
      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 displayed per page.
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: 'Number of pages offset before the first page of returned records. By default, _0_.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of policies is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySearchResult'
        '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:
      - PolicyV1
    post:
      operationId: createPolicy
      summary: Create policy
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Policy'
        required: true
      responses:
        '201':
          description: Policy is successfully created.
          headers:
            Location:
              description: Location of the new policy
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/copy:
    post:
      operationId: copyPolicy
      summary: Copy policy
      description: ''
      parameters:
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyPolicyInfo'
        required: true
      responses:
        '200':
          description: Existing policy is successfully copied.
          headers:
            Location:
              description: Policy id of the copy policy
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}:
    get:
      operationId: getPolicy
      summary: Get policy
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specified policy is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '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:
      - PolicyV1
    put:
      operationId: updatePolicy
      summary: Update policy
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Policy'
        required: true
      responses:
        '204':
          description: Policy 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
    delete:
      operationId: deletePolicy
      summary: Delete policy
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Policy 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/cession:
    post:
      operationId: createPolicyReinsuranceCession
      summary: Create reinsurance cession
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReinsuranceCession'
        required: true
      responses:
        '201':
          description: Reinsurance cession for a specified policy is successfully created.
          headers:
            Location:
              description: Location of the new policy reinsurance cession
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/cession/{cessionid}:
    get:
      operationId: getPolicyReinsuranceCession
      summary: Get reinsurance cession
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: cessionid
        in: path
        description: ID number of the Cession.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Reinsurance cession retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReinsuranceCession'
        '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:
      - PolicyV1
    put:
      operationId: updatePolicyReinsuranceCession
      summary: Update reinsurance cession
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: cessionid
        in: path
        description: ID number of the Cession.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReinsuranceCession'
        required: true
      responses:
        '204':
          description: Reinsurance cession 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
    delete:
      operationId: deletePolicyReinsuranceCession
      summary: Delete reinsurance cession
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: cessionid
        in: path
        description: ID number of the Cession.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Reinsurance cession 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/coverage:
    post:
      operationId: createPolicyCoverage
      summary: Create policy coverage
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyCoverage'
        required: true
      responses:
        '201':
          description: Policy coverage successfully created.
          headers:
            Location:
              description: Location of the new policy coverage
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/coverage/{coverageid}:
    get:
      operationId: getPolicyCoverage
      summary: Get policy coverage
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: coverageid
        in: path
        description: ID number of the Policy Coverage.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information on a specified poliy coverage is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyCoverage'
        '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:
      - PolicyV1
    put:
      operationId: updatePolicyCoverage
      summary: Update policy coverage
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: coverageid
        in: path
        description: ID number of the Policy Coverage.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyCoverage'
        required: true
      responses:
        '204':
          description: Policy coverage 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
    delete:
      operationId: deletePolicyCoverage
      summary: Delete policy coverage
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: coverageid
        in: path
        description: ID number of the Policy Coverage.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Policy coverage 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition:
    post:
      operationId: createPolicyCondition
      summary: Create policy condition
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyCondition'
        required: true
      responses:
        '201':
          description: Condition for a specified policy is successfully created.
          headers:
            Location:
              description: location of the new policy condition
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition/{conditionid}:
    get:
      operationId: getPolicyCondition
      summary: Get policy condition
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for a condition specified by its ID for a policy specified by its ID is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyCondition'
        '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:
      - PolicyV1
    put:
      operationId: updatePolicyCondition
      summary: Update policy condition
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyCondition'
        required: true
      responses:
        '204':
          description: Policy condition 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 has been denied.'
          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:
      - PolicyV1
    delete:
      operationId: deletePolicyCondition
      summary: Delete policy condition
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Policy condition 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition/{conditionid}/backfill:
    post:
      operationId: backFillPolicyCondition
      summary: Back fill policy condition
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: 'Accepted: A job with the specified ID has been added to the workflow engine queue for processing. Send periodic HTTP GET requests to the URI for the job status. See [Workflow Engine Jobs](https://developer.rms.com/rms-developers/docs/workflow-engine).'
        '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'
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition/{conditionid}/criteria:
    post:
      operationId: createPolicyConditionCriteria
      summary: Create policy condition criteria
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyConditionCriteria'
        required: true
      responses:
        '201':
          description: Policy condition successfully created
          headers:
            Location:
              description: Location of the new policy condition criteria
              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'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition/{conditionid}/criteria/{criteriaid}:
    get:
      operationId: getPolicyConditionCriteria
      summary: Get policy condition criteria
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: criteriaid
        in: path
        description: ID number of the Policy Condition Criteria.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for the specified policy condition criteria is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyConditionCriteria'
        '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:
      - PolicyV1
    put:
      operationId: updatePolicyConditionCriteria
      summary: Update policy condition criteria
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: criteriaid
        in: path
        description: ID number of the Policy Condition Criteria.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyConditionCriteria'
        required: true
      responses:
        '204':
          description: Policy condition criteria 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
    delete:
      operationId: deletePolicyConditionCriteria
      summary: Delete policy condition criteria
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: criteriaid
        in: path
        description: ID number of the Policy Condition Criteria.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Policy condition criteria 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - PolicyV1
  /v1/policies/{id}/policycondition/{conditionid}/locationconditions:
    get:
      operationId: getLocationConditions
      summary: Get location conditions
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: conditionid
        in: path
        description: ID number of the Policy Condition.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Location conditions for a specified policy condition are successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LocationCondition'
        '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:
      - PolicyV1
  /v1/conditions/{id}:
    get:
      operationId: getPolicyConditionTemplates
      summary: Get policy condition
      description: ''
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Information for a specified policy condition is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyCondition'
        '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:
      - PolicyV1
  /v1/policies/{id}/surplustreaties:
    get:
      operationId: getSurplusTreaties
      summary: Get surplus treaties
      description: ''
      parameters:
      - name: id
        in: path
        description: ID number of the policy.
        required: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: datasource
        in: query
        description: Name of the EDM.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of surplus treaties for a specified policy is successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Treaty'
        '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:
      - PolicyV1
components:
  schemas:
    FacReinsurer:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    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
    PolicyCoverage:
      type: object
      properties:
        id:
          type: integer
          format: int32
        peril:
          $ref: '#/components/schemas/ExposureValue'
        lossType:
          type: string
          enum:
          - Building
          - Contents
          - BI
          - CombinedCvg
        premium:
          type: number
          format: double
        limit:
          type: number
          format: double
        deductible:
          type: number
          format: double
        label:
          $ref: '#/components/schemas/ExposureValue'
        accumulation:
          type: integer
          format: int32
        isValid:
          type: boolean
        percentOfLossDeductibleAmount:
          type: number
          format: double
        isFranchiseDeductible:
          $ref: '#/components/schemas/ExposureValue'
      required:
      - label
      - lossType
      - peril
    Treaty:
      description: 'A reinsurance contract between an underwriter and a primary insurer that applies to a collection of related exposures. Under the terms of the treaty, the primary insurer (for example, a cedant) transfers risk to the underwriter in exchange for a premium and the reinsurer assumes financial responsibility for that risk.

        '
      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:
          description: The treaty type.
          $ref: '#/components/schemas/ExposureValue'
        currency:
          description: Indicates treaty currency. All monetary fields for a single treaty are considered to be in the same currency. However, treaties can be in a different currency than the exposures to which they are being attached. During analysis, Risk Modeler converts all currencies to the analysis currency..
          $ref: '#/components/schemas/ExposureValue'
        attachBasis:
          $ref: '#/components/schemas/ExposureValue'
        attachLevel:
          $ref: '#/components/schemas/ExposureValue'
        premium:
          type: number
          format: double
        occurLimit:
          description: Maximum amount that a treaty pays out for all locations for any event.
          type: number
          format: double
        attachPt:
          description: Value at which the treaty takes effect.
          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:
          description: Percentage of the reinsurer's share of the treaty losses that are not covered by retrocessions. Determines the losses for the reinsurance net loss financial perspective and the net premium that a reinsurer receives for a treaty. Calculated as reinsurance gross loss multiplied by the percentage retention by treaty.
          type: number
          format: double
        pcntRiShare:
          type: number
          format: double
        pcntCovered:
          description: Percentage of loss greater than the attachment point covered by a treaty. Not applicable to Surplus Share treaties.
          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'
      required:
      - attachLevel
      - cedant
      - treatyNumber
      - treatyType
    Policy:
      required:
      - number
      - status
      type: object
      properties:
        id:
          type: integer
          format: int32
        number:
          type: string
        accountId:
          type: integer
          format: int32
        lob:
          $ref: '#/components/schemas/ExposureValue'
        peril:
          $ref: '#/components/schemas/ExposureValue'
        status:
          $ref: '#/components/schemas/ExposureValue'
        inceptionDate:
          type: string
        expirationDate:
          type: string
        currency:
          $ref: '#/components/schemas/ExposureValue'
        partOf:
          type: number
          format: double
        attachmentPoint:
          type: number
          format: double
        minDeductible:
          type: number
          format: double
        maxDeductible:
          type: number
          format: double
        blanketLimit:
          type: number
          format: double
        blanketDeductible:
          type: number
          format: double
        blanketPremium:
          type: number
          format: double
        biLifeLine:
          type: integer
          format: int32
        deductType:
          type: integer
          format: int32
        structure:
          $ref: '#/components/schemas/ExposureValue'
        coverageBase:
          $ref: '#/components/schemas/ExposureValue'
        limitGU:
          $ref: '#/components/schemas/ExposureValue'
        userText1:
          type: string
        userText2:
          type: string
        userText3:
          type: string
        userText4:
          type: string
        isValid:
          type: boolean
        coverages:
          type: array
          items:
            $ref: '#/components/schemas/PolicyCoverage'
        reinsuranceCessions:
          type: array
          items:
            $ref: '#/components/schemas/ReinsuranceCession'
        policyConditions:
          type: array
          items:
            $ref: '#/components/schemas/PolicyCondition'
        CustomData:
          type: object
          additionalProperties:
            type: string
        newCauseOfLoss:
          $ref: '#/components/schemas/ExposureValue'
        percentOfLossDeductible:
          type: number
          format: double
        isFranchiseDeductible:
          $ref: '#/components/schemas/ExposureValue'
        aggregateMinDeductible:
          description: Value of the minimum aggregate deductible.
          type: number
          format: double
        aggregateLimit:
          description: Value of the maximum aggregate payout for the policy.
          type: number
          format: double
    ReinsuranceCession:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        exposureId:
          type: integer
          format: int32
        exposureType:
          type: string
          enum:
          - POL
          - LOC
        type:
          type: string
          enum:
          - None
          - Facultative
          - Treaty
        facReinsurer:
          $ref: '#/components/schemas/FacReinsurer'
        treaty:
          $ref: '#/components/schemas/Treaty'
        layerNumber:
          type: integer
          format: int32
        layerAmount:
          type: number
          format: double
        excessAmount:
          type: number
          format: double
        percentReinsurance:
          type: number
          format: double
        maolAmount:
          type: number
          format: double
        priority:
          type: integer
          format: int32
        isValid:
          type: boolean
    ExposureValue:
      type: object
      properties:
        id:
          type: integer
          format: int32
        code:
          type: string
        name:
          type: string
    PolicyCondition:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        isPredefined:
          type: boolean
        limit:
          type: number
          format: double
        deductible:
          type: number
          format: double
        deductibleType:
          $ref: '#/components/schemas/ExposureValue'
        conditionType:
          $ref: '#/components/schemas/ExposureValue'
        parentCondition:
          $ref: '#/components/schemas/ExposureValue'
        policyNumber:
          type: string
        policyConditionCriterias:
          type: array
          items:
            $ref: '#/components/schemas/PolicyConditionCriteria'
        percentOfLossDeductibleAmount:
          type: number
          format: double
        isFranchiseDeductible:
          $ref: '#/components/schemas/ExposureValue'
    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
    CopyPolicyInfo:
      type: object
      properties:
        id:
          type: integer
          format: int32
    LineOfBusiness:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
          maxLength: 20
          minLength: 0
      required:
      - name
    LocationCondition:
      type: object
      properties:
        locationId:
          type: integer
          format: int32
        conditionId:
          type: integer
          format: int32
        isIncluded:
          type: string
          enum:
          - NotIncluded
          - Included
          - UserIncluded
    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
    PolicySearchResult:
      type: object
      properties:
        matchCount:
          type: integer
          format: int64
        policies:
          type: array
          items:
            $ref: '#/components/schemas/Policy'
    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