Retrieves the status of the row-level permission switch for a specified dataset.
Operation description
: This operation supports only the new row- and column-level permission model of Quick BI. If you are still using the legacy row- and column-level permissions, migrate to the new row- and column-level permission model before you call this operation. To migrate to the new model, go to Organization management > Security settings > Upgrade row- and column-level permissions to new version, and click One-click upgrade.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
quickbi-public:QueryDatasetSwitchInfo |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CubeId |
string |
Yes |
The dataset ID. |
7c7223ae-****-3c744528014b |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Success |
boolean |
Indicates whether the request is successful. Valid values:
|
true |
| RequestId |
string |
The request ID. |
FAECEFA8-09BB-58AB-BC58-C8ACEFE4D232 |
| Result |
object |
The details of the row- and column-level permission switches for the dataset. |
|
| CubeId |
string |
The dataset ID. |
7c7223ae-****-3c744528014b |
| IsOpenColumnLevelPermission |
integer |
The status of the column-level field permission switch. Valid values:
|
1 |
| IsOpenRowLevelPermission |
integer |
The status of the row-level permission switch. Valid values:
|
1 |
Examples
Success response
JSON format
{
"Success": true,
"RequestId": "FAECEFA8-09BB-58AB-BC58-C8ACEFE4D232",
"Result": {
"CubeId": "7c7223ae-****-3c744528014b",
"IsOpenColumnLevelPermission": 1,
"IsOpenRowLevelPermission": 1
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Cube.Not.Exist | The Cube does not exist. | The Cube does not exist. |
| 400 | CubePermission.Columnlevel.VersionError | You are not allowed to use the new dataLevelPermission API. | You are not allowed to use new dataLevelPermission api. |
| 400 | Cube.NotBelongTo.CurrentOrganization | The cube does not belong to the current organization %s. | Cube do not belong to current organization:%s. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.