查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:QueryShareList |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ReportId |
string |
是 |
作品 ID。这里的作品包括数据门户、仪表板、电子表格、自助取数、即席分析、数据填报、数据大屏。 |
6b407e50-e774-406b-9956-da2425c2**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Success |
boolean |
是否请求成功。取值范围:
|
true |
| RequestId |
string |
请求 ID。 |
DC4E1E63-B337-44F8-8C22-6F00DF67E2C3 |
| Result |
array<object> |
返回作品被分享给的对象列表。 |
|
|
object |
|||
| AuthPoint |
integer |
分享权限。取值范围:
|
3 |
| ExpireDate |
integer |
授权有效时间的毫秒级时间戳。 |
1640102400000 |
| ReportId |
string |
作品 ID。 |
6b407e50-e774-406b-9956-da2425c2**** |
| ShareId |
string |
分享配置 ID。 |
0ab9659e-29cf-47d7-a364-3a91553b**** |
| ShareToId |
string |
分享目标的 ID,可能是在 Quick BI 的用户 ID,可能是用户组 ID。
|
95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| ShareToName |
string |
分享对象的名称。 |
小张 |
| ShareToType |
integer |
分享类型。取值范围:
|
0 |
| ShareType |
string |
被分享作品的类型。取值范围:
|
dashboard |
示例
正常返回示例
JSON格式
{
"Success": true,
"RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
"Result": [
{
"AuthPoint": 3,
"ExpireDate": 1640102400000,
"ReportId": "6b407e50-e774-406b-9956-da2425c2****",
"ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
"ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
"ShareToName": "小张",
"ShareToType": 0,
"ShareType": "dashboard"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Report.NotExist.Error | This work does not exist. It may have been deleted. Work ID is %s. | 作品不存在,可能已经被删除。作品ID:%s。 |
| 400 | Workspace.Not.Exist | The group workspace does not exist. | 群空间不存在。 |
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | 空间不在组织内。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。