openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Column Mapper Template Channels API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: ColumnMapperTemplateChannels
paths:
  /v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels:
    post:
      summary: Create column mapper template channel
      tags:
      - ColumnMapperTemplateChannels
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Created column mapper template channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnMapperTemplateChannel'
      parameters:
      - in: path
        name: column_mapper_template_id
        description: ColumnMapperTemplate ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateColumnMapperTemplateChannelPayload'
        description: Column mapper template channel payload
      operationId: postV2ColumnMapperTemplatesByColumnMapperTemplateIdColumnMapperTemplateChannels
      x-operation-id-source: derived
  /v2/column_mapper_templates/{column_mapper_template_id}/column_mapper_template_channels/{id}:
    patch:
      summary: Update column mapper template channel
      tags:
      - ColumnMapperTemplateChannels
      parameters:
      - in: path
        name: column_mapper_template_id
        description: ColumnMapperTemplate ID
        required: true
        schema:
          type: integer
          format: int64
      - in: path
        name: id
        description: ColumnMapperTemplateChannel ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Column mapper template channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnMapperTemplateChannel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateColumnMapperTemplateChannelPayload'
        description: Column mapper template channel payload
      operationId: patchV2ColumnMapperTemplatesByColumnMapperTemplateIdColumnMapperTemplateChannelsById
      x-operation-id-source: derived
    delete:
      summary: Delete column mapper
      tags:
      - ColumnMapperTemplateChannels
      parameters:
      - in: path
        name: column_mapper_template_id
        description: ColumnMapperTemplate ID
        required: true
        schema:
          type: integer
          format: int64
      - in: path
        name: id
        description: ColumnMapperTemplateChannel ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ColumnMapperTemplateChannel deleted
          content:
            application/json:
              schema:
                example:
                  status: deleted
      operationId: deleteV2ColumnMapperTemplatesByColumnMapperTemplateIdColumnMapperTemplateChannelsById
      x-operation-id-source: derived
components:
  schemas:
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    CreateColumnMapperTemplateChannelPayload:
      properties:
        column_mapper_template_channel:
          properties:
            channel:
              type: string
            column_name:
              type: string
            unit:
              type: string
            unitless:
              type: boolean
            primary_template_channel_id:
              type: integer
              format: int64
            column_mapper_template_rules_attributes:
              type: object
              items:
                properties:
                  duration_in_minutes:
                    type: integer
                  conditions:
                    type: object
                    properties:
                      operator:
                        type: string
                      operand:
                        type: string
                      logical_operator:
                        type: string
      example:
        column_mapper_template_channel:
          channel: rop
          column_name: OBR
          unit: ft
          unitless: false
          backup_template_channels_attributes:
          - channel: rop
            column_name: BRO
            unit: cm
            column_mapper_template_rules_attributes:
            - duration_in_minutes: 5
              conditions:
              - operator: OPERATOR_EQUAL
                operand: 20
                logical_operator: 'null'
    ColumnMapperTemplateChannel:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            channel:
              type: string
            column_name:
              type: string
            unit:
              type: string
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            primary_template_channel_id:
              type: integer
              format: int64
        relationships:
          type: object
          properties:
            backup_template_channels:
              type: object
              items:
                properties:
                  id:
                    type: integer
                    format: int64
                  type:
                    type: string
            column_mapper_template_rules:
              type: object
              items:
                properties:
                  data:
                    type: object
                    items:
                      properties:
                        id:
                          type: integer
                          format: int64
                        type:
                          type: string
      example:
        id: 111
        type: column_mapper_template_channel
        attributes:
          id: 111
          channel: Channel
          column_name: Column name
          unit: un
          created_at: '2010-01-01T00:00:00.000Z'
          updated_at: '2010-01-01T00:00:00.000Z'
          primary_template_channel_id: 555
        relationships:
          column_mapper_template_channels:
            data:
            - id: '123'
              type: column_mapper_template_channel
          column_mapper_template_rules:
            data:
            - id: '123'
              type: column_mapper_template_rule
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
    UpdateColumnMapperTemplateChannelPayload:
      properties:
        column_mapper_template_channel:
          properties:
            column_name:
              type: string
            unit:
              type: string
            unitless:
              type: boolean
      example:
        column_mapper_template_channel:
          column_name: OBR
          unit: ft
          unitless: false
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header