说明

获取指定应用下的项目列表

请求地址

https://openapi.haiwell.com/api/v1/projects

请求方法

GET

公共请求参数

参数名称	参数类型	数据类型	是否必填	参数描述
Client-ID	Header	String	是	开发者中心应用密钥 clientID
Authorization	Header	String	是	通过 Credentials 获取的 token

请求参数

参数	参数类型	数据类型	是否必需	描述
limit	Query	Long	是	获取的最大记录数，默认为 10，最大 100
offset	Query	Long	是	返回页码，默认 1，页码从 1 开始(当前采用分页返回，记录数和页数必需一起传)
blur	Query	String	否	模糊查询关键字，长度小于 128，支持按名称搜索

HTTP 状态码

返回值	描述
200	操作成功，详见响应参数
429	并发限流
500	服务端异常

业务错误码

返回值	描述
10000	客户端传参异常，详见异常响应参数
10001	公共参数错误
10016	client 下线或者 clientId 不正确（身份不正确）
10019	token 已过期
50000	服务端异常

响应参数

参数	参数类型	描述
code	Long	成功返回码默认 0
reason	String	服务端定义的标签，用于业务快速定位问题
data	Object	返回数据结构体
- data.total	Long	数据总数
- data.list	Object[]	项目列表
-- data.list[0].scada_id	Long	项目 ID
-- data.list[0].scada_name	String	项目名称
-- data.list[0].project_remark	String	项目备注

异常响应参数

参数	数据类型	描述
error_msg	String	表示一个错误代码字符串，可以用于对错误进行分类，并对错误进行处理
code	String	服务端定义的错误码，用于快速定位问题
reason	String	服务端定义的标签，用于业务快速定位问题

请求消息示例

GET /projects?limit=10&offset=1&blur=项目名字 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": {
    "total": 1,
    "list": [
      {
        "project_id": 1024,
        "project_name": "演示项目",
        "project_remark": ""
      },
			 {
        "project_id": 2048,
        "project_name": "测试项目",
        "project_remark": "描述文本"
      }
    ]
  }
}