Get Semantic Model
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API is used to get Semantic Model Object.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}
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 |
|---|---|---|---|
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 to be retrieved. Note: If the Semantic Model name is provided, then either folderName or folderId must also be provided. | – |
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. | – |
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. | – |
forBrowsing | Boolean | Indicates whether browsing details should be fetched for the Semantic Model. |
Default: |
includeHiddenMeasure | Boolean | Indicates whether hidden measures should be included in the Semantic Model. Note: Applicable only when forBrowsing=true. |
Default: |
Responses
200 Success
{
"iro":{
"entityRepositDate":"1779186496665",
"ownerAppId":"397039469",
"linkedEntityId":"",
"type":"ANALYTICAL",
"specific":{
"smObject":{
"measures":{
"measure":[
{
"isKeyElement":false,
"dataField":{
"queryName":"account",
"content":"weight",
"queryId":"17776293111705127099085188446220_0"
},
"color":"",
"materialize":"",
"adjustmentType":"NEGATIVE",
"description":"",
"type":"STANDARD",
"restrict":false,
"isBoundaryDistCount":false,
"id":"MEASURE_907901",
"formatType":"2",
"isAccessible":true,
"expression":{
"nonEmptyBehavior":"BY_MEASURE",
"content":""
},
"dataType":"NUMBER",
"summaryFunction":"0",
"dictionaryType":"INDEX",
"format":{
"useDefault":"0",
"content":"#,##0.00"
},
"isVisible":true,
"actualSummaryFunction":"0",
"minOnMaxOnDataField":{
"queryName":"account",
"content":"",
"queryId":"17776293111705127099085188446220_0"
},
"tags":"",
"isDefault":true,
"unit":"",
"uniqueName":"MEASURE_907901",
"isAdjustment":false,
"isVisibleConversational":true,
"name":"weight",
"subType":"",
"displayFolder":"",
"solveOrder":0
}
],
"incrementalUpdateProperties":{
"processingMode":1
}
},
"aggregationStrategy":{
"queryDriven":{
"orientationInfo":"1"
},
"type":"QUERY_DRIVEN"
},
"slidingWindows":[
],
"viewType":"",
"writebackSettings":{
"identifierElements":[
],
"enabled":false
},
"measureGroups":{
"measureGroup":[
{
"measureId":[
"MEASURE_907901"
],
"isAccessible":true,
"materialize":"",
"name":"account",
"description":"",
"isVisible":true
}
],
"dataSources":[
{
"id":"17776293111705127099085188446220_0",
"type":"REFERENCED"
}
]
},
"linkDesignLayout":{
},
"layoutProperty":{
"panelDetails":{
"sourceFields":{
"style":{
},
"id":"sourceFields"
},
"filters":{
"style":{
},
"id":"filters"
},
"properties":{
"style":{
},
"id":"properties"
}
},
"columnDetails":[
{
"panels":[
],
"style":{
}
},
{
"panels":[
],
"style":{
}
}
]
},
"dimensions":[
{
"dataField":{
"queryName":"",
"content":"",
"queryId":""
},
"isAccessible":true,
"isGisEnabled":false,
"materialize":"",
"restrictValues":false,
"hierarchies":[
{
"qualifyMembers":{
"type":"ALL_PARENTS",
"value":""
},
"dataField":{
"queryName":"",
"content":"",
"queryId":""
},
"isAccessible":true,
"hasAll":false,
"materialize":"",
"description":"",
"isVisible":true,
"isCustomCalendar":false,
"allMemberUniqueName":"",
"predefTimeHierarchy":"",
"tags":"",
"isDefault":false,
"hasAlternatePath":false,
"uniqueName":"Measures",
"hasParentChildRelation":false,
"defaultMemberUniqueName":"",
"pcLevelCount":-1,
"name":"",
"smViewType":"",
"displayFolder":"",
"levels":[
{
"isKeyElement":false,
"dataField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"showValues":0,
"aggregationType":"BOTH",
"dateDataType":"",
"materialize":"",
"dateFormat":"",
"description":"",
"displayFieldSubDataType":"NONE",
"mapLevel":"",
"isDeleted":false,
"subDataType":"",
"geoRole":"",
"processType":"DATA_AND_METADATA",
"formatType":"",
"fieldDataType":"",
"isAccessible":true,
"hideMember":0,
"dataType":"Regular",
"displayFieldDataType":"",
"mapType":"",
"isAll":false,
"isVisible":true,
"fullyQualifiedName":"",
"parentField":{
"dataType":"",
"queryName":"",
"content":"",
"queryId":""
},
"tags":"",
"uniqueName":"MeasuresLevel",
"isVisibleConversational":true,
"name":"",
"hasTimeInDateFormat":false,
"displayField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"memberProperties":[
],
"properties":[
]
}
]
}
],
"description":"",
"isVisible":true,
"scdType":2,
"restrict":false,
"type":"MEASURE",
"incrementalUpdateProperties":{
"processingMode":1
},
"predefTimeHierarchy":"",
"tags":"",
"attrs":[
{
"isKeyElement":false,
"dataField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"aggregationType":"BOTH",
"dateDataType":"",
"materialize":"",
"dateFormat":"",
"description":"",
"type":"",
"displayFieldSubDataType":"NONE",
"mapLevel":"",
"isDeleted":false,
"subDataType":"",
"geoRole":"",
"processType":"DATA_AND_METADATA",
"formatType":"",
"fieldDataType":"",
"isAccessible":true,
"dataType":"",
"displayFieldDataType":"",
"isVisible":true,
"tags":"",
"uniqueName":"Attribute",
"isVisibleConversational":true,
"name":"Attribute",
"hasTimeInDateFormat":false,
"displayField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"processMetadata":"YES",
"memberProperties":[
],
"displayFolder":""
}
],
"dimToFactMapping":"ONE_TO_MANY",
"uniqueName":"Measures",
"name":"Measures",
"defaultHierarchyUniqueName":"Measures",
"id":"Dim_Measures",
"smViewType":"",
"calcMembers":[
],
"dataSources":[
]
},
{
"dataField":{
"queryName":"",
"content":"",
"queryId":""
},
"isAccessible":true,
"isGisEnabled":false,
"materialize":"",
"restrictValues":false,
"hierarchies":[
],
"description":"",
"isVisible":true,
"scdType":2,
"restrict":false,
"type":"Regular",
"incrementalUpdateProperties":{
"processingMode":1
},
"predefTimeHierarchy":"",
"tags":"",
"attrs":[
{
"isKeyElement":false,
"dataField":{
"queryName":"account",
"queryIdPre":"",
"content":"accountid",
"queryId":"17776293111705127099085188446220_0"
},
"aggregationType":"BOTH",
"dateDataType":"",
"materialize":"YES",
"dateFormat":"",
"description":"",
"type":"Regular",
"displayFieldSubDataType":"NONE",
"mapLevel":"",
"isDeleted":false,
"subDataType":"",
"geoRole":"",
"processType":"DATA_AND_METADATA",
"formatType":"",
"fieldDataType":"",
"isAccessible":true,
"dataType":"CHAR",
"displayFieldDataType":"",
"isVisible":true,
"tags":"",
"uniqueName":"DIMENSION_ATTRIBUTE_882036",
"isVisibleConversational":true,
"name":"accountid",
"hasTimeInDateFormat":false,
"displayField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"processMetadata":"YES",
"memberProperties":[
],
"displayFolder":""
}
],
"dimToFactMapping":"ONE_TO_MANY",
"uniqueName":"DIM_514101",
"name":"account",
"defaultHierarchyUniqueName":"null",
"id":"DIM_514101",
"smViewType":"",
"calcMembers":[
],
"dataSources":[
{
"id":"17776293111705127099085188446220_0",
"type":"REFERENCED"
}
]
}
]
},
"attrs":{
"isBound":"false",
"coType":"INTERNAL",
"rawDataConnectionMode":"DEFAULT",
"drdId":"17774470367650127033091134492479",
"smUniqueName":"",
"rawDataQuerying":"0",
"connectionName":"",
"modelType":"BASE",
"drdName":"account"
}
},
"folderId":"folder_17748761184111127067026113331526",
"designSource":"DESIGNER",
"ownerAppName":"admin",
"common":{
"compatibilityVersion":"3",
"desc":"",
"tags":""
},
"entityState":"ACTIVE",
"name":"Sales",
"isPublic":true,
"subType":"CUBE",
"repositDate":"05/27/2026 14:52:46 IST",
"id":"SMODEL_OBJECT_17748761273700127033075188430671",
"folderName":"Admin",
"accessRights":"1",
"categoryId":"folder_17748761184111127067026113331526"
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |