Skip to content
Navigation

Test a Connection Table

POST
http://localhost:5115/api/v1/connection_tables/test

Request body JSON required

  • config
    unknown
    required
  • connector
    string
    required
  • name
    string
    required
  • connection_profile_id
    optional
    string
    or null
  • schema
    optional
    object
    or null
    • bad_data
      optional
      or null

      One of the following:

      • Fail
        • behavior
          fail
          required
      • Drop
        • behavior
          drop
          required
    • definition
      optional
      or null

      One of the following:

      • JsonSchema
        • schema
          string
          required
        • type
          json_schema
          required
      • Protobuf
        • schema
          string
          required
        • type
          protobuf_schema
          required
        • dependencies
          optional
          map of
          string
      • Avro
        • schema
          string
          required
        • type
          avro_schema
          required
    • fields
      optional
      array of
      SourceField
      • name
        string
        required
      • metadata_key
        optional
        string
        or null
      • required
        optional
        boolean

      And one of the following:

      • Int32
        • type
          int32
          required
      • Int64
        • type
          int64
          required
      • UInt32
        • type
          uint32
          required
      • UInt64
        • type
          uint64
          required
      • Float32
        • type
          float32
          required
      • Float64
        • type
          float64
          required
      • Decimal128
        • precision
          integer
          required
          format: int32 · minimum: 0
        • scale
          integer
          required
          format: int32
        • type
          decimal128
          required
      • Bool
        • type
          bool
          required
      • String
        • type
          string
          required
      • Bytes
        • type
          bytes
          required
      • Timestamp
        • type
          timestamp
          required
        • unit
          optional
          second
          or
          millisecond
          or
          microsecond
          or
          nanosecond
      • Json
        • type
          json
          required
      • Struct
        • fields
          array of
          SourceField
          required
          • name
            string
            required
          • metadata_key
            optional
            string
            or null
          • required
            optional
            boolean

          And one of the following:

          • Int32
            • type
              int32
              required
          • Int64
            • type
              int64
              required
          • UInt32
            • type
              uint32
              required
          • UInt64
            • type
              uint64
              required
          • Float32
            • type
              float32
              required
          • Float64
            • type
              float64
              required
          • Decimal128
            • precision
              integer
              required
              format: int32 · minimum: 0
            • scale
              integer
              required
              format: int32
            • type
              decimal128
              required
          • Bool
            • type
              bool
              required
          • String
            • type
              string
              required
          • Bytes
            • type
              bytes
              required
          • Timestamp
            • type
              timestamp
              required
            • unit
              optional
              second
              or
              millisecond
              or
              microsecond
              or
              nanosecond
          • Json
            • type
              json
              required
          • Struct
          • List
            • items
              ListFieldItem
              required
              • name
                optional
                string
              • required
                optional
                boolean

              And one of the following:

              • Int32
                • type
                  int32
                  required
              • Int64
                • type
                  int64
                  required
              • UInt32
                • type
                  uint32
                  required
              • UInt64
                • type
                  uint64
                  required
              • Float32
                • type
                  float32
                  required
              • Float64
                • type
                  float64
                  required
              • Decimal128
                • precision
                  integer
                  required
                  format: int32 · minimum: 0
                • scale
                  integer
                  required
                  format: int32
                • type
                  decimal128
                  required
              • Bool
                • type
                  bool
                  required
              • String
                • type
                  string
                  required
              • Bytes
                • type
                  bytes
                  required
              • Timestamp
                • type
                  timestamp
                  required
                • unit
                  optional
                  second
                  or
                  millisecond
                  or
                  microsecond
                  or
                  nanosecond
              • Json
                • type
                  json
                  required
              • Struct
              • List
            • type
              list
              required
        • type
          struct
          required
      • List
        • items
          ListFieldItem
          required
          • name
            optional
            string
          • required
            optional
            boolean

          And one of the following:

          • Int32
            • type
              int32
              required
          • Int64
            • type
              int64
              required
          • UInt32
            • type
              uint32
              required
          • UInt64
            • type
              uint64
              required
          • Float32
            • type
              float32
              required
          • Float64
            • type
              float64
              required
          • Decimal128
            • precision
              integer
              required
              format: int32 · minimum: 0
            • scale
              integer
              required
              format: int32
            • type
              decimal128
              required
          • Bool
            • type
              bool
              required
          • String
            • type
              string
              required
          • Bytes
            • type
              bytes
              required
          • Timestamp
            • type
              timestamp
              required
            • unit
              optional
              second
              or
              millisecond
              or
              microsecond
              or
              nanosecond
          • Json
            • type
              json
              required
          • Struct
            • fields
              array of
              SourceField
              required
              • name
                string
                required
              • metadata_key
                optional
                string
                or null
              • required
                optional
                boolean

              And one of the following:

              • Int32
                • type
                  int32
                  required
              • Int64
                • type
                  int64
                  required
              • UInt32
                • type
                  uint32
                  required
              • UInt64
                • type
                  uint64
                  required
              • Float32
                • type
                  float32
                  required
              • Float64
                • type
                  float64
                  required
              • Decimal128
                • precision
                  integer
                  required
                  format: int32 · minimum: 0
                • scale
                  integer
                  required
                  format: int32
                • type
                  decimal128
                  required
              • Bool
                • type
                  bool
                  required
              • String
                • type
                  string
                  required
              • Bytes
                • type
                  bytes
                  required
              • Timestamp
                • type
                  timestamp
                  required
                • unit
                  optional
                  second
                  or
                  millisecond
                  or
                  microsecond
                  or
                  nanosecond
              • Json
                • type
                  json
                  required
              • Struct
              • List
            • type
              struct
              required
          • List
        • type
          list
          required
    • format
      optional
      or null

      One of the following:

      • Json
        • type
          json
          required
        • compression
          optional
          uncompressed
          or
          gzip
        • confluent_schema_registry
          optional
          boolean
        • debezium
          optional
          boolean
        • decimal_encoding
          optional
          number
          or
          string
          or
          bytes
        • include_schema
          optional
          boolean
        • schema_id
          optional
          integer
          or null
          format: int32 · minimum: 0
        • timestamp_format
          optional
          rfc3339
          or
          unix_millis
        • unstructured
          optional
          boolean
      • Avro
        • type
          avro
          required
        • confluent_schema_registry
          optional
          boolean
        • into_unstructured_json
          optional
          boolean
        • raw_datums
          optional
          boolean
      • Protobuf
        • type
          protobuf
          required
        • compiled_schema
          optional
          string
          or null
          format: binary
        • confluent_schema_registry
          optional
          boolean
        • into_unstructured_json
          optional
          boolean
        • length_delimited
          optional
          boolean
        • message_name
          optional
          string
          or null
      • Parquet
        • type
          parquet
          required
        • compression
          optional
          uncompressed
          or
          snappy
          or
          gzip
          or
          zstd
          or
          lz4
          or
          lz4_raw
        • row_group_bytes
          optional
          integer
          or null
          format: int64 · minimum: 0
      • RawString
        • type
          raw_string
          required
      • RawBytes
        • type
          raw_bytes
          required
    • framing
      optional
      or null

      One of the following:

      • Newline
        • method
          newline
          required
        • max_line_length
          optional
          integer
          or null
          format: int64 · minimum: 0
    • inferred
      optional
      boolean
      or null
    • primary_keys
      optional
      array of
      string

Returns

200

Job output as 'text/event-stream'

Type to search…

↑↓ navigate↵ selectEsc close