Rivery Data Flows Metadata API

openapi: 3.2.0
info:
  title: Boomi Data Integration Data Flows Metadata API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    url: https://community.boomi.com/s/support
    email: support@boomi.com
  version: 1.0.0
  x-logo:
    url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
  description: US
- url: https://api.eu-west-1.rivery.io
  description: EU
tags:
- name: Data Flows Metadata
  description: Internal endpoints for data flow metadata
paths:
  /v1/data_source_types:
    get:
      tags:
      - Data Flows Metadata
      summary: Get Data Source Types
      description: '**Authorization scope:** `data flow:list`


        **Get all data source type entities as a paginated list.**'
      operationId: get_data_source_types
      security:
      - HTTPBearer: []
      parameters:
      - name: items_per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of items per page in the paginated list.
          default: 20
          title: Items Per Page
        description: The number of items per page in the paginated list.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The current page number in the paginated list.
          default: 1
          title: Page
        description: The current page number in the paginated list.
      - name: segment
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/DataSourceTypesSegmentEnum'
          - type: 'null'
          description: The segment of the data source type.
          examples:
          - source
          title: Segment
        description: The segment of the data source type.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceTypesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/target_types:
    get:
      tags:
      - Data Flows Metadata
      summary: Get Target Types
      description: '**Authorization scope:** `data flow:list`


        **Get all target type entities as a paginated list.**'
      operationId: get_target_types
      security:
      - HTTPBearer: []
      parameters:
      - name: items_per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of items per page in the paginated list.
          default: 20
          title: Items Per Page
        description: The number of items per page in the paginated list.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The current page number in the paginated list.
          default: 1
          title: Page
        description: The current page number in the paginated list.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetTypesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    FileZoneSettings:
      properties:
        target_type_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Type Id
          description: ID for the filezone target type
          examples:
          - s3
        default_connection_definition:
          type: object
          title: Default Connection Definition
          description: Default filezone connection definition
          examples:
          - aws_access_key: ABCD
            aws_access_secret: '123456'
            connection_type: aws
            region: us-east-1
        is_default:
          type: boolean
          title: Is Default
          description: Boolean indicating usage of default filezone
          default: false
          examples:
          - true
        bucket:
          anyOf:
          - type: string
          - type: 'null'
          title: Bucket
          description: Filezone bucket
          examples:
          - '{aws_file_zone}'
        is_connection:
          type: boolean
          title: Is Connection
          description: Boolean indicating whether connection utilizes filezone
          default: false
          examples:
          - true
        fields_mapping:
          anyOf:
          - type: object
          - type: 'null'
          title: Fields Mapping
          description: Filezone fields mapping
          examples:
          - blob_storage:
              account_key:
                is_decrypt: true
                new_field: fz_account_key
              account_name:
                is_decrypt: false
                new_field: fz_account_name
        target_type_options:
          anyOf:
          - type: object
          - type: 'null'
          title: Target Type Options
          description: Available filezone target types
          examples:
          - available_fz_target_types:
            - s3
            - blob_storage
      type: object
      required:
      - default_connection_definition
      title: FileZoneSettings
      description: File zone related settings
    DataSourceTypesStatusEnum:
      type: string
      enum:
      - enabled
      - coming_soon
      - vote
      - sunset
      title: DataSourceTypesStatusEnum
      description: Data source status reflect whether Rivery already support this DS type
    DataSourceTypesSegmentEnum:
      type: string
      enum:
      - source
      - connections
      - target
      - technical
      - not_technical
      title: DataSourceTypesSegmentEnum
      description: Each data source type has a segments field, which is being used to filter the relevant DS in the UI
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DataSourceTypesResponse:
      properties:
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: The next page URL
        previous_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Page
          description: The previous page URL
        page:
          type: integer
          title: Page
          description: The page number
          default: 1
        current_page_size:
          type: integer
          title: Current Page Size
          description: The current page size
        total_items:
          type: integer
          title: Total Items
          description: The total number of entities fetched
          default: 0
        items:
          items:
            $ref: '#/components/schemas/DataSourceTypeResponse'
          type: array
          title: Items
      type: object
      required:
      - current_page_size
      - items
      title: DataSourceTypesResponse
      description: The data source type response
    DataSourceTypesLogsSettings:
      properties:
        support_logs:
          type: boolean
          title: Support Logs
          description: Flag to indicate if logs can be exposed for data source type
          examples:
          - true
        logs_start_time:
          anyOf:
          - type: string
          - type: 'null'
          title: Logs Start Time
          description: The timestamp of when the data source type logs were obfuscated in milliseconds.
          examples:
          - '1648374432000'
      type: object
      required:
      - support_logs
      title: DataSourceTypesLogsSettings
      description: Logs related settings, such as if the logs are enabled or not
    DataSourceTypeSettings:
      properties:
        support_high_frequency:
          type: boolean
          title: Support High Frequency
          description: The binary choice for the data source type to support high frequency
          default: false
          examples:
          - true
        support_custom_table:
          type: boolean
          title: Support Custom Table
          description: The binary choice for the data source type to have custom table settings.
          default: false
          examples:
          - true
        support_predefined_reports:
          type: boolean
          title: Support Predefined Reports
          description: The boolean check if the data source type is a predefined report
          default: false
          examples:
          - true
        support_generic_ui:
          type: boolean
          title: Support Generic Ui
          description: Flag to indicate if UI of data source type is generic
          default: false
          examples:
          - false
        is_new_interface:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is New Interface
          description: Flag to indicate if the data source type is using the new interface
          default: false
          examples:
          - false
        is_native:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Native
          description: Flag to indicate the data source type is a published Native Connector; the frontend uses it to drive the generic native_connector pull-request wire shape.
          default: false
          examples:
          - true
        in_section_ordinal:
          anyOf:
          - type: integer
          - type: 'null'
          title: In Section Ordinal
          description: The Order of the source in the UI
          default: 1000
          examples:
          - 100
        is_connection_generic_pattern:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Connection Generic Pattern
          description: Flag to indicate if the data source type is using the generic connection pattern
          default: false
          examples:
          - false
        supported_file_types_per_data_warehouse:
          type: object
          title: Supported File Types Per Data Warehouse
          description: The supported file formats of the data source type for each data warehouse.
          examples:
          - bq:
            - json
            - csv
            logic:
            - json
            - csv
            redshift:
            - json
            - csv
        logs_settings:
          allOf:
          - $ref: '#/components/schemas/DataSourceTypesLogsSettings'
          description: Data source types logs related settings
          examples:
          - support_logs: true
        increment_defaults:
          type: object
          title: Increment Defaults
          description: Default incremental loading parameters for the data source type
          examples:
          - last_days_back: 3
            relative_delta: 30
        support_sub_rivers:
          type: boolean
          title: Support Sub Rivers
          description: Flag to indicate if sub rivers are supported
          default: false
          examples:
          - false
        no_schema_migration:
          type: boolean
          title: No Schema Migration
          description: Flag to indicate the data source does not follow a schema -> table structure
          default: false
          examples:
          - false
      type: object
      required:
      - supported_file_types_per_data_warehouse
      - logs_settings
      - increment_defaults
      title: DataSourceTypeSettings
      description: The settings for the DataSourceType model
    TargetTypeResponse:
      properties:
        name:
          type: string
          title: Name
          description: Name of the target type
          examples:
          - Snowflake
        target_type:
          type: string
          title: Target Type
          description: Target type ID
          examples:
          - snowflake
        datasource_type_id:
          type: string
          title: Datasource Type Id
          description: ID for the data source type
          examples:
          - snowflake
        connection_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Connection Type
          description: Connection type for the target
          examples:
          - snowflake
        target_task_type_id:
          type: string
          title: Target Task Type Id
          description: ID for the target task type
          examples:
          - fz2snowflake
        logic_step_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Logic Step Type
          description: Type of logic step
          examples:
          - snowflake
        target_settings:
          type: object
          title: Target Settings
          description: Target settings
          examples:
          - dataframe_as_source: true
            dataframe_as_target: true
            enable_sql_results: true
        segment:
          items:
            type: string
          type: array
          title: Segment
          description: A target / data source type property that indicates whether it is a source, target, has connection, etc
          examples:
          - - technical
        river_type_id:
          type: string
          title: River Type Id
          description: ID for the river type
          examples:
          - src_to_trgt
        icon:
          anyOf:
          - type: string
          - type: 'null'
          title: Icon
          description: Filename of icon
          examples:
          - https://static-assets.console.rivery.io/amazon-s3.png
        file_zone_settings:
          allOf:
          - $ref: '#/components/schemas/FileZoneSettings'
          description: Settings for file zone targets
          examples:
          - is_default: true
        api_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Name
          description: The name of the target that the API expects
          examples:
          - bigquery
      type: object
      required:
      - name
      - target_type
      - datasource_type_id
      - target_task_type_id
      - target_settings
      - segment
      - river_type_id
      - file_zone_settings
      title: TargetTypeResponse
      description: Target Type properties to return.
    DataSourceTypeResponse:
      properties:
        id:
          type: string
          title: Id
          description: The internal id of the data source type.
          examples:
          - fb_ads
        name:
          type: string
          title: Name
          description: The name of the data source type.
          examples:
          - Salesforce
        description:
          type: string
          title: Description
          description: The data source type description.
          examples:
          - A distributed document-oriented database.
        documentation_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Documentation Url
          description: The URL to Boomi Data Integration data source type documentation.
          examples:
          - https://docs.rivery.io/docs/walkthrow-s3
        section_id:
          type: string
          title: Section Id
          description: The section id of the data source type.
          examples:
          - sec_crm
        status:
          allOf:
          - $ref: '#/components/schemas/DataSourceTypesStatusEnum'
          description: The status of the data source type being supported on Boomi Data Integration.
          examples:
          - enabled
        segment:
          items:
            $ref: '#/components/schemas/DataSourceTypesSegmentEnum'
          type: array
          title: Segment
          description: The list of supported data connections for the data source type
          examples:
          - - source
            - connections
            - target
        icon:
          type: string
          title: Icon
          description: The logo of the data source type.
          examples:
          - https://static-assets.console.rivery.io/snowflake.png
        connection_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Connection Type
          description: The related connection type of the data source, if exists
          examples:
          - zendesk_talk
        data_source_type_settings:
          allOf:
          - $ref: '#/components/schemas/DataSourceTypeSettings'
          description: Settings for data source type entities
          examples:
          - allow_high_frequency: true
        labels:
          items:
            type: string
          type: array
          title: Labels
          description: Additional labels markings for the data source type
          default: []
          examples:
          - - sunset
        feature_flags:
          anyOf:
          - type: object
          - type: 'null'
          title: Feature Flags
          description: Feature flags supported by the data source type
          examples:
          - is_connection_generic_pattern: true
            is_new_interface: true
        api_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Api Name
          description: The name of the data source that the API expects
          examples:
          - bigquery
      type: object
      required:
      - id
      - name
      - description
      - section_id
      - status
      - segment
      - icon
      - data_source_type_settings
      title: DataSourceTypeResponse
      description: The response fields for each data source type entity
    TargetTypesResponse:
      properties:
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: The next page URL
        previous_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Page
          description: The previous page URL
        page:
          type: integer
          title: Page
          description: The page number
          default: 1
        current_page_size:
          type: integer
          title: Current Page Size
          description: The current page size
        total_items:
          type: integer
          title: Total Items
          description: The total number of entities fetched
          default: 0
        items:
          items:
            $ref: '#/components/schemas/TargetTypeResponse'
          type: array
          title: Items
      type: object
      required:
      - current_page_size
      - items
      title: TargetTypesResponse
      description: The target types response
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview