Moody's RMS Risk Modeler API

openapi: 3.0.1
info:
  title: Risk Modeler
  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.'
paths:
  /v1/accounts:
    get:
      operationId: searchAccounts
      summary: Get accounts
      description: ''
      parameters:
        - name: datasource
          in: query
          description: Name of the EDM.
          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 `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 that are offset before the initial page of records returned. By default, _0_
          schema:
            type: integer
            format: int32
        - name: portfoliofilter
          in: query
          description: Indicates if search was triggered by portfolio.
          schema:
            type: boolean
        - name: policyExpirationDays
          in: query
          description: The date the latest policy expires.
          schema:
            type: integer
            format: int32
            default: 120
      responses:
        '200':
          description: List of accounts successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountSearchResult'
        '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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
    post:
      operationId: createAccount
      summary: Create account
      description: ''
      parameters:
        - name: datasource
          in: query
          description: Name of the EDM.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Account'
        required: true
      responses:
        '201':
          description: Account created.
          headers:
            Location:
              description: Account 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 "Edit Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  /v1/accounts/count:
    get:
      operationId: getExposureCountAccount
      summary: Count accounts
      description: ''
      parameters:
        - name: datasource
          in: query
          description: Name of the EDM.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Account count successfully retrieved.
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}':
    get:
      operationId: getAccount
      summary: Get account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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: Account information successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
    put:
      operationId: updateAccount
      summary: Update account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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/Account'
        required: true
      responses:
        '204':
          description: Validation 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 "Edit Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
    delete:
      operationId: deleteAccount
      summary: Delete account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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 `DELETE_ACCOUNT` 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 is denied or not authorized to perform the "Edit Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/analyses':
    get:
      operationId: getAccountAnalysesResults
      summary: Get results by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          required: true
          schema:
            type: integer
            format: int32
            minimum: 1
        - 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 `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 that are offset before the initial page of records returned. By default, _0_.
          schema:
            type: integer
            format: int32
        - name: userName
          in: query
          description: Name of <<glossary:principal>> that ran the analysis.
          schema:
            type: string
        - name: runDate
          in: query
          description: Date that the analysis was run.
          schema:
            type: string
      responses:
        '200':
          description: Analyses for exposure successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisSearchResult'
        '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'
      deprecated: true
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/copy':
    post:
      operationId: copyAccountsv1
      summary: Copy account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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/CopyAccountInfo'
        required: true
      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).'
          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 is denied or not authorized to perform the "Edit Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/geohaz':
    post:
      operationId: geohazAccount
      summary: Geohazard account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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:
              type: array
              items:
                $ref: '#/components/schemas/LayerInfo'
        required: true
      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).'
          headers:
            Location:
              description: url containing identifier of the submitted workflow.
              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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/convertcurrency':
    post:
      operationId: convertAccountCurrencyv1
      summary: Convert currency by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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:
          '*/*':
            schema:
              $ref: '#/components/schemas/Currency'
        required: true
      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).'
          headers:
            Location:
              description: workflowId
              style: simple
              schema:
                type: string
                format: URI
        '400':
          description: Bad Request. The input data is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "Edit Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/coordinate':
    get:
      operationId: getCoordinateByLatitudeAndLongitude
      summary: Get account locations
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          required: true
          schema:
            type: integer
            format: int32
            minimum: 1
        - name: datasource
          in: query
          description: Name of the EDM.
          required: true
          schema:
            type: string
        - name: latitude
          in: query
          description: Latitude coordinates.
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          description: Longitude coordinates.
          schema:
            type: number
            format: double
      responses:
        '200':
          description: Location coordinate retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Coordinate'
        '403':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/coordinates':
    get:
      operationId: getCoordinatesByAccount
      summary: Get location coordinates by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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 location coordinates retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Coordinate'
        '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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/countries':
    get:
      operationId: getCountriesByAccount
      summary: Get countries by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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 countries retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CountryMetrics'
        '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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/locationcount':
    get:
      operationId: getLocationCount
      summary: Count locations by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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: Number of locations is successfully retrieved.
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '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:
        - AccountV1
  '/v1/accounts/{id}/metrics':
    get:
      operationId: getAccountMetrics
      summary: Get metrics by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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: Metrics for a specified account are successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountMetrics'
        '400':
          description: 'Forbidden: Access to this resource is denied or not authorized to perform the "View Accounts" action.'
          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:
        - AccountV1
  '/v1/accounts/{id}/move':
    post:
      operationId: moveAccount
      summary: Move account to EDM
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          required: true
          schema:
            type: integer
            format: int32
            minimum: 1
        - name: option
          in: query
          description: Include (`1`) or exclude (`0`) locations in moved account.
          schema:
            type: integer
            format: int32
            maximum: 1
            minimum: 0
        - name: datasource
          in: query
          description: Name of the EDM.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Account successfully moved.
          headers:
            Location:
              description: URI for newly created account
              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 Accounts" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  '/v1/accounts/{id}/policycount':
    get:
      operationId: getPolicyCount
      summary: Count policies by account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          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: Number of policies is successfully retrieved.
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '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:
        - AccountV1
  '/v1/accounts/{id}/process':
    post:
      operationId: processAccount
      summary: Analyze account
      description: ''
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          required: true
          schema:
            type: integer
            format: int32
            minimum: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessInput'
        required: true
      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).'
          headers:
            Location:
              description: url containing identifier of the submitted workflow.
              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 "Add to Analysis Builder" action.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      deprecated: true
      security:
        - RMS_Auth: []
      tags:
        - AccountV1
  /v1/accounts/{id}/reports:
    get:
      tags:
        - AccountV1
      summary: Get account reports
      description: ' '
      operationId: accountReportsv1
      parameters:
        - name: id
          in: path
          description: ID number of the account.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - 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 `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 on the 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 reports successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportListSearchResult'
        '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 Accounts" action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
        - RMS_Auth: []
  '/v1/accounts/{id}/sites':
    get:
      operationId: getSiteNames
      summary: Get sites by ac

# --- truncated at 32 KB (951 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moodys-rms/refs/heads/main/openapi/moodys-rms-risk-modeler-openapi.yml