接口约定

规则 描述
服务器域名(IP) 以部署为准，如: https://xxx.mixiot.top
接口鉴权 令牌机制，详情请阅接口鉴权
字符编码 统一采用UTF-8编码
响应格式 统一采用JSON格式

响应说明

返回码

code 含义 备注
200 请求成功 Code不为200，则说明请求失败
500 请求错误 -

格式

单条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{}
}

多条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{
        "page_index":1,
        "page_size":20,
        "total_pages":0,
        "total_records":0,
        "data":[]
    }
}

接口详细

手动执行生成报表

请求地址：

属性 值
URL api/
Method post
Content-Type application/json

请求参数：

参数名称 是否必选 数据类型 数据约束 示例数据 描述
project_id 是 int 非空整形 1 block_project_report的主键id
action 是 string 非空字符串 manual_report 手动生成报表的action
actionid 否 string 字符串 report

响应参数：

参数名称 数据类型 描述
code int 返回码
msg string 提示消息
mix_code string mixiot返回码
mix_ext string mixiot返回扩展
mix_msg string mixiot返回信息
result string 返回结果

请求示例

curl -H "Content-Type: application/json" -X POST -F '{"project_id": 1,"action":"manual_report","actionid":"report"}' "https://xxx.mixiot.top/report/api/"

返回示例：

{
    "code": 200,
    "msg": "总计生成1个任务，请及时关注报表生成结果",
    "mix_code": 130001,
    "mix_ext": "",
    "mix_msg": "",
    "result": ""
}
文档更新时间: 2024-08-09 16:17   作者：技术支持