Post

/blobexpansions/

This endpoint initializes parsing parameters for an active event topic directory stream target table.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Body parameters

Expand All

object

database_name

string Required

Kafka bucket name containing the source topic

table_name

string Required

Source Kafka topic name

source_column_name

string

Source column name (defaults to "value" for Kafka topics)

tenant_id

integer

Tenant ID

target_table_name

string Required

Target table name for expanded data

target_table_schema

string

Target table schema (defaults to source table's schema)

expansion_format

string Required

Expansion format

Valid values[ "json" ]

arrow_schema

Array of object (TabularColumnArrowSchema) Required

Schema of the columns to parse from the blob

object

name

string Required

Name of the object

field

object Required

Column type

Example{ "column_type": "map", "key_type": { "column_type": "bool" }, "value_type": { "column_type": "bool" } }

copy_source_column

boolean

Whether to copy the raw source column to the target table

flatten_path

boolean

Whether to flatten nested struct columns

flatten_delimiter

string

Delimiter for flattened path column names (default "__")

add_missing_values_output

boolean

Add an output column tracking schema fields missing from the source blob (defaults to false)

add_excessive_values_output

boolean

Add an output column tracking source-blob fields not declared in the schema (defaults to false)

Responses

201

OK

Create a Blob Expansion