Fetch Column Data
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API fetches the list of columns for a specified level or attribute in a Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/fetch-column-data
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
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 |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Semantic Model from which column data needs to be retrieved. | – |
Query Parameters
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
columnDetails (Required) | String | A JSON string containing details of the Semantic Model and the specified level or attribute from which the column list is to be retrieved. Unique names for the hierarchy, dimension, attribute, and level must be provided. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"DIM_815!!!H_1647!!!H_1647_L02": [
{
"uniqueName": "",
"name": "Assets",
"id": "2"
},
{
"uniqueName": "",
"name": "Average Unit Price",
"id": "98"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the columnDetails parameter in the request body.
{
"smodelName":"AdventureWorks",
"folderName":"AdventureWorks",
"folderId":"",
"smodelId":"16781127519540127041056199890401",
"fetchKeyField":"true",
"memberdetails":[
{
"hierarchyName":"H_1647",
"dimensionName":"DIM_815",
"levelName":"H_1647_L02",
"filters":[
{
"levelName":"Country",
"operation":"STARTSWITHIGNORECASE",
"firstValue":"A"
}
]
}
]
}JSON Field Definitions
Field | Type | Description | Possible Values | Example |
smodelName | string | The name of the semantic model. Required if smodelId is not given. | Any valid semantic model name. | "AdventureWorksMF" |
smodelId | string | The ID of the semantic model. Required if smodelName is not given. | Any valid semantic model ID. | "" |
folderName | string | The folder name that contains the semantic model. Optional, recommended if the smodelId is not provided. | Any valid folder name. | "Kyvos_DataAccuracyCubes" |
folderId | string | The ID of the folder that contains the semantic model. Optional. | Any valid folder ID. | "" |
fetchKeyField | string | Whether to return the key field. Optional. | "true", "false" (default is "true"). | "true" |
memberdetails | array | A list of levels/attributes to fetch members from. Required. | One object per level or attribute. | [{...}] |
memberdetails[*].dimensionName | string | The unique name of the dimension. Required. | Any valid dimension unique name. | "DIM_815" |
memberdetails[*].hierarchyName | string | The unique name of the hierarchy. Required. | Any valid hierarchy unique name. | "H_1647" |
memberdetails[*].levelName | string | The unique name of the level or attribute. Required. | Any valid level or attribute unique name. | "H_1647_L02" |
memberdetails[*].filters | array | Filters to limit which members are returned. Optional. | One object per filter. | [{...}] |
memberdetails[*].filters[*].levelName | string | The level or attribute the filter applies to. Required inside a filter. | Any valid level/attribute name. | "Country" |
memberdetails[*].filters[*].operation | string | The type of match to perform. Required inside a filter. | STARTSWITHIGNORECASE or CONTAINSIGNORECASE. | "STARTSWITHIGNORECASE" |
memberdetails[*].filters[*].firstValue | string | The text to search for. Required inside a filter. | Any text. | "Afghanistan" |