openapi: 3.2.0
info:
  title: Risk Modeler Domains 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: DomainsV1
paths:
  /v1/domains:
    get:
      operationId: getDomainsv1
      summary: Get domains
      description: ''
      responses:
        '200':
          description: List of domains is successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainReference'
        '403':
          description: 'Forbidden: Access to this resource has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - DomainsV1
  /v1/domains/{domainname}/tablespace:
    get:
      operationId: getTablespacesv1
      summary: Get tablespaces
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of table spaces for a domain is successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainReference'
        '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:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities:
    get:
      operationId: getEntitiesv1
      summary: Get entities by domain tablespace
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of entities for a domain tablespace is successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DomainReference'
        '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:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities/{entity}:
    get:
      operationId: getEntitiesMetaOrValuesv1
      summary: Get entity by domain tablespace
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Metadata for an entity in a domain tablespace is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMeta'
        '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:
      - DomainsV1
    post:
      operationId: createCurrencyv1
      summary: Create currency
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyValueStore'
      responses:
        '201':
          description: Created. New Currency is created in the data source successfully.
          headers:
            Location:
              description: Location of the Currency 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 has been denied.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: Conflict. Resource already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
      security:
      - RMS_Auth: []
      tags:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities/{entity}/hazards:
    get:
      operationId: getHazardsv1
      summary: Get hazards
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      - name: jsonfield
        in: query
        description: Name of the field user wants to fetch in the hazards.
        required: true
        schema:
          type: string
      - name: option
        in: query
        description: Optional attribute to filter the values. Defaults to returning all values.
        schema:
          type: string
      - name: tag
        in: query
        description: Name of the metadata tag.
        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: sortby
        in: query
        description: The name of the field on which to sort the results.
        schema:
          type: string
      - name: sortorder
        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 offset before the first page of returned records. By default, _0_.

          '
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of hazards for a specified domain/tablespace/entity is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResult'
        '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:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities/{entity}/meta:
    get:
      operationId: getEntityAttributesv1
      summary: Get attributes domain tablespace entity
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      - name: tag
        in: query
        description: Name of the metadata tag.
        schema:
          type: string
      responses:
        '200':
          description: Attributes for a specified entry in a domain tablespace are successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResult'
        '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:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities/{entity}/secondarymodifiers:
    get:
      operationId: getSecondaryModifiersv1
      summary: Get secondary modifiers
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      - name: jsonfield
        in: query
        description: Name of the field user wants to fetch in the secondary modifiers.
        required: true
        schema:
          type: string
      - name: option
        in: query
        description: Optional attribute to filter the values. Defaults to returning all values.
        schema:
          type: string
      - name: tag
        in: query
        description: Name of the metadata tag.
        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: sortby
        in: query
        description: The name of the field on which to sort the results.
        schema:
          type: string
      - name: sortorder
        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 offset before the first page of returned records \ starting at _0_.'
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: List of secondary modifiers for a specified domain/tablespace/entity is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecondaryModifierResult'
        '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:
      - DomainsV1
  /v1/domains/{domainname}/tablespace/{tablespace}/entities/{entity}/values:
    get:
      operationId: getEntityValuesv1
      summary: Get entity values
      description: ''
      parameters:
      - name: domainname
        in: path
        description: Name of the domain.
        required: true
        schema:
          type: string
      - name: tablespace
        in: path
        description: Name of the tablespace.
        required: true
        schema:
          type: string
      - name: entity
        in: path
        description: Name of the entity.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: Comma delimited list of fields to be fetched. Defaults to all.
        schema:
          type: string
      - name: tag
        in: query
        description: Name of the metadata tag.
        schema:
          type: string
      - name: attributename
        in: query
        schema:
          type: string
      - name: sortby
        in: query
        description: This parameter is not currently used.
        schema:
          type: string
      - name: sortorder
        in: query
        description: This parameter is not currently used.
        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
      - name: filter
        in: query
        description: Optional attribute to filter the values. Defaults to returning all values.
        schema:
          type: string
      responses:
        '200':
          description: Values for a specified domain/tablespace/entity is successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResult'
        '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:
      - DomainsV1
components:
  schemas:
    Field:
      type: object
      properties:
        name:
          type: string
        type:
          type: string
        nullable:
          type: boolean
        primaryKey:
          type: boolean
        metadata:
          type: object
          additionalProperties:
            type: object
    SecondaryModifierItem:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    SecondaryModifierResult:
      type: object
      properties:
        secondaryModifiersTotalMatch:
          type: integer
          format: int64
        secondaryModifierItem:
          type: array
          items:
            $ref: '#/components/schemas/SecondaryModifierItem'
    KeyValueStore:
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
    EntityItem:
      type: object
      properties:
        domainName:
          type: string
        tableSpace:
          type: string
        tableName:
          type: string
        dataOwnedBy:
          type: string
        values:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
        isActive:
          type: boolean
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        logId:
          type: string
    DomainResult:
      type: object
      properties:
        attributesTotalMatch:
          type: integer
          format: int64
        domainItems:
          $ref: '#/components/schemas/DomainItem'
    DomainReference:
      type: object
      properties:
        name:
          type: string
        uri:
          type: string
          format: uri
    EntityMeta:
      type: object
      properties:
        meta:
          type: string
          format: uri
        values:
          type: string
          format: uri
    EntityResult:
      type: object
      properties:
        entitiesTotalMatch:
          type: integer
          format: int64
        entityItems:
          $ref: '#/components/schemas/EntityItem'
    DomainSchema:
      type: object
      properties:
        type:
          type: string
        fields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
    DomainItem:
      type: object
      properties:
        domainName:
          type: string
        tableSpace:
          type: string
        tableName:
          type: string
        dataOwnedBy:
          type: string
        domainSchema:
          $ref: '#/components/schemas/DomainSchema'
        isActive:
          type: boolean
  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