Retrieves the whitelist for a BI portal menu.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DataportalId |
string |
Yes |
The ID of the BI portal. |
asdagad***213425 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
DC4E1**********0DF67E2C3 |
| Result |
array<object> |
The whitelist. |
|
|
object |
Whitelist information. |
||
| ReceiverId |
string |
The ID of the authorization object. If the authorization is at the workspace or organization level, this parameter returns the workspace ID or organization ID. |
8a4***********1e769 |
| ReceiverType |
integer |
The type of the authorization object. Valid values:
|
0 |
| AuthPointsValue |
integer |
The authorization type for the menu. Valid values:
|
1 |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "DC4E1**********0DF67E2C3",
"Result": [
{
"ReceiverId": "8a4***********1e769",
"ReceiverType": 0,
"AuthPointsValue": 1
}
],
"Success": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | An internal system error occurred. |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | |
| 400 | Workspace.Not.Exist | The group workspace does not exist. | The group workspace does not exist. |
| 400 | NoPermissionTo.Operate.Object | You are not authorized to operate the objects. | You are not authorized to do this. |
| 400 | Invalid.Workspace | The workspace is not owned by the organization. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.