ListPortalMenus - 获取数据门户菜单列表

获取具体数据门户下的分层菜单列表。

调试

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

授权信息

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

请求参数

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

数据门户的 ID。

0d173abb53e84c8ca7495429163b****
UserIdstring

Quick BI 中的用户 ID。传入时列表仅展示用户有权限的菜单。

1234567***

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

75912036-5527-4B7E-9265-B481D6651AC2
Resultstring

分级门户菜单列表详情的 JSON 字符串。取值范围:

  • menuType:菜单类型。
    • 0:仪表板
    • 1:外链
    • 2:电子表格
    • 4:目录文件夹
    • 5:表单填报
    • 6:自助取数
  • menuId:菜单 ID
  • uri: 菜单关联资源的 ID 或者 URL
  • showOnlyWithAccess:是否仅授权可见
  • menuName:菜单显示名称
  • dependentPermisson:菜单关联的报表资源是否有权限
  • children:子菜单
[{"children":[{"children":[{"children":[{"menuId":"54kqgoa****","menuName":"报表菜单","menuType":0,"showOnlyWithAccess":true,"dependentPermisson":false,"uri":"e5da4a3f-d7f9-4262-a39e-a840043c****"},{"menuId":"pg1n135****","menuName":"目录菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"23a7d5d8-e55a-4737-b6a1-3c585505****","menuName":"pop三级菜单","menuType":4,"showOnlyWithAccess":true,"dependentPermisson":true}],"menuId":"80764f3c-affd-45a1-aaa1-bb039d8a****","menuName":"pop二级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}],"menuId":"277f968a-22ff-4ce6-83f0-a82950f4****","menuName":"pop一级菜单","menuType":4,"showOnlyWithAccess":false,"dependentPermisson":true}]
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "75912036-5527-4B7E-9265-B481D6651AC2",
  "Result": "[{\"children\":[{\"children\":[{\"children\":[{\"menuId\":\"54kqgoa****\",\"menuName\":\"报表菜单\",\"menuType\":0,\"showOnlyWithAccess\":true,\"dependentPermisson\":false,\"uri\":\"e5da4a3f-d7f9-4262-a39e-a840043c****\"},{\"menuId\":\"pg1n135****\",\"menuName\":\"目录菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"23a7d5d8-e55a-4737-b6a1-3c585505****\",\"menuName\":\"pop三级菜单\",\"menuType\":4,\"showOnlyWithAccess\":true,\"dependentPermisson\":true}],\"menuId\":\"80764f3c-affd-45a1-aaa1-bb039d8a****\",\"menuName\":\"pop二级菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}],\"menuId\":\"277f968a-22ff-4ce6-83f0-a82950f4****\",\"menuName\":\"pop一级菜单\",\"menuType\":4,\"showOnlyWithAccess\":false,\"dependentPermisson\":true}]",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400System.Param.emptyThis error code has been discarded.-
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。

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