Skip to main content

Trigger aggregates batch build

POST 

/v1/aggregates-batch/catalogs/:catalogId/models/:modelId

Trigger aggregates batch build

Request​

Path Parameters

    catalogId stringrequired

    The Catalog ID.

    modelId stringrequired

    The Model ID.

Query Parameters

    isFullBuild boolean
    isDataReady boolean

    Marks the batch as a data-ready batch. Aggregates that depend on a dataset flagged as data-ready are held until the dataset is signaled as ready, the wait timeout elapses, or the batch is cancelled. Defaults to false.

    waitReadyTime integer

    Possible values: >= 1

    How long to wait (in minutes, minimum 1) for the data-ready signal before the timeout policy fires. Defaults to the model configuration (120 minutes). Ignored when isDataReady is false.

Header Parameters

    Authorization string

Body

Optional grace period overrides

    gracePeriodOverrides

    object

    required

    property name* number

Responses​

Success.

Schema

    batch

    object

    id uuidrequired
    catalogId uuidrequired
    modelId uuidrequired
    createDate date-timenullablerequired
    startTime date-timenullable
    endTime date-timenullable
    status stringrequired
    exceptionMessage string
    exceptionClass string
    estimateTime number
    isFullBuild booleanrequired
    orderingGraph string
    sumOfInstanceBuildTimes number
    batchType stringrequired
    success booleanrequired
Loading...