rs-translator.yaml

openapi: 3.0.0
servers:
- description: RS Configurations API
  url: https://translations.rs.demo.korfinancial.com
info:
  x-audience: external-public
  x-api-id: 88522688-caeb-47f6-9e7e-bac59f52e67a
  description: Provides services managing fields and rules
  version: 1.0.0
  title: RS Configurations API
  contact:
    name: KOR Engineering
    email: support@korfinancial.com
    url: https://www.korfinancial.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
tags:
- name: Uploads
  description: API responsible of managing uploads
- name: Fields
  description: API responsible of managing client field configurations
- name: ParkedMessages
  description: API responsible of managing parked messages
- name: Rules
  description: API responsible of managing client rules
- name: Functions
  description: API responsible of defining the functions
- name: Products
  description: API responsible of managing products
- name: Entities
  description: API responsible of managing entities
- name: Relationships
  description: API responsible of managing relationships
- name: DataFeeds
  description: API responsible of managing data feeds
- name: RuleSets
  description: API responsible of managing rule sets
paths:
  /uploads:
    get:
      tags:
      - Uploads
      summary: Query a list of uploads
      description: Query a list of uploads
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      - in: query
        name: query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D'
          nullable: true
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>clientIdentifier: text</li>
            <li>status: text</li>
            <li>startedTimestamp: date</li>
            <li>processedTimestamp: date</li>
            <li>completedTimestamp: date</li>
            <li>identifier: text</li>
            <li>processedSubmissions: integer</li>
            <li>failedSubmissions: integer</li>
            <li>type: text</li>
            <li>deliveryMechanism: text</li>
            <li>fileName: text</li>
            <li>userIdentifier: text</li>
          </ul>
      responses:
        200:
          description: Uploads page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadsSearchResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /uploads/{uploadIdentifier}:
    get:
      tags:
      - Uploads
      summary: Query the details of an upload
      description: Query the details of an upload
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: uploadIdentifier
        description: The upload identifier
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      responses:
        200:
          description: The upload details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /uploads/{uploadIdentifier}/resolution:
    post:
      tags:
      - Uploads
      summary: Resolve the failed upload by ignoring it
      description: Create a resolution of the failed upload by ignoring the failed upload
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: uploadIdentifier
        description: KOR generated unique and random identifier for the failed upload
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResolutionRequestObject'
      responses:
        202:
          description: Resolve failed upload accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /uploads/resolution:
    post:
      tags:
      - Uploads
      summary: Resolve the failed uploads by ignoring it
      description: Create a resolution of the failed uploads by ignoring the failed uploads
      security:
      - OAuth2:
        - openid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResolutionsRequestObject'
      responses:
        202:
          description: Resolve failed uploads accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /clients/{entityIdentifier}/uploads/reprocesses:
    post:
      tags:
      - Uploads
      summary: Reprocess of upload
      description: Reprocess of upload with optional row numbers.
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReprocessesUploadPayload'
      responses:
        202:
          description: Reprocess upload has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifiers:
                    type: array
                    items:
                      type: string
                    example:
                    - EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/uploads/reprocesses-by-criterion:
    post:
      tags:
      - Uploads
      summary: Reprocess of upload
      description: Reprocess of upload with rejection criteria
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReprocessesUploadByCriterionPayload'
      responses:
        202:
          description: Reprocess upload has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/fields:
    get:
      tags:
      - Fields
      summary: Get all fields
      description: Get all fields
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Fields page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fields'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/fields/{fieldIdentifier}:
    get:
      tags:
      - Fields
      summary: Get a field by identifier
      description: Get a field by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: path
        name: fieldIdentifier
        description: The identifier of the field
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: The field details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /parked-messages:
    get:
      tags:
      - ParkedMessages
      summary: Query a list of parked messages
      description: Query a list of parked messages
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      - in: query
        name: query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D'
          nullable: true
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>identifier: text</li>
            <li>tradeIdentifier: text</li>
            <li>jurisdiction: text</li>
            <li>messageType: text</li>
            <li>deliveryMechanism: text</li>
            <li>clientPayloadContentType: text</li>
            <li>timestamp: date</li>
          </ul>
      responses:
        200:
          description: Parked messages page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParkedMessagesSearchResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /parked-messages/{parkedMessageIdentifier}:
    get:
      tags:
      - ParkedMessages
      summary: Query the details of a parked message
      description: Query the details of a parked message
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: parkedMessageIdentifier
        description: The parked message identifier
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      responses:
        200:
          description: The parked message details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParkedMessageDetails'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /parked-messages/{parkedMessageIdentifier}/resolution:
    post:
      tags:
      - ParkedMessages
      summary: Resolve the parked message by ignoring it
      description: Create a resolution of the parked message by ignoring the parked message
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: parkedMessageIdentifier
        description: KOR generated unique and random identifier for the parked message
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResolutionRequestObject'
      responses:
        202:
          description: Resolve parked message accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /parked-messages/resolution:
    post:
      tags:
      - ParkedMessages
      summary: Resolve the parked messages by ignoring it
      description: Create a resolution of the parked messages by ignoring the parked messages
      security:
      - OAuth2:
        - openid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResolutionsRequestObject'
      responses:
        202:
          description: Resolve parked messages accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /rules:
    get:
      tags:
      - Rules
      summary: Get all rules
      description: Get all rules
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        description: Base64-encoded string containing the search query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22uniqueProductIdentifier%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22QZLNBTG6X7H9%22%2C%22QZLNBTG6X7H9%22%5D%7D'
          nullable: true
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: rules page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rules'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /rules/{ruleId}:
    get:
      tags:
      - Rules
      summary: Get rule by identifier
      description: Get rule by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: ruleId
        description: The rule identifier
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      responses:
        200:
          description: rules page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/rules:
    post:
      tags:
      - Rules
      summary: Submit a rule
      description: Create a new rule
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleCreationRequest'
      responses:
        202:
          description: Rule has been created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleCreationResponse'
          headers:
            Location:
              description: The URI of the newly created rule
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/rules/abcd-1111-defg-abc123
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/rules/synchronizations:
    put:
      tags:
      - Rules
      summary: Synchronize the rules
      description: Synchronize a number of rules from another environment. Optionally copying them over to a different rule set.
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynchronizeRulesRequest'
      responses:
        202:
          description: The rules synchronizations request has been accepted for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynchronizeRulesResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/rules/{ruleId}:
    delete:
      tags:
      - Rules
      summary: Delete my rule
      description: Delete an existing rule
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: ruleId
        description: The identifier of the rule
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        202:
          description: Rule delete has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
    put:
      tags:
      - Rules
      summary: Update a rule
      description: Update a new rule
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: ruleId
        description: The identifier of the rule
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleUpdateRequest'
      responses:
        202:
          description: Rule update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /function-definitions:
    get:
      tags:
      - Functions
      summary: Get all function definitions
      description: Get all function definitions available for the client
      security:
      - OAuth2:
        - openid
      responses:
        200:
          description: Function definitions retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionDefinitions'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /products:
    get:
      tags:
      - Products
      summary: Get all products
      description: Get all products
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D'
          nullable: true
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>internalIdentifier: text</li>
            <li>assetClass: text</li>
            <li>uniqueProductIdentifier: text</li>
            <li>productName: text</li>
            <li>isdaTaxonomy: text</li>
            <li>createdTimestamp: date</li>
            <li>lastModifiedTimestamp: date</li>
            <li>cftcReportable:boolean</li>
            <li>caReportable: boolean</li>
            <li>secReportable: boolean</li>
            <li>esmaReportable: boolean</li>
            <li>fcaReportable: boolean</li>
            <li>asicReportable: boolean</li>
            <li>masReportable: boolean</li>
          </ul>
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: Products page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Products'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /products/{productIdentifier}:
    get:
      tags:
      - Products
      summary: Get product by identifier
      description: Get product by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: productIdentifier
        description: The identifier of the product
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Product retrieved
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    identifier:
                      type: string
                      format: uuid
                      example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
                    lastModifiedTimestamp:
                      description: Timestamp when the product was modified
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    createdTimestamp:
                      description: Timestamp when the other entity was created
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                - $ref: '#/components/schemas/ProductDetail'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/products:
    post:
      tags:
      - Products
      summary: Create product
      description: Create product
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductDetail'
      responses:
        202:
          description: Product has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    format: uuid
                    example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          headers:
            Location:
              description: The URI of the newly created product
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/products/abcd-1111-defg-abc123
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/products/{productIdentifier}:
    put:
      tags:
      - Products
      summary: Update product
      description: Update an existing product
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: productIdentifier
        description: The identifier of the product
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductDetail'
      responses:
        202:
          description: Product update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
    delete:
      tags:
      - Products
      summary: Delete product
      description: Delete an existing product
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: productIdentifier
        description: The identifier of the product
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        202:
          description: Product delete has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /entities:
    get:
      tags:
      - Entities
      summary: Get entities
      description: Get entities
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>identifier: text</li>
            <li>legalName: text</li>
            <li>shortName: text</li>
            <li>internalIdentifiers: text</li>
            <li>country: text</li>
            <li>createdTimestamp: date</li>
            <li>lastModifiedTimestamp: date</li>
            <li>ruleReferenceId: text</li>
            <li>ruleKdmFieldName: text</li>
            <li>ruleVersion: text</li>
          </ul>
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22internalId%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%2227ID%22%2C%2228ID%22%5D%7D'
          nullable: true
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: Entities page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entities'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /entities/{entityIdentifier}:
    get:
      tags:
      - Entities
      summary: Get entity by identifier
      description: Get entity by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: The identifier of entity
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Entity retrieved
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    identifier:
                      type: string
                      format: uuid
                      example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
                    lastModifiedTimestamp:
                      description: Timestamp when the other entity was modified
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    createdTimestamp:
                      description: Timestamp when the other entity was created
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    warnings:
                      type: array
                      nullable: true
                      items:
                        $ref: '#/components/schemas/Warning'
                    failureReason:
                      type: string
                      nullable: true
                    clientPayload:
                      type: string
                      nullable: true
                    supplementalData:
                      $ref: '#/components/schemas/SupplementalData'
                    status:
                      description: The status of the entity's processing
                      type: string
                      x-extensible-enum:
                      - PROCESSED
                      - PROCESSING_FAILED
                    kdmRuleReferences:
                      type: array
                      items:
                        $ref: '#/components/schemas/KdmRuleReference'
                - $ref: '#/components/schemas/EntityDetail'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /relationships:
    get:
      tags:
      - Relationships
      summary: Get relationships
      description: Get relationships
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>myEntityInternalIdentifier: text</li>
            <li>otherEntityInternalIdentifier: text</li>
            <li>interAffiliate: text</li>
            <li>utiCreator: text</li>
            <li>cftcReportingEntity: text</li>
            <li>secReportingEntity: text</li>
            <li>esmaMyReportingEntity: text</li>
            <li>esmaOtherReportingEntity: text</li>
            <li>fcaMyReportingEntity: text</li>
            <li>fcaOtherReportingEntity: text</li>
            <li>caReportingEntity: text</li>
            <li>asicMyReportingEntity: text</li>
            <li>asicOtherReportingEntity: text</li>
            <li>masMyReportingEntity: text</li>
            <li>masOtherReportingEntity: text</li>
            <li>ruleReferenceId: text</li>
            <li>ruleKdmFieldName: text</li>
            <li>ruleVersion: text</li>
            <li>identifier: text</li>
          </ul>
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22internalId%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%2227ID%22%2C%2228ID%22%5D%7D'
          nullable: true
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: Relationships page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Relationships'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /relationships/{relationshipIdentifier}:
    get:
      tags:
      - Relationships
      summary: Get relationship by identifier
      description: Get relationship by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: relationshipIdentifier
        description: The identifier of relationship
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Relationship retrieved
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    identifier:
                      type: string
                      format: uuid
                      example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
                    lastModifiedTimestamp:
                      description: Timestamp when the other entity was modified
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    createdTimestamp:
                      description: Timestamp when the other entity was created
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    warnings:
                      type: array
                      nullable: true
                      items:
                        $ref: '#/components/schemas/Warning'
                    failureReason:
                      type: string
                      nullable: true
                    clientPayload:
                      type: string
                      nullable: true
                    supplementalData:
                      $ref: '#/components/schemas/SupplementalData'
                    status:
                      description: The status of the relationship's processing
                      type: string
                      x-extensible-enum:
                      - PROCESSED
                      - PROCESSING_FAILED
                    kdmRuleReferences:
                      type: array
                      items:
                        $ref: '#/components/schemas/KdmRuleReference'
                - $ref: '#/components/schemas/RelationshipDetail'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/entities:
    post:
      tags:
      - Entities
      summary: Create entity
      description: Create entity
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityDetail'
      responses:
        202:
          description: Entity has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    format: uuid
                    example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          headers:
            Location:
              description: The URI of the newly created entity
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/entities/abcd-1111-defg-abc123
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityId}/entities/{entityIdentifier}:
    put:
      tags:
      - Entities
      summary: Update an entity
      description: Update an existing entity
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: entityIdentifier
        description: The identifier of the entity
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityDetail'
      responses:
        202:
          description: Entity update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
    delete:
      tags:
      - Entities
      summary: Delete an entity
      description: Delete an existing entity
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: entityIdentifier
        description: The identifier of the entity
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        202:
          description: Entity delete has been accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        415:
          description: Unsupported Media Type
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /clients/{entityId}/relationships:
    post:
      tags:
      - Relationships
      summary: Create relationship
      description: Create relationship
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationshipDetail'
      responses:
        202:
          description: Relationship has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    format: uuid
                    example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          headers:
            Location:
              description: The URI of the newly created relationship
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/relationships/abcd-1111-defg-abc123
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityId}/relationships/{relationshipIdentifier}:
    put:
      tags:
      - Relationships
      summary: Update a relationship
      description: Update an existing relationship
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: relationshipIdentifier
        description: The identifier of the relationship
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationshipDetail'
      responses:
        202:
          description: Relationship update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
    delete:
      tags:
      - Relationships
      summary: Delete an relationship
      description: Delete an existing relationship
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: relationshipIdentifier
        description: The identifier of the relationship
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        202:
          description: Relationship delete has been accepted
        400:
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        401:
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        403:
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        404:
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        405:
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        406:
          description: Not Acceptable
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        415:
          description: Unsupported Media Type
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        500:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        504:
          description: Gateway Timeout
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: Internal Server Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
  /data-feeds:
    get:
      tags:
      - DataFeeds
      summary: Get all data feeds
      description: Get all data feeds
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D'
          nullable: true
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>identifier: text</li>
            <li>lastModifiedTimestamp: date</li>
          </ul>
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: Data feeds page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFeeds'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /data-feeds/{dataFeedIdentifier}:
    get:
      tags:
      - DataFeeds
      summary: Get data feed by identifier
      description: Get data feed by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: dataFeedIdentifier
        description: The identifier of the data feed
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Data Feed retrieved
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    identifier:
                      type: string
                      format: uuid
                      example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
                    lastModifiedTimestamp:
                      description: Timestamp when the data feed was modified
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    createdTimestamp:
                      description: Timestamp when the data feed was created
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                - $ref: '#/components/schemas/DataFeedDetail'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/data-feeds:
    post:
      tags:
      - DataFeeds
      summary: Create data feed
      description: Create data feed
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFeedCreateRequest'
      responses:
        202:
          description: Data Feed has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    format: uuid
                    example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          headers:
            Location:
              description: The URI of the newly created data feed
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/data-feeds/EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/data-feeds/{dataFeedIdentifier}:
    put:
      tags:
      - DataFeeds
      summary: Update data feed
      description: Update an existing data feed
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: dataFeedIdentifier
        description: The identifier of the data feed
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFeedUpdateRequest'
      responses:
        202:
          description: Data Feed update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /rule-sets:
    get:
      tags:
      - RuleSets
      summary: Get all rule sets
      description: Get all rule sets
      security:
      - OAuth2:
        - openid
      parameters:
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          nullable: true
      - in: query
        name: cursor
        description: The cursor to get the next page, empty returns the first page
        required: false
        schema:
          type: string
          nullable: true
      - in: query
        name: query
        required: false
        schema:
          type: string
          example: '%7B%22p%22%3A%5B%22field%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22value1%22%2C%22value2%22%5D%7D'
          nullable: true
        description: |
          URL encoded JSON string containing the search query with various filter options.<br/> <b>JSON Structure</b> <p>The following JSON snippet can be passed in through an HTTP query parameter URL encoded:</p> <p> <code>{"lf": "and", "q": [{"p": ["field"], "cf": "eq", "v": ["value"]}]}</code> </p> <br /> <b>Possible "cf" Values</b> <p>The "cf" field can have the following values based on data types:</p> <b>Integers:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>String:</b> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'ct' (Contains)</li> </ul> <b>Dates:</b> <p>Represented as a unix timestamp as <b>long</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> <li>'gt' (Greater Than)</li> <li>'gte' (Greater Than or Equals)</li> <li>'lt' (Less Than)</li> <li>'lte' (Less Than or Equals)</li> </ul> <b>Boolean:</b> <p>Represented as the strings <b>true</b> or <b>false</b></p> <ul> <li>'neq' (Not Equals)</li> <li>'eq' (Equals)</li> </ul> <b>Supported fields and their corresponding types:</b> <ul>
            <li>identifier: text</li>
            <li>name: text</li>
            <li>createdTimestamp: date</li>
            <li>lastModifiedTimestamp: date</li>
          </ul>
      - in: query
        name: pageSize
        description: Max amount of results that should be returned
        required: false
        schema:
          type: integer
          nullable: true
      - in: query
        name: scroll
        description: A flag to define you intent to scroll through your results
        required: false
        schema:
          type: boolean
          nullable: true
      responses:
        200:
          description: Rule sets page retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleSets'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /rule-sets/{ruleSetIdentifier}:
    get:
      tags:
      - RuleSets
      summary: Get rule set by identifier
      description: Get rule set by identifier
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: ruleSetIdentifier
        description: The identifier of the rule set
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      - in: query
        name: entityId
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: false
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        200:
          description: Rule Set retrieved
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    identifier:
                      type: string
                      format: uuid
                      example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
                    lastModifiedTimestamp:
                      description: Timestamp when the rule set was modified
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                    createdTimestamp:
                      description: Timestamp when the rule set was created
                      type: string
                      format: date-time
                      example: "2020-05-28T14:07:17Z"
                      nullable: true
                - $ref: '#/components/schemas/RuleSetDetail'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/rule-sets:
    post:
      tags:
      - RuleSets
      summary: Create rule set
      description: Create rule set
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleSetCreateRequest'
      responses:
        202:
          description: Rule Set has been accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  identifier:
                    type: string
                    format: uuid
                    example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
          headers:
            Location:
              description: The URI of the newly created rule set
              schema:
                type: string
              example: https://translations.<placeholder>.korfinancial.com/rule-sets/EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
  /clients/{entityIdentifier}/rule-sets/{ruleSetIdentifier}:
    put:
      tags:
      - RuleSets
      summary: Update rule set
      description: Update an existing rule set
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: ruleSetIdentifier
        description: The identifier of the rule set
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuleSetUpdateRequest'
      responses:
        202:
          description: Rule Set update has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
    delete:
      tags:
      - RuleSets
      summary: Delete rule set
      description: Delete an existing rule set
      security:
      - OAuth2:
        - openid
      parameters:
      - in: path
        name: entityIdentifier
        description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details.
        required: true
        schema:
          type: string
          format: uuid
          example: 3AE803B1-5765-481D-BFAB-D176679D7D8C
      - in: path
        name: ruleSetIdentifier
        description: The identifier of the rule set
        required: true
        schema:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
      responses:
        202:
          description: Rule set delete has been accepted
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        406:
          $ref: '#/components/responses/406'
        415:
          $ref: '#/components/responses/415'
        500:
          $ref: '#/components/responses/500'
        504:
          $ref: '#/components/responses/504'
        default:
          $ref: '#/components/responses/default'
