Skip to main content

Uploads System-Defined Aggregate Definition.

POST 
/v1/public/aggregates/import/catalogs/:catalogId/models/:modelId

This API imports System-Defined aggregate definitions exported from the UI or the /aggregates/export API. The Request Body is expected to match that of the /aggregates/export endpoint Response Body. The identical model, as defined by Model ID, must exist in the system for this call to succeed. This API does not support importing from newer versions to older versions of AtScale. For best results, Aggregate Definitions should be migrated between AtScale servers with identical version numbers.

Request​

Path Parameters

    catalogId stringrequired

    The catalog ID (UUID) for which you are querying.

    modelId stringrequired

    The model ID (UUID) for which you are querying.

Query Parameters

    importDistributionKey boolean

    Whether to import distribution hints in aggregate logical plans (defaults to true if unspecified).

    importPartitionKeys boolean

    Whether to import partition hints in aggregate logical plans (defaults to true if unspecified).

    importReplication boolean

    Whether to import replication hints in aggregate logical plans (defaults to true if unspecified).

    connectionRemap string

    originalConnId:newConnId (no remap if unspecified). Pass multiple connection Remap variables to perform multiple remap operations.

Header Parameters

    Authorization string

Body

required

    aggregates

    object

    required

    count numberrequired

    values

    object[]

    required

  • Array [

    • activeInstanceId stringrequired
    baseType stringrequired
    blocked booleanrequired
    connectionId stringrequired
    createdAt stringrequired
    modelId stringrequired
    id stringrequired
    latestInstanceId stringrequired

    notes

    object

    required

    dimensional booleanrequired
    organizationId stringrequired

    planJson

    object

    required

    model

    object

    required

    id stringrequired
    hints undefined[]required

    selection

    object

    required

    columns

    object[]

    required

  • Array [

    • oneOf

    aggregation-type

    object

    required

    type stringrequired
    alias stringrequired
    type stringrequired

    value

    object

    required

    model

    object

    required

    id stringrequired

    key

    object

    required

    key

    object

    required

    model nullnullablerequired
    id stringrequired
    type stringrequired

    ref-path

    object

    required

    refs undefined[]required
    type stringrequired
    type stringrequired
    type stringrequired

  • ]

    • from

    object

    required

    model

    object

    required

    id stringrequired
    type stringrequired
    limit nullnullablerequired
    order undefined[]required
    type stringrequired
    type stringrequired
    catalogId stringrequired
    promoted booleanrequired
    subType stringrequired
    triggeringQueryId stringrequired

  • ]

    • atScaleExportVersion stringrequired
    exportModelId stringrequired
    exportCatalogId stringrequired

    exportSummary

    object

    required

    connectionIds

    object

    required

    count numberrequired
    values string[]required
    exportTimestamp stringrequired

Responses​

Success.

Schema

    atScaleExportVersion stringrequired

    The AtScale system version from which the export originated.

    exportCatalogId stringrequired

    Catalog ID

    importCatalogId stringrequired

    ID of the Catalog to which the file was imported.

    modelId stringrequired

    ID of the Model containing the aggregate definitions.

    numberOfDefinitionsImported numberrequired

    Count of aggregate definitions that were imported.

    numberOfDefinitionsIgnored numberrequired

    Count of aggregate definitions that were not imported.

    aggregates

    object

    required

    Count: count of the response Values array, Values[ id: Source Aggregate UUID, newID: New Aggregate UUID, Imported: True|False, reason: Human readable reason for Imported=False.]

    count numberrequired

    values

    object[]

    required

  • Array [

    • id stringrequired
    newId string
    imported booleanrequired
    reason string

  • ]

Loading...