SaveFavorites接口用于添加用户的收藏作品。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SaveFavorites

要执行的操作。取值：SaveFavorites。
UserId String 是 121344444790****

收藏作品的用户ID。此处的用户ID为Quick BI的UserID，而非阿里云的UID。
WorksId String 是 d23e84a1-82a0-4292-bfdb-521306c3****

收藏作品的ID。

返回数据

名称 类型 示例值 描述
RequestId String 68383D95-D623-4059-AF1B-2310957FA332

请求ID。
Result Boolean true

返回接口执行结果。取值范围：

  • true：执行成功
  • false：执行失败
Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=SaveFavorites
&UserId=121344444790****
&WorksId=d23e84a1-82a0-4292-bfdb-521306c3****
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>68383D95-D623-4059-AF1B-2310957FA332</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON格式 

{"RequestId":"68383D95-D623-4059-AF1B-2310957FA332","Success":"true","Result":"true"}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 System.Param.empty This error code has been discarded. 错误码已废弃。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在，可能已经被删除。作品ID:%s。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 Workspace.Status.Error This group workspace has been disabled or deleted. 该群空间已被禁用或删除。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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