Skip to main content
POST
Start an Apache Ossie conversion
Converts between a Cube data model and an Apache Ossie (Open Semantic Interchange) model, and returns polling URLs immediately. An export converts the YAML data model of the deployment’s latest successful build, or uploaded YAML files, to one Ossie model; an import converts an uploaded Ossie model to Cube data model files. Neither changes the deployment. Only static YAML model files are converted; JavaScript models and Jinja-templated files are skipped. Uploads are limited to 512 files of at most 2 MiB each and 20 MiB in total. Requests and results are kept for at most one day. Requires SchemaRead or SchemaUpdate access. This is currently in preview — reach out to the Cube support team to activate it for your account.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Body

application/json

OssieConversionInput

direction
enum<string>
required

'export' converts a Cube data model to an Ossie model; 'import' converts an Ossie model to Cube data model files.

Available options:
export,
import
baseCube
string | null

Import only. The dataset the generated view is rooted at, for an Ossie model whose relationships do not determine one.

dialect
enum<string> | null

Import only. The warehouse dialect whose expressions are preferred where the Ossie model has several; ANSI_SQL is always the fallback. Defaults to the dialect of the deployment's default data source, or ANSI_SQL.

Available options:
ANSI_SQL,
SNOWFLAKE,
DATABRICKS,
BIGQUERY
files
object | null

Export with source 'files' only. Relative .yml/.yaml paths mapped to their contents, such as a local checkout of the data model. Other files are not accepted.

ossieYaml
string | null

Import only. The Ossie YAML document to convert.

source
enum<string> | null

Export only. 'deployment' (the default) converts the YAML data model of the deployment's latest successful build; 'files' converts the files sent with the request.

Available options:
deployment,
files
strictFanout
boolean | null

Export only. Refuse a metric whose value join fan-out could change, instead of converting it with a warning. Defaults to false for a whole-model export and true for a view export.

view
string | null

Export only. Convert just this view's public members instead of the whole model.

Response

202 - application/json
conversionId
string
required
resultUrl
string
required
status
enum<string>
required
Available options:
QUEUED
statusUrl
string
required