SetDataLevelPermissionRuleConfig - 设置单条数据集行列权限配置信息

设置单条数据集行列权限配置信息(新增和更新)。

接口说明

说明 :当前接口仅支持 Quick BI 新版行列权限模型。若您仍在使用老的行列权限,请先一键迁移至新的行列权限模型后再调用该接口。一键迁移至新的行列权限模型的操作步骤:在组织管理-->安全配置-->行列权限升级新版中,单击一键升级,升级至新版行级权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RuleModelstring

{ "rule": "a5bb24da--a891683e14da", // 行列权限规则的 ID,当传入时为修改行级权限规则,否则新增 "cubeId": "7c7223ae--3c744528014b", // 数据集 ID "ruleName": "测试行级权限", // 行级权限规则的名称 "ruleLevelType": "ROW_LEVEL", // 行级权限类型:ROW_LEVEL:行级权限,COLUMN_LEVEL:列级权限 "ruleTargetScope": "ALL", // 行级权限规则针对的人群:1:所有人,2:指定人 "hitTakeEffect": 1, //命中后规则生效还是不生效(针对列级权限):1:生效 (默认生效),0:不生效 "ruleUsersModel": { "userGroups": [ "9bd2c6440ac542589f16bf12ca8178dd", // 用户组人群的用户组 ID "0d5fb19b--1248fc27ca51", "3d2c23d4--f6390f325c2d" ], "users": [ "433423784358", // 用户人群的 UserID "Huang2e3fa822" ] }, "ruleContentModel": { "ruleContentType": "ROW_FIELD", // 行列权限的规则类型 "ruleContentJson": "{"conditionNode":{"caption":"周期","isMeasure":false,"pathId":"7d3bbc6","relationOperator":"not-null","name":"7d3bbc6","value":{"value":[""],"valueType":"ENUM"}}}", // 规则的 JSON 字符串 "ruleOriginConfigJson": "{"operator":"and","operands":[{"labelName":"周期","isValid":true,"uniqueId":"5","fieldId":"7d3b***bc6","error":false,"fieldType":"string","defaultValue":{"selectType":"condition","value":{"conditionOp":"not-null","conditionValue":""},"valueType":"ENUM"}}],"isRelation":true}" // 前端模板要是用的 JSON 结果(行级权限专用) } }

{ "cubeId": "aa574353-41cf-****-8d0d-455176c101fa", "hitTakeEffect": 1, "isOpen": 1, "permissionMode": "COMPLEX", "ruleContentModel": { "ruleContent": { "pathId": [ "264b7a970b" ] }, "ruleContentJson": "{\"pathId\":[\"264b7a970b\"]}", "ruleContentType": "COLUMN_FORBID" }, "ruleId": "3971fa8e-f7e0-****-b6e3-5b3167dd7247", "ruleLevelType": "COLUMN_LEVEL", "ruleName": "规则名称", "ruleTargetScope": "ALL" }

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultstring

保存成功的行列权限信息。

{ "cubeId": "aa574353-41cf-****-8d0d-455176c101fa", "hitTakeEffect": 1, "isOpen": 1, "permissionMode": "COMPLEX", "ruleContentModel": { "ruleContent": { "pathId": [ "264b7a970b" ] }, "ruleContentJson": "{\"pathId\":[\"264b7a970b\"]}", "ruleContentType": "COLUMN_FORBID" }, "ruleId": "3971fa8e-f7e0-****-b6e3-5b3167dd7247", "ruleLevelType": "COLUMN_LEVEL", "ruleName": "规则名称", "ruleTargetScope": "ALL" }
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": "{\n    \"cubeId\": \"aa574353-41cf-****-8d0d-455176c101fa\",\n    \"hitTakeEffect\": 1,\n    \"isOpen\": 1,\n    \"permissionMode\": \"COMPLEX\",\n    \"ruleContentModel\": {\n        \"ruleContent\": {\n            \"pathId\": [\n                \"264b7a970b\"\n            ]\n        },\n        \"ruleContentJson\": \"{\\\"pathId\\\":[\\\"264b7a970b\\\"]}\",\n        \"ruleContentType\": \"COLUMN_FORBID\"\n    },\n    \"ruleId\": \"3971fa8e-f7e0-****-b6e3-5b3167dd7247\",\n    \"ruleLevelType\": \"COLUMN_LEVEL\",\n    \"ruleName\": \"规则名称\",\n    \"ruleTargetScope\": \"ALL\"\n}",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Cube.Not.ExistThe Cube does not exist.数据集不存在。
400CubePermission.Columnlevel.VersionErrorYou are not allowed to use the new dataLevelPermission API.没有权限使用新版行列权限。
400CubePermission.ColumnlevelField.RepeatThere are duplicate field configurations.有重复的字段配置。
400RowLevelPermission.SwitchClose.ErrorThe row level permission switch must be on.对应的行级权限开关必须打开。
400RowLevelPermission.Rule.NotExsistThe row level permission rule does not exist: %s.行级权限规则不存在:%s。
400RowLevelPermission.Rule.NotBelongToCubeThe row level permission rule does not belong to the current cube.行级权限规则不属于当前数据集。
400Cube.NotBelongTo.CurrentOrganizationThe cube does not belong to the current organization %s.数据集模型不属于当前组织。

访问错误中心查看更多错误码。