ListSharedReports - 获取首页看板被授权的作品列表

获取指定用户在首页看板中展示的被授权的作品列表。

调试

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

授权信息

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

请求参数

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

要查询用户在 Quick BI 中的 UserID。

b5d8fd9348cc4327****afb604
Keywordstring

作品名称的关键字。

测试报表
TreeTypestring

查询作品的类型(填空查询所有类型)。取值范围 :

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • REPORT:电子表格
PAGE
PageSizeinteger

查询作品列表的行数:

  • 默认值:10
  • 最大值:9999
10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回查询结果。

Dataarray<object>

查询到的作品列表。

Dataobject
Favoriteboolean

查询用户是否收藏了该作品。

true
GmtCreatestring

作品创建时间戳。

1640088615000
GmtModifiedstring

作品修改的时间戳。

1644373980000
HasEditAuthboolean

查询用户是拥有作品的编辑权限。

true
HasViewAuthboolean

查询用户是拥有作品的查看权限。

true
Namestring

作品名称。

测试报表
OwnerNamestring

作品所有者的阿里云账号名。

test账号
OwnerNumstring

作品所有者的 UserID。

1365*****238860
PublishStatusinteger

作品的发布状态。取值范围:

  • 0:未发布
  • 1:已发布
  • 2:已修改保存未发布
  • 3:已下线
1
TreeIdstring

作品 ID。

977c7698-****-****-****-44b7304d20fc
Typestring

作品类型。取值范围 :

  • DATAPRODUCT:数据门户
  • PAGE:仪表板
  • REPORT:电子表格
PAGE
WorkspaceIdstring

作品所属的工作空间 ID。

gfidm145-****-****-9426-8f93be23****
WorkspaceNamestring

作品所属的工作空间名称。

测试工作空间
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
TotalPagesinteger

总页数。

1
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "GmtCreate": "1640088615000",
        "GmtModified": "1644373980000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "test账号",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "gfidm145-****-****-9426-8f93be23****",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

错误码

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