Get Cache Population Rules
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves cache population rules associated with a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/cache-strategy-rules
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 whose cache population rules need to be retrieved. Note: If the Semantic Model name is provided, then folderName 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 folderName is not provided, then the Semantic Model will be treated as a root-level entity by default. | – |
Responses
200 Success
{
"entities": [
{
"subType": "CUBE",
"rules": [
{
"cacheOnCubeRebuild": "ALL",
"cacheAction": "REPOPULATE_CACHE",
"precacheSqlCascadingFilters": "AUTO",
"id": "17037685054133172360",
"filters": [
{
"isMemberValue": true,
"fieldName": "QUERY_STATUS",
"firstValue": {
"content": "'SUCCESS'"
},
"searchContext": "",
"includeCurrent": false,
"useField": false,
"fieldDisplayName": "Query Status",
"relation": "AND",
"useFieldType": "VALUE",
"isAppliedOnDisplayField": true,
"delimiter": "^`~",
"secondValue": "",
"valueType": "predefined",
"id": "f1",
"nonVisual": false,
"firstDisplayValue": "Success",
"suspend": false,
"isParameter": false,
"valueBy": "",
"dataType": "CHAR",
"topN": {
"field": ""
},
"topNDisplayValue": "",
"endEnclosure": "",
"isSearchFilter": false,
"sortOrder": "",
"startEnclosure": "",
"filterType": "",
"showInDataCard": false,
"secondDisplayValue": "",
"operation": "INLIST",
"fieldType": "CACHE_BUILD_RULE",
"isIncludedForContextSearch": true
}
],
"type": [
"HISTORICAL"
]
}
],
"id": "106157",
"type": "ANALYTICAL"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |