Get All Data Security Rules
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API fetches all Data Security Rules applied on a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/data-security-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 | Represents the name or ID of the Semantic Model for which Data Security Rules are to be fetched. 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, the Semantic Model will be treated as a root-level entity by default. | – |
Responses
200 Success
{
"rules": [
{
"columnLevel": {
"fields": {
"field": [
{
"name": "accountid",
"id": "DIM_514101!!!DIMENSION_ATTRIBUTE_882036",
"type": "ATTRIBUTE"
},
{
"name": "account",
"id": "DIM_514101",
"type": "DIMENSION",
"restrict": "DATA_AND_METADATA"
},
{
"maskingInfo": {
"maskValue": {
"type": "FIX",
"value": "-1"
}
},
"name": "weight",
"id": "MEASURE_907901",
"type": "MEASURE",
"restrict": "MASK_DATA"
}
]
}
},
"rowLevel": {
"filters": [
{
"filter": [
{
"isMemberValue": true,
"fieldName": "DIM_514101!!!DIMENSION_ATTRIBUTE_882036",
"firstValue": {
"content": "'A41'"
},
"searchContext": "ALL",
"includeCurrent": false,
"useField": false,
"fieldDisplayName": "accountid",
"relation": "AND",
"useFieldType": "VALUE",
"isAppliedOnDisplayField": true,
"delimiter": "^`~",
"secondValue": {
"content": ""
},
"valueType": "predefined",
"id": "f1",
"nonVisual": false,
"firstDisplayValue": "A41",
"suspend": false,
"isParameter": false,
"topNField": "",
"valueBy": "VALUE",
"dataType": "CHAR",
"topNDisplayValue": "",
"endEnclosure": "",
"isSearchFilter": false,
"sortOrder": "ASC",
"startEnclosure": "",
"filterType": "ADVANCE",
"showInDataCard": false,
"secondDisplayValue": "",
"operation": "INLIST",
"fieldType": "DIMENSION",
"isIncludedForContextSearch": true
}
]
}
]
},
"name": "second-new-rule",
"repositDate": 0,
"id": "RULE_17778799388428127041054164258650",
"globalType": 0,
"desc": "this is the second new rule"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |