Create, Save and Update Semantic Model JSON Examples
This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here. |
|---|
Table of Contents
Complete JSON Example
This JSON example applies to Create Semantic Model, Save Semantic Model, and Update Semantic Model APIs and can be used as a reference for request body object.
{
"iro":
{
"entityRepositDate":"1776922346420",
"ownerAppId":"398949229",
"linkedEntityId":"",
"type":"ANALYTICAL",
"specific":{
"smObject":{
"measures":{
"measure":[
{
"isKeyElement":false,
"dataField":{
"queryName":"Orders Date",
"content":"Sales",
"queryId":"15010652913815127066040160616314_0"
},
"color":"",
"materialize":"",
"adjustmentType":"NEGATIVE",
"description":"",
"type":"STANDARD",
"restrict":false,
"isBoundaryDistCount":false,
"id":"MEASURE_11",
"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":"Orders Date",
"queryId":"15010652913815127066040160616314_0"
},
"tags":"",
"isDefault":true,
"unit":"",
"uniqueName":"MEASURE_11",
"isAdjustment":false,
"isVisibleConversational":true,
"name":"Amount",
"subType":"",
"displayFolder":"",
"solveOrder":0
}
],
"incrementalUpdateProperties":{
"processingMode":1
}
},
"aggregationStrategy":{
"configurationDriven":{
"ENTITY_PROPS_VALUES":[
{
"mode":"DEFAULT",
"name":"kyvos.build.precompute.level.threshold",
"value":""
}
]
},
"type":"CONFIGURATION_DRIVEN"
},
"slidingWindows":[
],
"viewType":"",
"writebackSettings":{
"identifierElements":[
],
"enabled":false
},
"measureGroups":{
"measureGroup":[
{
"measureId":[
"MEASURE_11"
],
"isAccessible":true,
"materialize":"",
"name":"MeasureGroup",
"description":"",
"isVisible":true
}
],
"dataSources":[
{
"id":"15010652913815127066040160616314_0",
"type":"REFERENCED"
}
]
},
"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":"H_678469",
"hasParentChildRelation":false,
"defaultMemberUniqueName":"",
"pcLevelCount":-1,
"name":"H_RestAPI",
"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":"",
"displayFieldDataType":"",
"mapType":"",
"isAll":true,
"isVisible":true,
"fullyQualifiedName":"",
"parentField":{
"dataType":"",
"queryName":"",
"content":"",
"queryId":""
},
"tags":"",
"uniqueName":"DIMENSION_LEVEL_417027",
"isVisibleConversational":true,
"name":"Hierarchy.ALL",
"hasTimeInDateFormat":false,
"displayField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"memberProperties":[
],
"properties":[
]
},
{
"isKeyElement":false,
"dataField":{
"queryName":"Orders Date",
"queryIdPre":"",
"content":"OrderDate",
"queryId":"15010652913815127066040160616314_0"
},
"showValues":0,
"aggregationType":"BOTH",
"dateDataType":"",
"materialize":"YES",
"dateFormat":"",
"description":"",
"displayFieldSubDataType":"NONE",
"mapLevel":"",
"isDeleted":false,
"subDataType":"",
"geoRole":"",
"processType":"DATA_AND_METADATA",
"formatType":"4",
"fieldDataType":"",
"isAccessible":true,
"hideMember":0,
"dataType":"DATE",
"displayFieldDataType":"",
"mapType":"",
"isAll":false,
"isVisible":true,
"fullyQualifiedName":"",
"parentField":{
"dataType":"",
"queryName":"",
"content":"",
"queryId":""
},
"tags":"",
"uniqueName":"DIMENSION_LEVEL_314482",
"isVisibleConversational":true,
"name":"OrderDate",
"hasTimeInDateFormat":false,
"displayField":{
"queryName":"",
"queryIdPre":"",
"content":"",
"queryId":""
},
"memberProperties":[
],
"properties":[
]
}
]
}
],
"description":"",
"isVisible":true,
"scdType":2,
"restrict":false,
"type":"Time",
"incrementalUpdateProperties":{
"processingMode":1
},
"predefTimeHierarchy":"",
"tags":"",
"attrs":[
],
"dimToFactMapping":"ONE_TO_MANY",
"uniqueName":"DIM_230166",
"name":"RestAPI",
"defaultHierarchyUniqueName":"H_678469",
"id":"DIM_230166",
"smViewType":"",
"calcMembers":[
],
"dataSources":[
{
"id":"15010652913815127066040160616314_0",
"type":"REFERENCED"
}
]
}
]
},
"attrs":{
"isBound":"false",
"coType":"INTERNAL",
"rawDataConnectionMode":"DEFAULT",
"drdId":"17105045377248127095022132474898",
"smUniqueName":"",
"rawDataQuerying":"0",
"connectionName":"",
"modelType":"BASE",
"drdName":"Orders Date"
}
},
"folderId":"folder_16768983569080127071039143429505",
"designSource":"DESIGNER",
"ownerAppName":"admin",
"common":{
"compatibilityVersion":"1",
"desc":"",
"tags":""
},
"entityState":"ACTIVE",
"name":"RestAPIFolder",
"isPublic":true,
"subType":"CUBE",
"repositDate":"04/23/2026 11:02:26 IST",
"id":"106157",
"folderName":"AdventureWorksMF_copy_Rest",
"accessRights":"1",
"categoryId":"folder_16768983569080127071039143429505"
}
}