components:
  responses:
    400:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    401:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    403:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    404:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    405:
      description: Method Not Allowed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    406:
      description: Not Acceptable
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    415:
      description: Unsupported Media Type
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    500:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    504:
      description: Gateway Timeout
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    default:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  schemas:
    UploadsSearchResult:
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) uploads
      type: object
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of items
          type: array
          items:
            $ref: '#/components/schemas/Upload'
    Upload:
      description: Basic information of an upload of one or more submissions
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        clientIdentifier:
          type: string
          format: uuid
          example: 85DA13C0-6288-11EE-AE5D-0800200C9A66
        userIdentifier:
          type: string
          format: uuid
          example: 8F90F460-6288-11EE-AE5D-0800200C9A66
        origin:
          type: string
          example: API or SFTP
        status:
          $ref: '#/components/schemas/UploadStatus'
        fileName:
          type: string
          example: filename.json
        type:
          $ref: '#/components/schemas/UploadType'
        deliveryMechanism:
          $ref: '#/components/schemas/DeliveryMechanism'
        startedTimestamp:
          description: Timestamp when the upload was started
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        completedTimestamp:
          description: Timestamp when the upload was completed
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        processedTimestamp:
          description: Timestamp when the upload was processed
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        ignoredTimestamp:
          description: Timestamp when the failed upload was ignored
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        processedSubmissions:
          description: Total number of submissionsProcessed submissions
          type: integer
        failedSubmissions:
          description: Number of submissionsFailed submissions
          type: integer
        failureReason:
          type: string
          example: When status is failed provides the reason of failure
          nullable: true
        permissions:
          $ref: '#/components/schemas/UploadPermissions'
    UploadDetails:
      description: Detailed information of an upload
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        clientIdentifier:
          type: string
          format: uuid
          example: 85DA13C0-6288-11EE-AE5D-0800200C9A66
        userIdentifier:
          type: string
          format: uuid
          example: 8F90F460-6288-11EE-AE5D-0800200C9A66
        origin:
          type: string
          example: API or SFTP
        status:
          $ref: '#/components/schemas/UploadStatus'
        fileName:
          type: string
          example: filename.json
        type:
          $ref: '#/components/schemas/UploadType'
        deliveryMechanism:
          $ref: '#/components/schemas/DeliveryMechanism'
        startedTimestamp:
          description: Timestamp when the upload was started
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        completedTimestamp:
          description: Timestamp when the upload was completed
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        processedTimestamp:
          description: Timestamp when the upload was processed
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        ignoredTimestamp:
          description: Timestamp when the failed upload was ignored
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        processedSubmissions:
          description: Total number of submissionsProcessed submissions
          type: integer
        failedSubmissions:
          description: Number of submissionsFailed submissions
          type: integer
        failureReason:
          type: string
          example: When status is failed provides the reason of failure
          nullable: true
        permissions:
          $ref: '#/components/schemas/UploadPermissions'
    UploadStatus:
      description: The status of the upload
      type: string
      x-extensible-enum:
      - RECEIVED
      - PROCESSING
      - PROCESSED
      - FAILED
      - UPLOADED
      - IGNORED
      - NONE
    UploadType:
      description: The type of the upload
      type: string
      x-extensible-enum:
      - CSV
      - JSON
    DeliveryMechanism:
      description: The delivery mechanism that upload was ingested
      type: string
      x-extensible-enum:
      - API
      - UI
      - KOR_SFTP
      - CLIENT_SFTP
    ParkedType:
      description: The type of the parked message, reflecting the reason why it was parked
      type: string
      x-extensible-enum:
      - REHYDRATING_TRADE_STATE
      - PRIOR_UNRESOLVED_REJECTION
      - PRECEDING_TRADE_EVENT_PENDING
    ParkedMessageLineage:
      description: The lineage of the submission that created the parked message
      type: object
      properties:
        ingestionIdentifier:
          description: The ingestion identifier
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        ingestionType:
          description: The ingestion type
          type: string
          x-extensible-enum:
          - SINGLE_ENTRY
          - UPLOAD
        ingestionIndex:
          description: The ingestion index
          type: integer
          nullable: true
        dataFeedIdentifier:
          description: The data feed identifier
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        originalSubmissionIdentifier:
          description: The original submission identifier that created the parked message
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    CreateResolutionRequestObject:
      type: object
      required:
      - resolution
      properties:
        resolution:
          type: string
          description: The resolution of the failed upload
          x-extensible-enum:
          - IGNORED
    CreateResolutionsRequestObject:
      type: object
      required:
      - resolution
      - identifiers
      properties:
        resolution:
          type: string
          description: The resolution of the failed uploads
          x-extensible-enum:
          - IGNORED
        identifiers:
          type: array
          description: The list of identifiers of failed uploads
          items:
            type: string
    Fields:
      description: Page of fields
      type: object
      properties:
        items:
          description: List of fields
          type: array
          items:
            $ref: '#/components/schemas/Field'
    Field:
      description: Overview of a field needed for a client mapping
      type: object
      required:
      - name
      - status
      - category
      properties:
        name:
          type: string
        description:
          type: string
        status:
          type: string
          nullable: true
          x-extensible-enum:
          - MAPPED
          - NOT_MAPPED
        type:
          type: string
          nullable: true
          x-extensible-enum:
          - ENTITY
          - RELATIONSHIP
          - PRODUCT
          - HUB
        category:
          $ref: '#/components/schemas/Category'
        group:
          nullable: true
          allOf:
          - $ref: '#/components/schemas/Group'
        enabled:
          type: boolean
        appliesOn:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            ESMA:
            - Transaction
            - Valuation
            CFTC:
            - Valuation
            CA:
            - Collateral
    FieldDetails:
      description: Details of the field needed for a client mapping
      type: object
      required:
      - name
      - status
      - category
      properties:
        name:
          type: string
        description:
          type: string
        status:
          type: string
          x-extensible-enum:
          - MAPPED
          - NOT_MAPPED
        category:
          $ref: '#/components/schemas/Category'
        group:
          $ref: '#/components/schemas/Group'
    ParkedMessagesSearchResult:
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) parked messages
      type: object
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of items
          type: array
          items:
            $ref: '#/components/schemas/ParkedMessage'
    ParkedMessage:
      description: Basic information of a parked message
      type: object
      properties:
        identifier:
          description: The identifier of the parked message
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        tradeIdentifier:
          description: The identifier of the trade that the parked message is related to
          type: string
          format: uuid
          example: 5D4B7224-90BA-4489-9C8C-5D54867C2437
        clientIdentifier:
          description: The identifier of the client that submitted the parked message
          type: string
          format: uuid
          example: 85DA13C0-6288-11EE-AE5D-0800200C9A66
        userIdentifier:
          description: The identifier of the user that submitted the parked message
          type: string
          format: uuid
          example: 8F90F460-6288-11EE-AE5D-0800200C9A66
        parkedType:
          $ref: '#/components/schemas/ParkedType'
        jurisdiction:
          description: The jurisdiction of the parked message
          type: string
          example: CFTC
        messageType:
          description: The message type of the parked message
          type: string
          example: TRANSACTION
        clientPayloadContentType:
          $ref: '#/components/schemas/UploadType'
        deliveryMechanism:
          $ref: '#/components/schemas/DeliveryMechanism'
        timestamp:
          description: Timestamp when the parked message was parked
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
        lineage:
          $ref: '#/components/schemas/ParkedMessageLineage'
        permissions:
          $ref: '#/components/schemas/ParkedMessagePermissions'
    ParkedMessageDetails:
      description: Detailed information of a parked message
      type: object
      properties:
        identifier:
          description: The identifier of the parked message
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        tradeIdentifier:
          description: The identifier of the trade that the parked message is related to
          type: string
          format: uuid
          example: 5D4B7224-90BA-4489-9C8C-5D54867C2437
        clientIdentifier:
          description: The identifier of the client that submitted the parked message
          type: string
          format: uuid
          example: 85DA13C0-6288-11EE-AE5D-0800200C9A66
        userIdentifier:
          description: The identifier of the user that submitted the parked message
          type: string
          format: uuid
          example: 8F90F460-6288-11EE-AE5D-0800200C9A66
        parkedType:
          $ref: '#/components/schemas/ParkedType'
        jurisdiction:
          description: The jurisdiction of the parked message
          type: string
          example: CFTC
        messageType:
          description: The message type of the parked message
          type: string
          example: TRANSACTION
        clientPayload:
          description: The payload of the parked message
          type: string
          example: '{"field": "value"}'
        clientPayloadContentType:
          $ref: '#/components/schemas/UploadType'
        deliveryMechanism:
          $ref: '#/components/schemas/DeliveryMechanism'
        timestamp:
          description: Timestamp when the parked message was parked
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
        lineage:
          $ref: '#/components/schemas/ParkedMessageLineage'
        supplementalData:
          $ref: '#/components/schemas/SupplementalData'
        permissions:
          $ref: '#/components/schemas/ParkedMessagePermissions'
    SupplementalData:
      type: object
      description: Supplemental data matched to the parked message
      properties:
        clientPayloadString:
          type: string
          description: The contents of the matched supplemental data
          example: {}
          nullable: false
        ingestionIndex:
          type: integer
          description: The index of the matched supplemental data entry inside the supplemental data file
          example: 12
          nullable: true
        errorMessage:
          type: string
          description: The value of the supplemental data
          example: Equity
          nullable: true
    ParkedMessagePermissions:
      type: object
      description: Experimental. The permissions the user has on a resource
      properties:
        canDelete:
          type: boolean
          description: Experimental. Whether a user can delete the resource
          example: true
    RuleCreationRequest:
      description: Model for rule creation
      type: object
      required:
      - targetKDMFieldName
      - ruleSets
      - functions
      properties:
        note:
          description: The note that documents the purpose of the rule and the changes that happened to it
          type: string
          example: Initial version for the CFTC mandate
        ruleSets:
          description: The rule sets that this rule is part of
          type: array
          items:
            description: A rule set identifier
            type: string
            format: uuid
            example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        functions:
          description: The function definitions that will apply to the KDM field
          type: array
          items:
            $ref: '#/components/schemas/Function'
        targetKDMFieldName:
          description: The KDMField that the rule has to be applied on
          type: string
          example: assetClass
        ruleMetadata:
          description: Overview of the rule metadata
          type: string
          example: '{"connections":[{"id":"4568e6983fef85d9","source":"2d7bc70c10f8db77","sourceOutput":"outputKDMField","target":"d75cd0beba2bf8b0","targetInput":"upperFuncInput_argument0"},{"id":"660c0766dc3599aa","source":"d75cd0beba2bf8b0","sourceOutput":"upperFuncOutput","target":"e25c88e883e204a6","targetInput":"mandateInput"}],"targetKDMField":{"id":"2d7bc70c10f8db77","value":{"x":-133.265625,"y":-38.0546875}}}'
        status:
          $ref: '#/components/schemas/RuleStatus'
    RuleCreationResponse:
      description: Model for rule creation response
      type: object
      properties:
        identifier:
          type: string
    RuleUpdateRequest:
      description: Model for rule update
      type: object
      required:
      - note
      - functions
      properties:
        note:
          description: The note that documents the purpose of the rule and the changes that happened to it
          type: string
          example: Updated to also cover the ESMA mandate
        ruleSets:
          description: The rule sets that this rule is part of
          type: array
          items:
            description: A rule set identifier
            type: string
            format: uuid
            example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        functions:
          description: The function definitions that will apply to the KDM field
          type: array
          items:
            $ref: '#/components/schemas/Function'
        ruleMetadata:
          description: Overview of a rule metadata
          type: string
          example: '{"connections":[{"id":"4568e6983fef85d9","source":"2d7bc70c10f8db77","sourceOutput":"outputKDMField","target":"d75cd0beba2bf8b0","targetInput":"upperFuncInput_argument0"},{"id":"660c0766dc3599aa","source":"d75cd0beba2bf8b0","sourceOutput":"upperFuncOutput","target":"e25c88e883e204a6","targetInput":"mandateInput"}],"targetKDMField":{"id":"2d7bc70c10f8db77","value":{"x":-133.265625,"y":-38.0546875}}}'
        status:
          $ref: '#/components/schemas/RuleStatus'
    SynchronizeRulesRequest:
      description: The synchronize rules request containing one or more rules synchronize requests
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RuleSyncInfo'
        options:
          $ref: '#/components/schemas/SynchronizeRuleOptions'
    RuleSyncInfo:
      type: object
      properties:
        identifier:
          description: The identifier of the rule
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        targetKDMFieldName:
          description: The target KDM field name of the rule
          type: string
          example: assetClass
        note:
          description: The note containing information and context about the rule
          type: string
          example: Lorem ipsum
        ruleSets:
          description: The rule sets that this rule is part of
          type: array
          items:
            $ref: '#/components/schemas/RuleSetSyncInfo'
        functions:
          description: The function definitions that will apply to the KDM field
          type: array
          items:
            $ref: '#/components/schemas/Function'
        ruleMetadata:
          description: Overview of the rule metadata
          type: string
        status:
          $ref: '#/components/schemas/RuleStatus'
    RuleSetSyncInfo:
      type: object
      properties:
        identifier:
          description: The identifier of an exiting or to be created rule set
          type: string
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          description: The name of the rule set
          type: string
          example: My rule set
    SynchronizeRuleOptions:
      type: object
      nullable: true
      properties:
        setAsNewActiveVersion:
          description: When true, replace the currently active rule in the rule set(s)
          type: boolean
          example: true
        copyToRuleSet:
          description: The existing rule set to which a copy of the rules should be added
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
    SynchronizeRulesResponse:
      description: The synchronize rules response
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/RuleSynchronizationResult'
    RuleSynchronizationResult:
      description: The rule synchronization result
      type: object
      properties:
        ruleIdentifier:
          description: The identifier of the rule
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        comment:
          description: Information on the synchronization result
          type: string
          example: Version updated from 1 to 2
    Function:
      description: Overview of a function
      type: object
      properties:
        argumentReferenceIdentifier:
          description: |
            The identifier of the function that will be used to generate the argument value.
            If null, the function will be treated as a head.
          type: string
          nullable: true
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        category:
          description: The category of the function
          type: string
          x-extensible-enum:
          - HUB
          - PURPOSE
          - REG
          - ENTITY
          - PRODUCT
          - RELATIONSHIP
          example: HUB
        tag:
          description: The tag of the function
          type: string
          example:
          - sourceField
          - upperCase
          - mandate
        functionMetadata:
          description: The metadata of the function. Referenced in the user field configuration metadata.
          type: string
          nullable: true
          example: '{"id":"5c7bf808ac0c507e","value":{"x":-105.2109375,"y":-84.43359375}}'
        arguments:
          description: A dynamic list of arguments by name and type
          type: array
          items:
            $ref: '#/components/schemas/FunctionArgument'
    FunctionArgument:
      description: Overview of a function argument
      type: object
      properties:
        type:
          description: The type of the function argument
          type: string
          x-extensible-enum:
          - STRING
          - NUMBER
          - ARRAY
          - MAP
          - FUNCTION
          - BOOLEAN
          - KDMFIELD
          - SOURCEFIELD
          example: STRING
        name:
          description: The name of the function argument
          type: string
          example:
          - function
          - argument0
          - actionType
        value:
          $ref: '#/components/schemas/AnyValue'
    FunctionDefinitions:
      description: Available function definitions
      type: object
      properties:
        items:
          description: List of function definitions
          type: array
          items:
            $ref: '#/components/schemas/FunctionDefinition'
    FunctionDefinition:
      description: Overview of a function definition.
      type: object
      properties:
        tag:
          type: string
        description:
          type: string
        arguments:
          description: A dynamic list of arguments by name and type.
          type: array
          items:
            $ref: '#/components/schemas/FunctionDefinitionArgument'
    FunctionDefinitionArgument:
      description: Overview of a function argument.
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        type:
          type: string
          x-extensible-enum:
          - STRING
          - NUMBER
          - ARRAY
          - MAP
          - FUNCTION
    Category:
      description: Category of a field
      type: string
      x-extensible-enum:
      - PURPOSE
      - EVENTS
      - COUNTERPARTY
      - TR
      - COMPLIANCE
      - CLEARING
      - TRANSACTION_RELATED
      - CUSTOM_BASKETS
      - NOTIONAL_AMOUNTS_AND_QUANTITIES
      - PRICES
      - PACKAGES
      - PAYMENTS
      - PRODUCT
      - SETTLEMENT
      - DISSEMINATION_RELATED
      - SETTLEMENT_AND_PRODUCT
      - TRANSFER
      - VALUATION
      - COLLATERAL_AND_MARGINS_MARGIN_AND_CAPITAL_INDICATOR
      - COLLATERAL_AND_MARGINS
    Group:
      nullable: true
      description: Group of fields
      type: string
      x-extensible-enum:
      - CURRENCY
      - FREQUENCY
      - RESET_PAYMENT_FREQUENCY_PERIOD
      - NOTATION
      - UNIT_OF_MEASURE
      - DAY_COUNT_CONVENTION
      - REFERENCE_RATE_SOURCE
      - REFERENCE_RATE
      - COUNTERPARTY_DESIGNATION
      - SDR_IDENTIFIER
      - RATE_INDEX_TENOR_PERIOD
      - LEG
      - SETTLEMENT_LOCATION
      - SPREAD_NOTATION
      - PRODUCT_NAME
      - ACTION_TYPE
      - ALLOCATION_INDICATOR
      - ASSET_CLASS
      - CLEARED
      - CLEARING_ACCOUNT_ORIGIN
      - COMMODITY_SWAP_CATEGORY
      - DELIVERY_TYPE
      - EMBEDDED_OPTION_TYPE
      - EVENT_TYPE
      - EXEMPT_PUBLIC_RELATED_MESSAGE
      - INSTRUMENT_TYPE
      - JURISDICTION
      - OPTION_STYLE
      - OPTION_TYPE
      - OTHER_COMMODITY_REGION
      - OTHER_COMMODITY_SWAP_CATEGORY
      - PLATFORM_IDENTIFIER
      - RELATED_FUTURES_CONTRACT
      - RETURN_PRICING_METHOD_OR_PAYOUT_TRIGGER
      - SENIORITY
      - SINGLE_OR_MULTIPLE_CURRENCY
      - STRIKE_PRICE_NOTATION
      - UNDERLYING_ASSET_TYPE
      - VALUATION_METHOD
      - CLEARING_EXCEPTIONS_AND_EXEMPTION
    AppliesOn:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
      example:
        ESMA:
        - Transaction
        - Valuation
        CFTC:
        - Valuation
        CA:
        - Collateral
    Rules:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) products.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of rules
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Rule'
    Rule:
      description: Model for rule
      type: object
      properties:
        identifier:
          description: The identifier of the rule
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        targetKDMFieldName:
          description: The target KDM field name of the rule
          type: string
          example: assetClass
        note:
          description: The note containing information and context about the rule
          type: string
          example: Lorem ipsum
        ruleSets:
          description: The rule sets that this rule is part of
          type: array
          items:
            type: string
            format: uuid
        functions:
          description: The function definitions that will apply to the KDM field
          type: array
          items:
            $ref: '#/components/schemas/Function'
        ruleMetadata:
          description: Overview of the rule metadata
          type: string
        createdTimestamp:
          description: Timestamp when the rule was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        lastModifiedTimestamp:
          description: Timestamp when the rule was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        deletedTimestamp:
          description: Timestamp when the rule was deleted
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        permissions:
          $ref: '#/components/schemas/Permissions'
        version:
          description: The version of a Rule
          type: string
          example: "3"
        status:
          $ref: '#/components/schemas/RuleStatus'
    RuleStatus:
      description: The status of the rule
      type: string
      x-extensible-enum:
      - ACTIVE
      - INACTIVE
      - ARCHIVED
      example: ACTIVE
    Products:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) products.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of products
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Product'
    ProductDetail:
      description: Model for product detail
      type: object
      properties:
        productKdm:
          $ref: '#/components/schemas/ProductKdmDetail'
        permissions:
          $ref: '#/components/schemas/Permissions'
    Product:
      description: Model for product condensed
      type: object
      properties:
        identifier:
          description: Client-specific internal identifier of the product
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        lastModifiedTimestamp:
          description: Timestamp when the product was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        createdTimestamp:
          description: Timestamp when the other entity was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        productKdm:
          $ref: '#/components/schemas/ProductKdm'
        permissions:
          $ref: '#/components/schemas/Permissions'
    ProductKdm:
      description: Model for product KDM
      type: object
      properties:
        contractType:
          description: ""
          type: string
          nullable: true
        uniqueProductIdentifier:
          description: UPI defined by ANNA DSB
          type: string
          example: QZLNBTG6X7H9
          nullable: true
        assetClass:
          description: Asset Class provided by client or sourced from DSB if Unique Product Identifier is populated
          type: string
          example: CR
          nullable: true
        productName:
          description: Product name provided by client or sourced from DSB if Unique Product Identifier is populated.
          type: string
          example: ProductName
          nullable: true
        instrumentType:
          description: ""
          type: string
          nullable: true
        deliveryType:
          description: ""
          type: string
          nullable: true
        underlyingCurrency:
          description: ""
          type: string
          nullable: true
        otherUnderlyingCurrency:
          description: ""
          type: string
          nullable: true
        optionStyle:
          description: ""
          type: string
          nullable: true
        optionType:
          description: ""
          type: string
          nullable: true
        returnPricingMethodOrPayoutTrigger:
          description: ""
          type: string
          nullable: true
        valuationMethodOrTrigger:
          description: ""
          type: string
          nullable: true
        seniority:
          description: ""
          type: string
          nullable: true
        singleOrMultipleCurrency:
          description: ""
          type: string
          nullable: true
        standardContractSpecification:
          description: ""
          type: string
          nullable: true
        referenceRate:
          description: ""
          type: string
          nullable: true
        referenceRateLeg:
          description: ""
          type: number
          nullable: true
        otherReferenceRate:
          description: ""
          type: string
          nullable: true
        referenceRateSource:
          description: ""
          type: string
          nullable: true
        otherReferenceRateSource:
          description: ""
          type: string
          nullable: true
        underlyingISIN:
          description: ""
          type: string
          nullable: true
        underlyingLEI:
          description: ""
          type: string
          nullable: true
        underlyingAssetType:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractType:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetOrUnderlyingContractType:
          description: ""
          type: string
          nullable: true
        underlyingAssetSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        underlyingAssetAdditionalSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetAdditionalSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractTypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractTypeLegOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetOrUnderlyingContractTypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetAdditionalSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetAdditionalSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        underlyingCreditIndexSeries:
          description: ""
          type: number
          nullable: true
        underlyingCreditIndexVersion:
          description: ""
          type: number
          nullable: true
        underlyingIssuerType:
          description: ""
          type: string
          nullable: true
        underlyingRateIndexTenorPeriod:
          description: ""
          type: string
          nullable: true
        otherUnderlyingRateIndexTenorPeriod:
          description: ""
          type: string
          nullable: true
        underlyingRateIndexTenorPeriodMultiplier:
          description: ""
          type: number
          nullable: true
        otherUnderlyingRateIndexTenorPeriodMultiplier:
          description: ""
          type: number
          nullable: true
        droitAssociatedSecuritySettlementOffset:
          description: ""
          type: string
          nullable: true
        droitBroadVSNarrow:
          description: ""
          type: string
          nullable: true
        droitCommodityCode:
          description: ""
          type: string
          nullable: true
        droitCompoFXFeatureIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitContingencyAssociatedWith:
          description: ""
          type: string
          nullable: true
        droitIRSBlockCurrency:
          description: ""
          type: string
          nullable: true
        droitDFAUnderlyingAssetTypes:
          description: ""
          type: string
          nullable: true
        droitDFAUnderlyingSecurityTypes:
          description: ""
          type: string
          nullable: true
        droitFacilitateSecuritySettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitFXSpotStandardSettlementPeriod:
          description: ""
          type: string
          nullable: true
        droitFXQuotedCurrencyPairCurrency1:
          description: ""
          type: string
          nullable: true
        droitFXQuotedCurrencyPairCurrency2:
          description: ""
          type: string
          nullable: true
        droitFXSettlementOffsetAfterValuation:
          description: ""
          type: string
          nullable: true
        droitBondReferenceIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitEmbeddedInterestRateOptionalityIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitContingentSettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitOptionMimicsSwapPayoutIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitSwapClassificationOverride:
          description: ""
          type: string
          nullable: true
        droitTRSUnderlierType:
          description: ""
          type: string
          nullable: true
        droitCommercialPurposeFXForwardIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitMIFIDWholesaleEnergyProductIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitESMAMarketEquivalentContractIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitCommoditySpotSettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitCommodityEnergyBalanceIntentIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitESMAListedAssetClass:
          description: ""
          type: string
          nullable: true
        droitListedInstrumentType:
          description: ""
          type: string
          nullable: true
        ISDATaxonomy:
          description: Product identifier defined by ISDA
          type: string
          example: InterestRate:IRSwap:FixedFloat
          nullable: true
        internalIdentifier:
          description: ""
          type: string
          nullable: false
        CFTCReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        SECReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        CAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        ESMAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        FCAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        ASICReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        MASReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
    ProductKdmDetail:
      description: Model for product KDM
      type: object
      properties:
        contractType:
          description: ""
          type: string
          nullable: true
        uniqueProductIdentifier:
          description: UPI defined by ANNA DSB
          type: string
          example: QZLNBTG6X7H9
          nullable: true
        assetClass:
          description: Asset Class provided by client or sourced from DSB if Unique Product Identifier is populated
          type: string
          example: CR
          nullable: true
        productName:
          description: Product name provided by client or sourced from DSB if Unique Product Identifier is populated.
          type: string
          example: ProductName
          nullable: true
        instrumentType:
          description: ""
          type: string
          nullable: true
        deliveryType:
          description: ""
          type: string
          nullable: true
        underlyingCurrency:
          description: ""
          type: string
          nullable: true
        otherUnderlyingCurrency:
          description: ""
          type: string
          nullable: true
        optionStyle:
          description: ""
          type: string
          nullable: true
        optionType:
          description: ""
          type: string
          nullable: true
        returnPricingMethodOrPayoutTrigger:
          description: ""
          type: string
          nullable: true
        valuationMethodOrTrigger:
          description: ""
          type: string
          nullable: true
        seniority:
          description: ""
          type: string
          nullable: true
        singleOrMultipleCurrency:
          description: ""
          type: string
          nullable: true
        standardContractSpecification:
          description: ""
          type: string
          nullable: true
        referenceRate:
          description: ""
          type: string
          nullable: true
        referenceRateLeg:
          description: ""
          type: number
          nullable: true
        otherReferenceRate:
          description: ""
          type: string
          nullable: true
        referenceRateSource:
          description: ""
          type: string
          nullable: true
        otherReferenceRateSource:
          description: ""
          type: string
          nullable: true
        underlyingISIN:
          description: ""
          type: string
          nullable: true
        underlyingLEI:
          description: ""
          type: string
          nullable: true
        underlyingAssetType:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractType:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetOrUnderlyingContractType:
          description: ""
          type: string
          nullable: true
        underlyingAssetSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        underlyingAssetAdditionalSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetAdditionalSubtypeOrUnderlyingContractSubtype:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractTypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetOrUnderlyingContractTypeLegOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetOrUnderlyingContractTypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        underlyingAssetAdditionalSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        otherUnderlyingAssetAdditionalSubtypeOrUnderlyingContractSubtypeOther:
          description: ""
          type: string
          nullable: true
        underlyingCreditIndexSeries:
          description: ""
          type: number
          nullable: true
        underlyingCreditIndexVersion:
          description: ""
          type: number
          nullable: true
        underlyingIssuerType:
          description: ""
          type: string
          nullable: true
        underlyingRateIndexTenorPeriod:
          description: ""
          type: string
          nullable: true
        otherUnderlyingRateIndexTenorPeriod:
          description: ""
          type: string
          nullable: true
        underlyingRateIndexTenorPeriodMultiplier:
          description: ""
          type: number
          nullable: true
        otherUnderlyingRateIndexTenorPeriodMultiplier:
          description: ""
          type: number
          nullable: true
        droitAssociatedSecuritySettlementOffset:
          description: ""
          type: string
          nullable: true
        droitBroadVSNarrow:
          description: ""
          type: string
          nullable: true
        droitCommodityCode:
          description: ""
          type: string
          nullable: true
        droitCompoFXFeatureIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitContingencyAssociatedWith:
          description: ""
          type: string
          nullable: true
        droitIRSBlockCurrency:
          description: ""
          type: string
          nullable: true
        droitDFAUnderlyingAssetTypes:
          description: ""
          type: string
          nullable: true
        droitDFAUnderlyingSecurityTypes:
          description: ""
          type: string
          nullable: true
        droitFacilitateSecuritySettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitFXSpotStandardSettlementPeriod:
          description: ""
          type: string
          nullable: true
        droitFXQuotedCurrencyPairCurrency1:
          description: ""
          type: string
          nullable: true
        droitFXQuotedCurrencyPairCurrency2:
          description: ""
          type: string
          nullable: true
        droitFXSettlementOffsetAfterValuation:
          description: ""
          type: string
          nullable: true
        droitBondReferenceIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitEmbeddedInterestRateOptionalityIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitContingentSettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitOptionMimicsSwapPayoutIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitSwapClassificationOverride:
          description: ""
          type: string
          nullable: true
        droitTRSUnderlierType:
          description: ""
          type: string
          nullable: true
        droitCommercialPurposeFXForwardIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitMIFIDWholesaleEnergyProductIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitESMAMarketEquivalentContractIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitCommoditySpotSettlementIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitCommodityEnergyBalanceIntentIndicator:
          description: ""
          type: boolean
          example: true
          nullable: true
        droitESMAListedAssetClass:
          description: ""
          type: string
          nullable: true
        droitListedInstrumentType:
          description: ""
          type: string
          nullable: true
        ISDATaxonomy:
          description: Product identifier defined by ISDA
          type: string
          example: InterestRate:IRSwap:FixedFloat
          nullable: true
        internalIdentifier:
          description: ""
          type: string
          example: ProductName
          nullable: false
        CFTCReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        CFTCReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        SECReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        SECReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        CAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        CAReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        ESMAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        ESMAReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        FCAReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        FCAReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        ASICReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        ASICReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
        MASReportableProductIndicator:
          description: Indicates if the product is deemed reportable for the applicable jurisdiction. This value can be used within Rules to indicate when a submission should generate a message for that jurisdiction and message type.
          type: boolean
          example: true
          nullable: true
        MASReportableProductJustification:
          description: Provide specific justification for determining reportability. e.g. reference a regulation or specific rule.
          type: string
          example: Droit eligibility check
          nullable: true
    Relationships:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) relationships.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of my relationships
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Relationship'
    Relationship:
      description: Model for relationship condensed
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        createdTimestamp:
          description: Timestamp when the relationship was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        lastModifiedTimestamp:
          description: Timestamp when the relationship was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        status:
          description: The status of the relationship's processing
          type: string
          x-extensible-enum:
          - PROCESSED
          - PROCESSING_FAILED
        relationshipKdm:
          $ref: '#/components/schemas/RelationshipKdm'
        permissions:
          $ref: '#/components/schemas/Permissions'
    RelationshipDetail:
      description: Model for relationship detail
      type: object
      required:
      - relationshipKdm
      properties:
        relationshipKdm:
          $ref: '#/components/schemas/RelationshipKdm'
        permissions:
          $ref: '#/components/schemas/Permissions'
    RelationshipKdm:
      description: Model for relationship KDM
      type: object
      required:
      - myEntityInternalIdentifier
      - otherEntityInternalIdentifier
      properties:
        interAffiliate:
          description: 'Indicate whether the transaction is between two affiliated entities '
          example: true
          type: boolean
          nullable: true
        myEntityInternalIdentifier:
          example: 27ID
          description: Internal identifier of My Entity on behalf of whom this report is being made.  This identifier is used to link to My Entity static data. In the case of an allocated derivative transaction executed by a fund manager on behalf of a fund, the fund, and not the fund manager is reported as My Entity.
          type: string
        otherEntityInternalIdentifier:
          example: 27ID
          description: 'Internal identifier of the Other Entity to an OTC derivative transaction. This identifier is used to link submissions to the Other Entity static data configurations. In the case of an allocated derivative transaction executed by a fund manager on behalf of a fund, the fund, and not the fund manager is reported. '
          type: string
        negativeAffirmationAgreementProvider:
          description: |
            Negative affirmation provider for the party. Given a fixed Contraparty, only the Counterparty should have this input populated. This is to represent the designated negative affirmation provider between the pair in their corresponding Master Agreement. Attribute may take the value of "Contraparty" or "Counterparty. When it does not apply, provide as null.
          type: string
          x-extensible-enum:
          - BOTH
          - CCP
          - CLEARING_ORGANIZATION
          - CLIENT
          - CONTRAPARTY
          - COUNTERPARTY
          - EXECUTING_BROKER
          - EXECUTION_VENUE
          - NOT_APPLICABLE
          - PRIME_BROKER
          - PRIME_BROKER_CLIENT
          nullable: true
        ESMAExemptIntragroupAffiliate:
          description: |
            A valid intragroup affiliate that has been approved for exemption from the clearing mandate, which must meet three tests according to article (3) of EMIR: - It must be part of the same consolidated financial entity for accounting purposes (generally international standards and US GAAP are both acceptable) - It must have meaningful single supervisory control (risk management, consolidated management team, etc.) - You must ask your local regulator and receive approval for the exemption, which has to be 30 days preceding use of the exemption and after the clearing RTS takes effect.
          type: boolean
          nullable: true
        UTICreator:
          description: |
            Indicates which party, Other Entity or My Entity is always the UTI Creator or if the industry standard is used.
          type: string
          nullable: true
        myEntityCFTCPrivacyLawIdentifier:
          description: |
            My Entity's Privacy Law Identifier when transacting against Other Entity, where applicable
          type: string
          nullable: true
        CFTCReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        SECReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        ESMAMyReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        ESMAOtherReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        FCAMyReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        FCAOtherReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        CAReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        ASICMyReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        ASICOtherReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        MASMyReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        MASOtherReportingEntity:
          $ref: '#/components/schemas/ReportingEntity'
        otherEntityCFTCPrivacyLawIdentifier:
          description: |
            Other Entity's Privacy Law Identifier when transacting against My Entity, where applicable
          type: string
          nullable: true
    ReportingEntity:
      description: |
        Indicates if the Other Entity or My Entity are always the reporting entity to the repository or if an industry standard is used.
      type: string
      x-extensible-enum:
      - MY_ENTITY
      - OTHER_ENTITY
      - ISDA_WATERFALL
      - ENTITY_RESPONSIBLE_FOR_REPORTING
      nullable: true
    Entities:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) entities.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of my entities
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/Entity'
    EntityDetail:
      description: Model for entity detail
      type: object
      required:
      - entityKdm
      properties:
        entityKdm:
          $ref: '#/components/schemas/EntityKdmDetail'
        permissions:
          $ref: '#/components/schemas/Permissions'
    Entity:
      description: Model for entity condensed
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        createdTimestamp:
          description: Timestamp when the other entity was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        lastModifiedTimestamp:
          description: Timestamp when the other entity was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        status:
          description: The status of the entity's processing
          type: string
          x-extensible-enum:
          - PROCESSED
          - PROCESSING_FAILED
        entityKdm:
          $ref: '#/components/schemas/EntityKdm'
        permissions:
          $ref: '#/components/schemas/Permissions'
    EntityKdm:
      description: Model for entity KDM
      type: object
      required:
      - internalIdentifier
      properties:
        shortName:
          description: Short name to identify the entity.
          type: string
          example: shortName
          nullable: true
        legalName:
          description: If reportable id is of type LEID then GLEIF legal name.
          type: string
          example: LegalName
          nullable: true
        country:
          description: 'The country of the legal entity identified in the Reportable ID field. '
          type: string
          example: US
          nullable: true
        entityType:
          description: |
            Indicates the Type of Entity (My Entity, Other Entity) which the Static Data relates to.
          type: string
          example: MY_ENTITY
          nullable: true
        internalIdentifier:
          description: |
            Identifier used on submission to link to this record. This ID must be unique and is typically an internal identifier assigned by the submitter.
          type: string
          example: 27ID
        NPID:
          description: |
            National Product Identifier
          type: string
          example: NPID
          nullable: true
        LEID:
          description: |
            Legal Entity Identifier
          type: string
          example: FAKE0022222222222200
          nullable: true
        MIC:
          description: |
            Market Identifier Code
          type: string
          example: MIC
          nullable: true
    EntityKdmDetail:
      description: Model for entity KDM
      type: object
      required:
      - internalIdentifier
      properties:
        shortName:
          description: Short name to identify the entity.
          type: string
          example: shortName
          nullable: true
        legalName:
          description: If reportable id is of type LEID then GLEIF legal name.
          type: string
          example: legalName
          nullable: true
        ASICSmallScaleBuySideIndicator:
          description: |
            If applicable, an indicator that the Reporting Entity is making the report as a Small-scale Buy-side Entity.
          type: boolean
          example: true
          nullable: true
        CADesignation:
          description: |
            Indication whether Entity is a derivatives dealer, non derivatives dealer or a clearing agent.
          type: string
          example: CA
          x-extensible-enum:
          - CA
          - DD
          - NON-DD/CA
          nullable: true
        CALocalCounterparty:
          nullable: true
          description: |
            Province(s) of Entity where they are a local counterparty
          type: array
          example:
          - AB
          - BC
          items:
            type: string
            x-extensible-enum:
            - AB
            - BC
            - MB
            - NB
            - NL
            - NS
            - NT
            - NU
            - true
            - PE
            - QC
            - SK
            - YT
        CFTCClearingExceptionsAndExemptions:
          type: array
          example:
          - NOAL
          - SMBK
          items:
            x-extensible-enum:
            - NOAL
            - SMBK
            - COOP
            - ENDU
            - AFFL
            - OTHR
            type: string
          description: |
            Identifies the type of clearing exception or exemption that the My entity has elected. All applicable exceptions and exemptions must be selected. The values may be repeated as applicable.
          nullable: true
        CFTCConduitAffiliateUSPerson:
          description: |
            Is the party a Conduit Affiliate of a US Person per CFTC rules?
          type: boolean
          example: true
          nullable: true
        CFTCDesignation:
          description: Indication whether Entity is a registered swap dealer, major swap participant, DCO, or non-SD/MSP/DCO for the purpose of the submitted swap.
          type: string
          example: SD
          x-extensible-enum:
          - NON-SD/MSP/DCO
          - SD
          - MSP
          - DCO
          nullable: true
        CFTCFederalEntityIndicator:
          description: |
            Indicator of whether Entity is: One of the following entities: An entity established pursuant to federal law, including, but not limited to, the following: An “agency” as defined in 5 U.S.C. § 551(1), a federal instrumentality, or a federal authority; A government corporation (examples: as such term is defined in 5 U.S.C. § 103(1) or in 31 U.S.C. § 9101); A government-sponsored enterprise (example: as such term is defined in 2 U.S.C. § 622(8)); A federally funded research and development center on the master list referenced in 48 CFR 35.017-6; and An executive department listed in 5 U.S.C. § 101; or An entity chartered pursuant to federal law after formation (example: an organization listed in title 36 of the U.S. Code); or An entity that was established by, or at the direction of, one or more of the entities listed in clause (1), or has an ultimate parent listed in its LEI reference data that is an entity listed in clause (1) or in the first part of this clause (2). Notwithstanding the foregoing, the Entity federal entity indicator data element does not include federally chartered depository institutions.
          type: boolean
          example: true
          nullable: true
        CFTCFinancialEntityIndicator:
          description: |
            Indicator of whether My Entity is a financial entity as defined in CEA §2(h)(7)(C).
          type: boolean
          example: true
          nullable: true
        CFTCGuaranteedAffiliateUSPerson:
          description: |
            Can be inferred by looking at the USP status of the entity's guarantor.
          type: boolean
          example: true
          nullable: true
        CFTCInternationalFinancialInstitutionIndicator:
          description: |
            Is the party an IFI and consequently determined by the CFTC to be exempted from clearing? This is driven by association with an explicit enumerated list coming from the CFTC and stored in separate static data.
          type: boolean
          example: true
          nullable: true
        CFTCLimitedPurposeDesignation:
          description: |
            Where an entity's swap dealer designation is limited to certain asset classes, the asset classes.
          type: string
          example: CRDT
          x-extensible-enum:
          - CRDT
          - COMM
          - INTR
          - CURR
          - EQUI
          nullable: true
        CFTCSmallLocalPresenceIndicator:
          description: |
            Does the amount of business in this local jurisdiction exceed 5% of the total business for the parent entity?
          type: boolean
          example: true
          nullable: true
        CFTCUSPerson:
          description: |
            "(by subsection in new Rule 23.23(a)(23)) U.S. Person means any person that is: (A) a natural person resident in the United States; (B) an estate of a decedent who was a resident of the United States at the time of death; (C) a partnership, corporation, trust, investment vehicle or other legal person organized, incorporated or established under the laws of the United States or having its principal place of business in the United States; (D) an account (whether discretionary or non‑discretionary) of a U.S. Person; or (E) an estate of a decedent who was a resident of the United States at the time of death. Until December 31, 2027, a person may continue to classify counterparties as U.S. Persons based on: representations made pursuant to the “U.S. Person” definition in § 23.160(a)(10) prior to the effective date of the new definition; or representations made pursuant to the interpretation of the term “U.S. Person” in the Cross-Border Guidance prior to the effective date of the new definition."
          type: boolean
          example: true
          nullable: true
        country:
          description: 'The country of the legal entity identified in the Reportable ID field. '
          type: string
          example: US
          nullable: true
        droitEnergyOperatorIndicator:
          description: |
            Whether a party is an operator or administrator of an energy transmission grid, energy balancing mechanism or pipeline network
          type: boolean
          example: true
          nullable: true
        droitEstablishedIn:
          description: |
            Two-letter codes for countries, provinces, regions, etc, under the laws of which an entity is established, using the ISO-3166 standards. This attribute can take on a single string value, such as "AU" for a party established under the laws of Australia. Or when multiple levels of regulations are relevant, this attribute can be populated with an array of string codes to signify different levels of granularity. For example, when a party is established in Canada, the specific provincial codes are also necessary, e.g. ["CA","ON"] for Ontario. An example for a party established in one of the European Union member states can be ["BE","EU"]
          type: array
          items:
            type: string
            x-extensible-enum:
            - AB
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BC
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CR
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - EU
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MB
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NB
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - false
            - NP
            - NR
            - NS
            - NT
            - NU
            - NZ
            - OM
            - true
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - QC
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SV
            - SX
            - SY
            - SZ
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - YE
            - YT
            - ZA
            - ZM
            - ZW
          example:
          - US
          nullable: true
        droitForeignBranchUSPersonIndicator:
          description: |
            Whether the party is a non-US office of a US bank.
          type: boolean
          example: true
          nullable: true
        droitUltimateParentEntityType:
          description: |
            Ultimate parent entity classification of the party
          type: string
          example: CONTRAPARTY
          x-extensible-enum:
          - NOT_APPLICABLE
          - OTHER
          - US_BANK
          - US_BANK_HOLDING_COMPANY
          - US_FINANCIAL_HOLDING_COMPANY
          - US_MAJOR_SWAP_PARTICIPANT
          - US_SWAP_DEALER
          nullable: true
        entityType:
          description: |
            Indicates the Type of Entity (My Entity, Other Entity) which the Static Data relates to.
          type: string
          example: MY_ENTITY
          nullable: true
        ESMABISIndicator:
          description: |
            The Bank for International Settlements, i.e. "EMIR Article 1(4)(b) Entity" in the ISDA EMIR Classification Letter
          type: boolean
          example: true
          nullable: true
        ESMACentralBankOrPublicDebtManagerIndicator:
          description: |
            Any members of the European System of Central Banks or other Member States' bodies performing similar functions or other European Union public bodies charged with or intervening in the management of the public debt, i.e. "EMIR Article 1(4)(a) Entity" in the ISDA EMIR classification letter.
          type: boolean
          example: true
          nullable: true
        ESMACorporateSector:
          type: array
          example:
          - AIFD
          - B
          - C
          - CDTI
          - CSDS
          items:
            x-extensible-enum:
            - A
            - AIFD
            - B
            - C
            - CDTI
            - CSDS
            - D
            - E
            - F
            - G
            - H
            - I
            - INUN
            - INVF
            - J
            - K
            - L
            - M
            - false
            - O
            - ORPI
            - P
            - Q
            - R
            - S
            - T
            - U
            - UCIT
            type: string
          nullable: true
          description: |
            Nature of Entity's company activities. If the counterparty 1 is a Financial Counterparty, this field shall contain all necessary codes included in the Taxonomy for Financial Counterparties in field 6 of Table 1 of the Annex to [PO please insert reference to C(2022) 3588] and applying to that counterparty. If  counterparty 1 is a non - financial counterparty, this field shall contain all necessary codes included in the Taxonomy for Non - financial Counterparties in field 6 of Table 1 of the Annex to [PO please insert reference to C(2022) 3588] and applying to that Counterparty. Where more than one activity is reported, the codes shall be populated in order of the relative importance of the corresponding activities.
            Taxonomy for Financial Counterparties: ‘INVF’ - Investment firm authorized in accordance with Directive 2014/65/EU of the European Parliament and of the Council1; ‘CDTI’ - Credit institution authorised in accordance with Directive 2013/36/EU of the European Parliament and of the Council2; ‘INUN’ - an insurance undertaking or reinsurance undertaking authorised in accordance with Directive 2009/138/EC of the European Parliament and of the Council3; ‘UCIT’ - a UCITS and, where relevant, its management company, authorised in accordance with Directive 2009/65/EC of the European Parliament and of the Council4, unless that UCITS is set up exclusively for the purpose of serving one or more employee share purchase plans; ‘ORPI’ - an institution for occupational retirement provision (IORP), as defined in point (1) of Article 6 of Directive (EU) 2016/2341 of the European Parliament and of the Council5; ‘AIFD’ - an alternative investment fund (AIF), as defined in point (a) of Article 4(1) of Directive 2011/61/EU of the European Parliament and of the Council6, which is either established in the Union or managed by an alternative investment fund manager (AIFM) authorised or registered in accordance with that Directive, unless that AIF is set up exclusively for the purpose of serving one or more employee share purchase plans, or unless that AIF is a securitisation special purpose entity as referred to in point (g) of Article 2(3) of Directive 2011/61/EU, and, where relevant, its AIFM established in the Union; ‘CSDS’ - a central securities depository authorised in accordance with Regulation (EU) No 909/2014 of the European Parliament and of the Council7;
            Taxonomy for Non-Financial Counterparties. The categories below correspond to the main sections of NACE classification as defined in Regulation (EC) No 1893/2006 of the European Parliament and of the Council8: ‘A’ - Agriculture, forestry and fishing; ‘B’ - Mining and quarrying; ‘C’ - Manufacturing; ‘D’ - Electricity, gas, steam and air conditioning supply; ‘E’ - Water supply, sewerage, waste management and remediation activities; ‘F’ - Construction; ‘G’ - Wholesale and retail trade, repair of motor vehicles and motorcycles; ‘H’ - Transportation and storage; ‘I’ - Accommodation and food service activities; ‘J’ - Information and communication; ‘K’ - Financial and insurance activities; ‘L’ - Real estate activities; ‘M’ - Professional, scientific and technical activities; ‘N’ - Administrative and support service activities; ‘O’ - Public administration and defence; compulsory social security; ‘P’ - Education; ‘Q’ - Human health and social work activities; ‘R’ - Arts, entertainment and recreation; ‘S’ - Other service activities; ‘T’ - Activities of households as employers; undifferentiated goods – and services – producing  activities of households for own use; ‘U’ - Activities of extraterritorial organizations and bodies. Where more than one activity is reported, list the codes in order of the relative importance of the corresponding activities. Leave blank in the case of CCPs and other type of counterparties in accordance with Article 1(5) of Regulation (EU) No 648/20129.
        ESMAEquivalentReportingIndicator:
          description: |
            The third country financial counterparty is subject to a legal regime that has been declared equivalent to EMIR and has agreed to report the derivative contract pursuant to the rules of such third country legal regime
          type: boolean
          example: true
          nullable: true
        ESMAExceedsClearingThreshold:
          description: |
            If Entity exceeds the clearing threshold per asset class. will default to false if asset class is not selected.
          type: array
          nullable: true
          example:
          - CRDT
          items:
            type: string
            x-extensible-enum:
            - COMMODITY
            - EQUITY
            - FOREIGN_EXCHANGE
            - INTEREST_RATE
            - NFC_PLUS
            - NOT_APPLICABLE
            - UNKNOWN
            nullable: true
        ESMAExemptedForeignCentralBankIndicator:
          description: |
            Central banks and public debt management bodies in Japan, the U.S.A, Australia, Canada, Hong Kong, Mexico, Singapore, Switzerland
          type: boolean
          example: true
          nullable: true
        ESMANatureOfCounterparty:
          description: |
            Indicate if the Entity is a CCP, a financial or a non-financial counterparty or other type of counterparty as defines in Article 2, points 1, 8 and 9, of Regulation (EU) No 648/2012, or an entity as referred to in Article 1, point 5, of that Regulation.
            F = Financial Counterparty N = Non-Financial Counterparty C = Central Counterparty O = Other"
          type: string
          example: F
          x-extensible-enum:
          - F
          - false
          - C
          - O
          nullable: true
        ESMAParentFinancialCounterpartyIndicator:
          description: |
            The Non-financial Counterparty has a parent undertaking that is a Financial Counterparty for the purposes of intragroup exemption from reporting.
          type: boolean
          example: true
          nullable: true
        ESMAReportingObligation:
          description: |
            Indicator of whether counterparty has the reporting obligation under Regulation (EU) No 648/2012, irrespective of who is responsible and legally liable for its reporting.
          type: boolean
          example: true
          nullable: true
        ESMAThirdCountryIndicator:
          description: |
            Whether an entity is a Third Country Entity (not established in the EU) under EMIR
          type: boolean
          example: true
          nullable: true
        internalIdentifier:
          description: |
            Identifier used on submission to link to this record. This ID must be unique and is typically an internal identifier assigned by the submitter.
          type: string
          example: 27ID
        NPID:
          description: |
            National Product Identifier
          type: string
          example: NPID
          nullable: true
        LEID:
          description: |
            Legal Entity Identifier
          type: string
          example: FAKE0022222222222200
          nullable: true
        MIC:
          description: |
            Market Identifier Code
          type: string
          example: MIC
          nullable: true
    KdmRuleReference:
      description: The references of all rules that were executed on the regulatory message
      type: object
      properties:
        identifier:
          description: The rule identifier
          type: string
          format: uuid
          example: 542A4166-24ED-4496-9FFC-B64BD2B207A1
        kdmFieldName:
          description: The KDM field name of the rule
          type: string
          example: myEntityIdentifier
        version:
          description: The version of the rule that was used
          type: string
          example: 1
    Warning:
      description: A warning
      type: object
      properties:
        fieldName:
          description: The field name of the warning
          type: string
        description:
          description: The description of the change caused warning
          type: string
        reason:
          description: The reason of the change caused warning
          type: string
        category:
          description: The category of the warning
          x-extensible-enum:
          - ENTITY
          - PRODUCT
        tag:
          description: The tag of the function in which warning was generated
          type: string
        argumentName:
          description: The argument name of the function in which warning was generated
          type: string
        argumentValue:
          description: The argument value of the function in which warning was generated
          type: string
    DataFeeds:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) products.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of data feeds
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/DataFeed'
    DataFeedCreateRequest:
      description: Model for creating data feed
      type: object
      required:
      - name
      - sourceSystem
      - feedType
      - ruleSetIdentifier
      - supplementalData
      - status
      properties:
        name:
          type: string
          example: Daily file
        sourceSystem:
          type: string
          example: XYZ
          description: |
            The source system of the data feed. This is typically the name of the system that is sending the data feed.
        feedType:
          $ref: '#/components/schemas/FeedType'
        status:
          $ref: '#/components/schemas/DataFeedStatus'
        deliveryMechanisms:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryMechanism'
        ruleSetIdentifier:
          description: The identifier of the rule set that contains the rules that should be used to translate the data feed ingestions.
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        supplementalData:
          type: boolean
        joinKey:
          description: The CSV column or JSON property that should be used to join the different types of feed data.
          type: string
          nullable: true
        filters:
          type: array
          items:
            $ref: '#/components/schemas/DataFeedFilter'
          nullable: true
    DataFeedUpdateRequest:
      description: Model for updating data feed
      type: object
      required:
      - name
      - sourceSystem
      - feedType
      - ruleSetIdentifier
      - supplementalData
      - status
      properties:
        name:
          type: string
          example: Daily file
        sourceSystem:
          type: string
          example: XYZ
        feedType:
          $ref: '#/components/schemas/FeedType'
        status:
          $ref: '#/components/schemas/DataFeedStatus'
        deliveryMechanisms:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryMechanism'
        ruleSetIdentifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        supplementalData:
          type: boolean
        joinKey:
          type: string
          nullable: true
        filters:
          type: array
          items:
            $ref: '#/components/schemas/DataFeedFilter'
          nullable: true
    DataFeedDetail:
      description: Model for data feed detail
      type: object
      properties:
        identifier:
          type: string
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          type: string
          example: Daily file
        sourceSystem:
          type: string
          example: XYZ
        feedType:
          $ref: '#/components/schemas/FeedType'
        status:
          $ref: '#/components/schemas/DataFeedStatus'
        deliveryMechanisms:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryMechanism'
        ruleSetIdentifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        supplementalData:
          type: boolean
        joinKey:
          type: string
          nullable: true
        filters:
          type: array
          items:
            $ref: '#/components/schemas/DataFeedFilter'
          nullable: true
        lastModifiedTimestamp:
          description: Timestamp when the data feed was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        createdTimestamp:
          description: Timestamp when the data feed was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        archivedTimestamp:
          description: Timestamp when the data feed was archived
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        permissions:
          $ref: '#/components/schemas/Permissions'
    DataFeed:
      description: Model for data feed condensed
      type: object
      properties:
        identifier:
          type: string
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          type: string
          example: Daily file
        sourceSystem:
          type: string
          example: XYZ
        feedType:
          $ref: '#/components/schemas/FeedType'
        status:
          $ref: '#/components/schemas/DataFeedStatus'
        deliveryMechanisms:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryMechanism'
        ruleSetIdentifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        supplementalData:
          type: boolean
        joinKey:
          type: string
          nullable: true
        filters:
          type: array
          items:
            $ref: '#/components/schemas/DataFeedFilter'
          nullable: true
        lastModifiedTimestamp:
          description: Timestamp when the data feed was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        createdTimestamp:
          description: Timestamp when the data feed was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        archivedTimestamp:
          description: Timestamp when the data feed was archived
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        permissions:
          $ref: '#/components/schemas/Permissions'
    DataFeedFilter:
      description: Filter for data feed
      type: object
      properties:
        filterType:
          $ref: '#/components/schemas/FilterType'
        key:
          description: The CSV column or JSON property that should be used to filter the data feed.
          type: string
        value:
          description: The value that should be used to filter the data feed.
          type: string
    FeedType:
      description: The feed type of data feed
      type: string
      x-extensible-enum:
      - TRADE_LEVEL
      - PORTFOLIO_LEVEL
      - ENTITY
      - PRODUCT
      - REFERENCE_DATA
      - RELATIONSHIP
    DataFeedStatus:
      description: Whether the data feed is active or not
      type: string
      x-extensible-enum:
      - ACTIVE
      - INACTIVE
      - ARCHIVED
    FilterType:
      description: The feed type of data feed
      type: string
      x-extensible-enum:
      - SUBMISSIONS
      - SUPPLEMENTAL
    RuleSets:
      type: object
      description: The search result with a cursor, indicating whether there are more items and the returned (subset of) products.
      required:
      - hasMore
      - items
      properties:
        cursor:
          description: Cursor for the current search request.
          type: string
          nullable: true
        hasMore:
          description: Indicating whether there are more items that can be retrieved.
          type: boolean
        items:
          description: The list of rule sets
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/RuleSet'
    RuleSetCreateRequest:
      description: Model for creating rule set
      type: object
      required:
      - name
      properties:
        name:
          type: string
          example: Custom rule set
    RuleSetUpdateRequest:
      description: Model for updating rule set
      type: object
      required:
      - name
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          type: string
          example: Updated rule set name
    RuleSetDetail:
      description: Model for rule set detail
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          type: string
          example: Rule set name
        lastModifiedTimestamp:
          description: Timestamp when the rule set was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        createdTimestamp:
          description: Timestamp when the rule set was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        permissions:
          $ref: '#/components/schemas/Permissions'
    RuleSet:
      description: Model for rule set condensed
      type: object
      properties:
        identifier:
          type: string
          format: uuid
          example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB
        name:
          type: string
          example: Rule set name
        lastModifiedTimestamp:
          description: Timestamp when the rule set was modified
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        createdTimestamp:
          description: Timestamp when the rule set was created
          type: string
          format: date-time
          example: "2020-05-28T14:07:17Z"
          nullable: true
        permissions:
          $ref: '#/components/schemas/Permissions'
    ReprocessesUploadPayload:
      description: Upload Reprocesses Payload
      type: array
      items:
        type: object
        properties:
          uploadIdentifier:
            description: Identifier for the upload
            type: string
            example: 6E36A000-719A-11EE-A565-0800200C9A66
          rowNumbers:
            description: List of row numbers to reprocess
            type: array
            nullable: true
            example:
            - 1
            - 2
            - 3
            items:
              type: integer
    ReprocessesUploadByCriterionPayload:
      description: Payload containing the criterion to query for regulatory messages - this is needed to find the required uploads to reprocess
      type: object
      properties:
        rejectionCode:
          description: Internal rejection code to apply reprocessing on
          type: string
          example: "10053"
        ruleId:
          description: Jurisdiction rule to apply reprocessing to
          type: string
          nullable: true
          example: to-be-defined
        fieldName:
          description: Field to apply reprocessing to
          type: string
          nullable: true
          example: assetClass
        submittedValue:
          description: Value to apply reprocessing to
          type: string
          nullable: true
          example: CO
    AnyValue:
      description: 'Can be anything: string, number, array, object, etc., including `null`'
      anyOf:
      - type: string
      - type: number
      - type: integer
      - type: array
        items:
          oneOf:
          - type: string
          - type: number
          - type: integer
          - type: object
      - type: object
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: |
            A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
          default: about:blank
          example: /some/uri-reference
        title:
          type: string
          description: |
            A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
          example: some title for the error situation
        status:
          type: integer
          format: int32
          description: |
            The HTTP status code generated by the origin server for this occurrence of the problem.
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
        detail:
          type: string
          description: |
            A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
          example: some description for the error situation
        instance:
          type: string
          format: uri-reference
          description: |
            A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
          example: /some/uri-reference#specific-occurrence-context
        correlationId:
          type: string
          description: |
            A correlation identity referring to the specific occurrence of the problem.
    Permissions:
      type: object
      description: Experimental. The permissions the user has on a resource
      properties:
        canEdit:
          type: boolean
          description: Experimental. Whether a user can edit the resource
          example: true
        canDelete:
          type: boolean
          description: Experimental. Whether a user can delete the resource
          example: true
    UploadPermissions:
      type: object
      description: Experimental. The permissions the user has on a resource
      properties:
        canReprocess:
          type: boolean
          description: Experimental. Whether a user can reprocess the resource
          example: true
        canIgnore:
          type: boolean
          description: Whether a user can ignore the resource
          example: true
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.dev.korfinancial.com/oauth2/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://auth.dev.korfinancial.com/login?response_type=code&client_id=5mcq2oh8fgr50pijn5klqv1pon&redirect_uri=https%3A%2F%2Ftranslations.rs.demo.korfinancial.com%2Fswagger-ui%2Foauth2-redirect.html
          tokenUrl: https://auth.dev.korfinancial.com/oauth2/token
          scopes:
            openid: Grants user access
security:
- OAuth2:
  - openid