[]
        
(Showing Draft Content)

DataModel

DataModel

[GET] /api/v2/data/data-models/analysis-models/{documentId}/download

Download a model document.

Parameters

Name Type Located In Description
documentIdRequired string path document id. For example: b48bb95f-7bb7-c55b-c251-b118e6bee4bb

Response

Status Code: 200

Success

binary

Status Code: 400

Bad Request

DatasetPluginError

Status Code: 404

Not Found

DatasetPluginError

[GET] /api/v2/data/data-models/{id}/query

Query data model.

Parameters

Name Type Located In Description
idRequired string path data model id
query string query query
queryType string query query type
format string query format
UnknownTypeHandle string query unknown type handle
MissParameterHandle string query miss parameter handle
RowLimit string query row limit

Response

Status Code: 200

Success

binary

Status Code: 400

Bad Request

DatasetPluginError

Status Code: 404

Not Found

DatasetPluginError

[POST] /api/v2/data/data-models/{id}/query

Query data model.

Parameters

Name Type Located In Description
idRequired string path data model id

Request Schema

QueryDataModelRequestBody

Response

Status Code: 200

Success

binary

Status Code: 400

Bad Request

DatasetPluginError

Status Code: 404

Not Found

DatasetPluginError

[POST] /api/v2/data/data-models/analysis-models/batch-rebuild-cache

Rebuild the Analysis Cached Model cache.

Request Schema

BatchRebuildModelsRequestViewModelV2

Response

Status Code: 200

Success

RebuildResultV2

Status Code: 400

Bad Request

AnalysisModelErrorV2

Models

Ƭ DatasetPluginError

Name Type Description Example
codeNullable string error code
messageNullable string error message
contextNullable string error context
innerError DatasetPluginError

Ƭ QueryDataModelRequestBody

Query data model request body

Name Type Description Example
datasourceParametersNullable string Datasource parameters
queryNullable string Query
queryTypeNullable string QueryType
formatNullable string Format
options Options

Ƭ Options

Name Type Description Example
unknownTypeHandleNullable string Unknown type handle
missParameterHandleNullable string Miss parameter handle
rowLimitNullable string Row limit

Ƭ RebuildResultV2

Name Type Description Example
documentIdNullable string Document id.
succeeded Boolean Result of rebuild task.
errorCode int32 Error code when the rebuild failed.
errorMessageNullable string Error message when the rebuild failed.
modified ISO DateTime Sting Rebuild cache data time.

Ƭ AnalysisModelErrorV2

Analysis model plugin error model

Name Type Description Example
codeNullable string Error code
messageNullable string Error message
contextNullable string Error context
innerError AnalysisModelErrorV2

Ƭ BatchRebuildModelsRequestViewModelV2

Represent a batch rebuild model.

Name Type Description Example
documentIds Array<string> Document id array ["5b0a797d-3f47-420e-a34b-37b3fd9ed934","d5b53d25-cb57-43a5-a027-cac17522e785"]