QueryTicketInfo - 查询嵌入报表ticket详情

获取免登嵌入报表的指定ticket的详情信息。

调试

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

授权信息

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

请求参数

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

票据值。

a27a9aec-****-****-bd40-1a21ea41d7c5

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

生成的票据详情。

AccessTicketstring

票据。

a27a9aec-****-****-bd40-1a21ea41d7c5
OrganizationIdstring

组织 ID。

2fe4fbd8-****-****-b3e1-e92c7af083ea
UserIdstring

Quick BI 的用户 ID。

974e50**********9033f46
UsedTicketNuminteger

已消费的票据数。

47
MaxTicketNuminteger

最大支持的票据数。

9999
RegisterTimestring

票据的注册时间。

2022-01-09 22:23:49
InvalidTimestring

票据的失效时间。

2022-01-30 03:03:49
WorksIdstring

报表 ID。

ccd3428c-****-****-a608-26bae29dffee
CmptIdstring

报表内的组件 ID。

sfdgsds-****-****-a608-mghdgd
GlobalParamstring

全局参数。

[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["办公用品","家具产品"]}]}]\n
WatermarkParamstring

水印参数。

Ticket三方嵌入
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccessTicket": "a27a9aec-****-****-bd40-1a21ea41d7c5",
    "OrganizationId": "2fe4fbd8-****-****-b3e1-e92c7af083ea",
    "UserId": "974e50**********9033f46",
    "UsedTicketNum": 47,
    "MaxTicketNum": 9999,
    "RegisterTime": "2022-01-09 22:23:49",
    "InvalidTime": "2022-01-30 03:03:49",
    "WorksId": "ccd3428c-****-****-a608-26bae29dffee",
    "CmptId": "sfdgsds-****-****-a608-mghdgd",
    "GlobalParam": "[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["办公用品","家具产品"]}]}]\\n",
    "WatermarkParam": "Ticket三方嵌入"
  },
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Authorize3rdTicket.BindedWorks.MismatchThe report bound by the ticket mismatches the actual report.Ticket绑定的报表与访问页面报表不一致。
400Authorize3rdTicket.ExpiredTicket [%s] has expired.当前票据[%s]已过期。
400Authorize3rdTicket.HasNo.LoginTokenThe request [%s] has no token.当前请求 [%s] 未找到token信息。
400Authorize3rdTicket.NotExistTicket %s does not exist.当前票据%s不存在。
400Authorize3rdTicket.Num.ExceedThe number of tickets %s is invalid.票据数量不合法。
400Authorize3rdTicket.Num.HasNoLeftThere is no ticket number left, please generate new ticket.当前票据已消费完毕,请重新生成。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。

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

变更历史

变更时间变更内容概要操作
暂无变更历史