Skip to main content

Read a specific Aggregate.

GET 
/v1/public/aggregates/export/catalogs/:catalogId/models/:modelId

This API exports System-Defined aggregate definitions that may then be imported using the Imported to another system that has the same ModelID. Note that User-Defined Aggregates (UDA's) are not included in the export.

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.

Header Parameters

    Authorization string

Responses​

Success.

Schema

    atScaleExportVersion stringrequired

    The AtScale system version from which the export originated.

    exportSummary

    object

    required

    Summarized information such as aggregate count, grouped by Connection ID.

    connectionIds

    object

    required

    count numberrequired
    values string[]
    exportTimestamp stringrequired

    Server-generated timestamp the export file was generated.

    exportCatalogId stringrequired

    catalog ID

    exportModelId stringrequired

    Cube ID. Must exist on the target system.

    aggregates

    object

    required

    Aggregate Definitions. For internal use only.

    count numberrequired

    values

    object[]

  • Array [

    • id stringrequired
    userDefinedId stringrequired
    userDefinedName stringrequired
    triggeringQueryId stringrequired
    environmentId stringrequired
    catalogId stringrequired
    planJson stringrequired
    createdAt nullable
    latestInstanceId stringrequired
    baseType nullable
    subType nullable
    hintedDatasetId stringrequired
    activeInstanceId stringrequired
    connectionId stringrequired
    promotedCopyOf booleanrequired
    promoted booleanrequired

    incidentalData

    object

    required

    type stringrequired
    data-set-id stringrequired

  • ]

Loading...