擷取免登嵌入報表的指定ticket的詳情資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
quickbi-public:QueryTicketInfo |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Ticket |
string |
是 |
票據值。 |
a27a9aec-****-****-bd40-1a21ea41d7c5 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
D787E1A3-A93C-424A-B626-C2B05DF8D885 |
| Result |
object |
產生的票據詳情。 |
|
| AccessTicket |
string |
票據。 |
a27a9aec-****-****-bd40-1a21ea41d7c5 |
| CmptId |
string |
報表內的組件 ID。 |
sfdgsds-****-****-a608-mghdgd |
| GlobalParam |
string |
全域參數。 |
[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["辦公用品","傢具產品"]}]}]\n |
| InvalidTime |
string |
票據的失效時間。 |
2022-01-30 03:03:49 |
| MaxTicketNum |
integer |
最大支援的票據數。 |
9999 |
| OrganizationId |
string |
組織 ID。 |
2fe4fbd8-****-****-b3e1-e92c7af083ea |
| RegisterTime |
string |
票據的註冊時間。 |
2022-01-09 22:23:49 |
| UsedTicketNum |
integer |
已消費的票據數。 |
47 |
| UserId |
string |
Quick BI 的使用者識別碼。 |
974e50**********9033f46 |
| WatermarkParam |
string |
浮水印參數。 |
Ticket三方嵌入 |
| WorksId |
string |
報表 ID。 |
ccd3428c-****-****-a608-26bae29dffee |
| Success |
boolean |
是否請求成功。取值範圍:
|
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"AccessTicket": "a27a9aec-****-****-bd40-1a21ea41d7c5",
"CmptId": "sfdgsds-****-****-a608-mghdgd",
"GlobalParam": "[{"paramKey":"price","joinType":"and","conditionList":[{"operate":">","value":"0"}]},{"paramKey":"product_type","joinType":"and","conditionList":[{"operate":"in","value":["辦公用品","傢具產品"]}]}]\\n",
"InvalidTime": "2022-01-30 03:03:49",
"MaxTicketNum": 9999,
"OrganizationId": "2fe4fbd8-****-****-b3e1-e92c7af083ea",
"RegisterTime": "2022-01-09 22:23:49",
"UsedTicketNum": 47,
"UserId": "974e50**********9033f46",
"WatermarkParam": "Ticket三方嵌入",
"WorksId": "ccd3428c-****-****-a608-26bae29dffee"
},
"Success": true
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Authorize3rdTicket.BindedWorks.Mismatch | The report bound by the ticket mismatches the actual report. | |
| 400 | Authorize3rdTicket.Expired | Ticket [%s] has expired. | |
| 400 | Authorize3rdTicket.HasNo.LoginToken | The request [%s] has no token. | |
| 400 | Authorize3rdTicket.NotExist | Ticket %s does not exist. | |
| 400 | Authorize3rdTicket.Num.Exceed | The number of tickets %s is invalid. | |
| 400 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | |
| 400 | NoPermissionTo.Operate.Object | You are not authorized to operate the objects. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。