获取指定用户在首页看板中展示的收藏作品列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| UserId | string | 是 | 要查询用户在 Quick BI 中的 UserID。 | b5d8fd9348cc4327****afb604 |
| Keyword | string | 否 | 作品名称的关键字。 | 财务报表 |
| TreeType | string | 否 | 查询作品的类型（填空查询所有类型）。取值范围 ：
| PAGE |
| PageSize | integer | 否 | 查询作品列表的行数： 默认值：10 最大值：9999 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"TotalNum": 1,
"TotalPages": 1,
"PageNum": 1,
"PageSize": 10,
"Data": [
{
"TreeId": "977c7698-****-****-****-44b7304d20fc",
"Type": "PAGE",
"Name": "测试报表",
"OwnerNum": "1365*****238860",
"OwnerName": "luyaotest的昵称非管理员",
"GmtCreate": "1640088615000",
"GmtModified": "1640595729000",
"PublishStatus": 1,
"Favorite": true,
"HasViewAuth": true,
"HasEditAuth": true,
"WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
"WorkspaceName": "测试工作空间"
}
]
},
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | Invalid.User.Organization | The user is not in your organization. | 该用户不在您的组织中。 |
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | 没有权限，您不是组织管理员。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。 |
| 400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限，您不是该群空间的管理员。 |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
| 400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
访问错误中心查看更多错误码。