Skip to content

au3 solution installation phase deliverable-model — Command Reference

CLI command group: au3 solution installation phase deliverable-model

Commands for the Deliverable Model phase: managing delivery connections, buckets, warehouses, and warehouse supplementation for finished deliverable data.


au3 solution installation phase deliverable-model connection

au3 solution installation phase deliverable-model connection list

List connections

Option Type Required Default Notes
--fields string Comma-separate list of fields to display
--filter string Filter in JSON/YAML format or path to file containing filter
--sort string Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search string Search in JSON/YAML format or path to file containing search
--limit 100 Number of results to fetch
--skip Number of results to skip
--all boolean false Whether to fetch results from all pages
--stream boolean false Whether to print results as they are received without buffering (as JSON)
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection view

View sync agent connection

Option Type Required Default Notes
--id string ✅ logical connection id
--fields string comma-separated list of fields to display
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection create

Create sync agent connection

Option Type Required Default Notes
--connection_id string ✅ Sync agent connection id
--phase_id string Id of logical connection which maps to primary or secondary connection depending on the connection's mode
--phase_mode enum ✅ Choices: "primary_reference", "secondary", "primary"
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection update

Update phase connection mapping

Option Type Required Default Notes
--id string ✅ logical connection id
--connection_id string ✅ organization connection id
--phase_mode string ✅ primary or secondary
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection set-mode

Set sync agent connection mode

Option Type Required Default Notes
--id string ✅ logical connection id
--mode enum logical connection mode Choices: "primary_reference", "secondary", "primary"
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection discover-buckets

Discover buckets sync agent connection

Option Type Required Default Notes
--id string ✅ Id of logical connection
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection discover-warehouses

Discover warehouses sync agent connection

Option Type Required Default Notes
--id string ✅ Id of logical connection
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model connection delete

Delete logical connection from solution configuration

Option Type Required Default Notes
--id string ✅ logical connection id
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model bucket

au3 solution installation phase deliverable-model bucket list

List buckets

Option Type Required Default Notes
--fields string Comma-separate list of fields to display
--filter string Filter in JSON/YAML format or path to file containing filter
--sort string Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search string Search in JSON/YAML format or path to file containing search
--limit 100 Number of results to fetch
--skip Number of results to skip
--all boolean false Whether to fetch results from all pages
--stream boolean false Whether to print results as they are received without buffering (as JSON)
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model bucket view

View bucket

Option Type Required Default Notes
--id string ✅ bucket id
--fields string comma-separate list of fields to display
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model warehouse

au3 solution installation phase deliverable-model warehouse list

List warehouses

Option Type Required Default Notes
--fields string Comma-separate list of fields to display
--filter string Filter in JSON/YAML format or path to file containing filter
--sort string Ordered list of fields to sort by in JSON/YAML format or path to file containing sorting
--search string Search in JSON/YAML format or path to file containing search
--limit 100 Number of results to fetch
--skip Number of results to skip
--all boolean false Whether to fetch results from all pages
--stream boolean false Whether to print results as they are received without buffering (as JSON)
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model warehouse view

View warehouse

Option Type Required Default Notes
--id string ✅ warehouse id
--fields string comma-separate list of fields to display
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

au3 solution installation phase deliverable-model warehouse supplementation

au3 solution installation phase deliverable-model warehouse supplementation update

Update supplementation

Option Type Required Default Notes
--spec-schema boolean view the schema for update
--spec string spec in JSON/YAML format or path to file containing spec
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error
--spec payload reference

Schema ID: UpdateSolutionInstallationDraftDeliverableModelWarehouseSupplementationArgumentDto

This section documents the --spec payload accepted by au3 solution installation phase deliverable-model warehouse supplementation update. Run solution installation phase deliverable-model warehouse supplementation update --spec-schema to fetch this schema live from the CLI at any time.

Tip: additionalProperties: false — the schema rejects any field not listed below.

Top-Level Fields
Field Type Required Notes
id string ✅ Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
supplementation object ✅
supplementation
Field Type Required Notes
supplemental_tables array
supplemented_views array
supplemental_views array List of supplemental views defined as any other view, but in addition to solution-defined views

supplemental_tables (array items)

Field Type Required Notes
id string ✅ Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
warehouse string ✅ Warehouse id — Pattern: ^whs-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ — e.g. whs-123e4567-e89b-41d2-a345-678901234567
entity string ✅ Unique id for a table/view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
fields array List of fields to include from supplementing entity

supplemented_views (array items)

Field Type Required Notes
id string ✅ Unique id for a view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
supplementations array ✅ List of suppplementations to append to the view. Id is of a table in the warehouse (likely supplemental table), which must share a PK with the supplemented view

supplementations (array items)

List of suppplementations to append to the view. Id is of a table in the warehouse (likely supplemental table), which must share a PK with the supplemented view

Field Type Required Notes
id string ✅ Unique id for a table within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
fields array List of fields to include from supplementing entity

supplemental_views (array items)

List of supplemental views defined as any other view, but in addition to solution-defined views

Field Type Required Notes
id string ✅ Unique id for a view within an ERM — Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$ — 2–64 characters
name string ✅ Object name with 2-64 characters — 2–64 characters
description string Object description with 0 or 2-256 characters — Pattern: (^$)|(^.{2,256}$) — 0–256 characters
text object
hidden boolean Whether the object is hidden — Default: False
primaryKey object Which of the fields is the primary key for the table/view. Composite keys are specified as an array.
query string ✅ Query used to build view based on other tables/views
properties object ✅ Field definitions with field id as key
propertiesOrder array ✅ Ordered list of all field ids for parsing/display

text

Field Type Required Notes
singular string Singular term to use in UIs. Defaults to name.
plural string Plural term to use in UIs. Defaults to s appended to singular term.

primaryKey

Which of the fields is the primary key for the table/view. Composite keys are specified as an array.

The primaryKey object is a discriminated union. One of the following 2 shapes applies.

Variant 1

Field Type Required Notes

Variant 2

Field Type Required Notes

properties

Field definitions with field id as key

Map keyed by field name matching pattern ^[a-zA-Z][a-zA-Z0-9_]*$.

Example Spec
id: whs-123e4567-e89b-41d2-a345-678901234567
supplementation: {}

au3 solution installation phase deliverable-model warehouse supplementation delete

Delete supplementation

Option Type Required Default Notes
--id string ✅ warehouse id
--fmt enum human Output format Choices: "human", "json", "yaml"
--debug boolean false Enable more verbose output on error

Generated from au3 solution installation phase deliverable-model --help and subcommand help output.