Process Semantic Model

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the Login API.

Note: Session ID is required for token-based authentication.

—

name-or-id (Required)

String

Name or ID of the Semantic Model to be processed.

Note: If the Semantic Model name is provided, then either folderName or folderId must also be provided.

—

by

String

Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or a Semantic Model ID.

by=name – Provide the Semantic Model name in the name-or-id parameter.

by=id – Provide the Semantic Model ID in the name-or-id parameter.

Default: name

—

folderName

String

Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root].

Note: If neither folderName nor folderId is provided, the Semantic Model will be treated as a root-level entity by default.

—

folderId

String

ID of the folder containing the Semantic Model.

—

jobType

String

Specifies the Semantic Model processing job type.

FULL: Processes the Semantic Model with all available data, including recalculation of all aggregations.

INCREMENTAL: Updates the Semantic Model with the latest data.

UPDATE_AGGREGATES: Updates Semantic Model aggregates based on the current aggregation strategy.

TEST: Processes the Semantic Model with a limited number of rows.

DATA_PROFILE: Computes statistics such as distinct value count, invalid value count, and cardinality.

CACHE_POPULATION: Clears cached query responses and repopulates them with the latest Semantic Model data.

DROP_PARTITION: Creates rules to select partitions to drop.

replacePartition

Boolean

Determines whether incremental processing should replace existing partitions.

true / false

Default: false

runType

String

Determines when the Semantic Model processing job should run.

NOW: Immediately starts the job.

ONCE: Runs the job at the specified time.

RECURRING: Runs the job regularly at the specified time.

onceDateTime

String

Date and time when the job should start if runType is ONCE.

—

timeZone

String

Time zone for the scheduled job execution.

—

recurringSchedule

String

JSON configuration for recurring Semantic Model processing schedules.

—

userParams

String

User-defined parameters to be used during Semantic Model processing.

—

incrementalJobProcessType

String

Specifies the incremental processing type.

Note: If not provided, incremental data in all Datasets used in the Semantic Model design is processed.

FACT_ADJUSTMENTS: Processes incremental data only in the fact Datasets used in the Semantic Model design with adjustable measures.

dataProcessType

String

Specifies metadata-only processing for raw data querying-enabled Semantic Models.

METADATA_ONLY: Populates only the dimension metadata cache. User queries are submitted directly to the underlying data source.

keepData

String

Determines how Semantic Model data should be materialized.

ONLY_RAW_DATA: Materializes data without aggregations. Supports all queries but may incur higher processing overhead.

ONLY_QUERY_BASED_AGGREGATED: Materializes aggregates based on actual user query patterns.

DESIGN_AND_QUERY_BASED_AGGREGATED: Retains design-based aggregated data and updates it based on query patterns during subsequent processing.

RAW_AND_QUERY_BASED_AGGREGATED: Retains both raw data and query-based aggregated data.

jobConnectionName

String

Job connection name used for Semantic Model processing.

—

tagsJson

String

Tags associated with the Semantic Model processing job.

—

segmentCapacity

String

Specifies the number of nodes allocated for processing.

—

dropPartitionRulesJson

String

JSON configuration defining partition drop rules.

—

updateAggregatesPartitions

String

JSON configuration listing partitions to update for aggregate processing.

—

systemParamsJson

String

System parameter key-value pair configuration for Semantic Model processing.

—

recommendationParamsJson

String

Recommendation configuration parameters for aggregation recommendations.

—

401

Authorization information is missing or invalid.

404

No matching record found.

500

Internal Server Error.