1Get SQL Metadata of a Semantic Model

Overview

This API imports SQL metadata of a Semantic Model.

Method: GET

Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/sql-metadata

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name

Type

Description

Possible Values

sessionid

String

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

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

–

Path Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Semantic Model whose SQL metadata needs to be retrieved.

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

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
by	String	Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is 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.	–
isAIUsecase	Boolean	Indicates whether the SQL metadata should include additional AI-specific Semantic Model metadata. When set to true, the API retrieves and enriches the response with metadata used for AI-powered features and analysis.	`true` / `false` Default: `false`

Responses

200 Success

[
    {
        "container": "MEASURE",
        "isVisibleInCube": true,
        "visible": true,
        "fieldName": "weight",
        "associationType": "MEASURE",
        "summaryFunction": "SUM",
        "dataType": "NUMBER",
        "description": "",
        "isHidden": false,
        "tags": [],
        "measureGroupName": "account",
        "entityName": "weight_1",
        "name": "weight_1",
        "associationID": "MEASURE_291563"
    }
]

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
500	Internal Server Error