动态获取QuickBI仪表板展示URL
路径 | /industry/quickbi/url/query |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
biType | String | 是 | QuickBI报表业务类型,dashborad-production-da:人均产量(值)分析,dashborad-material-da:物料利用率,dashborad-energy-da:能耗分析,dashborad-employees-da:人效分析,dashborad-quality-da:质量缺陷分析,dashborad-device-efficiency-da:设备效率分析,dashborad-pass-rate-da:成品率分析 | |
corpId | String | 否 | 企业标识,每个企业拥有唯一的CorpID,比如钉钉corpID、LH里面的appId | |
userId | String | 否 | 员工在当前企业内的唯一标识,钉钉userId或者IoT的employeeId | |
source | String | 否 | 源,枚举值,钉钉填写DINGDING,多住户saas填SAAS | |
agentId | String | 否 | 代表企业应用ID | |
platForm | String | 否 | 平台参数,字符串,至少包括手机型号信息,屏幕信息 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | String |
QuickBI URL |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"biType": "value0",
"corpId": "value1",
"userId": "value2",
"source": "value3",
"agentId": "value4",
"platForm": "value5"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": "https://das.base.shuju.aliyun.com/token3rd/dashboard/view/pc.htm?xxx"
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
在文档使用中是否遇到以下问题
更多建议
匿名提交