说明
获取指定项目工程的详细信息
请求地址
https://openapi.haiwell.com/api/v1/webscadas/\{scada_id\}
请求方法
GET
公共请求参数
| 参数名称 | 参数类型 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| Client-ID | Header | String | 是 | 开发者中心应用密钥 clientID |
| Authorization | Header | String | 是 | 通过 Credentials 获取的 token |
请求参数
| 参数 | 参数类型 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|---|
| scada_id | path | Long | 是 | 工程 ID |
HTTP 状态码
| 返回值 | 描述 |
|---|---|
| 200 | 操作成功，详见响应参数 |
| 429 | 并发限流 |
| 500 | 服务端异常 |
业务错误码
| 返回值 | 描述 |
|---|---|
| 10000 | 客户端传参异常，详见异常响应参数 |
| 10001 | 公共参数错误 |
| 10016 | client 下线或者 clientId 不正确（身份不正确） |
| 10019 | token 已过期 |
| 50000 | 服务端异常 |
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Long | 成功返回码默认 0 |
| reason | String | 服务端定义的标签，用于业务快速定位问题 |
| data | Object | 返回数据结构体 |
| - data.scada_id | Long | 工程 ID |
| - data.scada_name | String | 工程名称 |
| - data.scada_detail | String | 工程详情 |
| -- data.author | String | 工程创建者 |
| -- data.page_type | String | 工程展示页面类型 pc ｜ mobile |
异常响应参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
| error_msg | String | 表示一个错误代码字符串，可以用于对错误进行分类，并对错误进行处理 |
| code | String | 服务端定义的错误码，用 于快速定位问题 |
| reason | String | 服务端定义的标签，用于业务快速定位问题 |
请求消息示例
GET /webscadas/10487 HTTP/1.1
Host: openapi.haweill.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"code": 0,
"reason": "OK",
"data": {
"author": "Airy",
"page_type": "pc,mobile",
"scada_detail": "全国污水处理",
"scada_id": 3006,
"scada_name": "污水处理",
"scada_type": 1
}
}