基于上位机软件webserver的二次开发
关注公众号
原创
底库管理-工服底库

1. 添加工服库

参数名称数据类型是否必须说明
device_idsArray是设备ID数组
group_idString是分组ID
external_idString否外部id
nameString是名称
descString否简介

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式JSON
报文内容{
    "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"],
    "group_id": "6593e3aa522e4b9ab8454f54",
    "external_id": "123",
    "name": "红色工服"
}
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject以对象形式返回每个设备是否成功
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "data": {
        "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": {
            "id": "65ad08db522e4b09379b5ad5"
            "result": true,
            "reason": null
        }
    },
    "error_code": 0,
    "message": {
        "zh": "新增工服成功！",
        "en": "Add workclothes successful!"
    }
}

2. 修改工服库

参数名称数据类型是否必须说明
device_idsArray是设备ID数组
idString否工服id
group_idString否若同时存在group_id和external_id则忽略id
external_idString否
nameString否名称
descString否简介

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式JSON
报文内容{
    "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"],
    "group_id": "6593e3aa522e4b9ab8454f54",
    "id": "6593e3aa522e4b9ab8454f54",
    "name": "蓝色工服"
}
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject以对象形式返回每个设备是否成功
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "data": {
        "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": {
            "result": true,
            "reason": null
        }
    },
    "error_code": 0,
    "message": {
        "zh": "更新工服成功！",
        "en": "Update workclothes successful!"
    }
}

3. 查询工服库

参数名称数据类型是否必须说明
pageInt是页码
sizeInt是每页数量
device_idString是设备ID
group_idString否分组ID
external_idString否外部id
nameString否名称
start_timeInt否开始时间秒数
end_timeInt否结束时间秒数

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式Query String
page1
size10
device_idc92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id6593e3aa522e4b9ab8454f54
name红色工服
start_time1704211200
end_time1704384000
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObjectnull
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "error_code": 0,
    "message": {
        "zh": "查询工服成功！",
        "en": "Query workclothes successful!"
    },
    "data": {
        "external_id ": "xxx ",
        "desc": "1234",
        "device_id": "df0fef91-a835-4197-bf59-c6ea18a492af",
        "id": "6593e3aa522e4b9ab8454f54",
        "image": "/9j/4AAQSkZJRg…",
        "name": "红色工服",
        "update_time": 1704351807
    }
}

4. 删除工服库

参数名称数据类型是否必须说明
device_idsArray是设备ID数组
idsArray否工服id数组
group_idString否分组ID
external_idsArray否若存在group_id，或者同时存在group_id和external_ids，则忽略ids

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式JSON
报文内容{
    "device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"],
    "ids": ["6593e3aa522e4b9ab8454f54"]
}
  • 响应参数说明
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
message
   		String
   		返回响应信息
dataObject以对象形式返回每个设备是否成功
  • 响应示例
项目详情
报文格式JSON
报文内容{
    "data": {
        "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": {
            "result": true,
            "reason": null
        }
    },
    "error_code": 0,
    "message": {
        "zh": "删除工服成功！",
        "en": "Delete workclothes successful!"
    }
}

5. 载入底库

  • 接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
  • 接口路径：[POST] http://云服务IP:9191/ks/proxy/work\_clothes/load；
  • 请求参数说明；
参数名称数据类型是否必须说明
device_idsArray是设备ID数组

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式JSON
报文内容{
"device_ids": ["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
}
  • 响应参数说明；
参数名称数据类型说明
error_code
   		Int
   		返回响应码
   
-2: 服务端错误
   
messageString返回响应信息
dataObject以对象形式返回每个设备是否成功
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "data": {
        "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": {
            "result": true,
            "reason": null
        }
    },
    "error_code": 0,
    "message": {
        "zh": "载入成功！",
        "en": "Successful loaded!"
    }
}

6. 添加或修改工服图像

参数名称数据类型是否必须说明
device_idsString是设备ID数组
idString否工服id
group_idString否若同时存在group_id和external_id则忽略id
external_idString否
imageFile是工服图片

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式Form Data
device_ids["c92254f2-6124-4f9d-b3e2-feb0f33c1df8"]
id6593e3aa522e4b9ab8454f54
image(binary)
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject以对象形式返回每个设备是否成功
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "data": {
        "20e0c32b-f937-4cf2-9e8c-96d1e60e6519": {
            "result": true,
            "reason": null
        }
    },
    "error_code": 0,
    "message": {
        "zh": "更新工服成功！",
        "en": "Update workclothes successful!"
    }
}

7. 下载模板

参数名称数据类型是否必须说明
group_idString是分组ID
templateBool是true

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

注意：前端调用时，还需指定responseType:'blob'。

  • 请求示例；
项目详情
请求格式Query String
group_id66cf14575dc58a095d35835a
templatetrue
  • 响应参数说明；
参数名称数据类型说明
dataString文件流
  • 响应示例。
项目详情
报文格式文件流
报文内容略

8. 批量导入

参数名称数据类型是否必须说明
device_idString是设备ID数组
group_idString是分组ID
packagefile是文件

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

  • 请求示例；
项目详情
请求格式Form Data
device_idc92254f2-6124-4f9d-b3e2-feb0f33c1df8
group_id66cf14575dc58a095d35835a
package(binary)
  • 响应参数说明；
参数名称数据类型说明
error_codeInt返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
messageString返回响应信息
dataObject   
 
   
  • 响应示例。
项目详情
报文格式JSON
报文内容{
    "data": null,
    "error_code": 0,
    "message": {
        "zh": "导入工服底库成功！",
        "en": "Import work_clothes library successful!"
    }
}

9. 批量导出

参数名称数据类型是否必须说明
group_idString是分组ID

表. 请求参数

参数名称数据类型是否必须说明
AuthorizationString是‘Bearer ’+ token; token通过获取token接口获取

表. 请求头

注意：前端调用时，还需指定responseType:'blob'。

  • 请求示例；
项目详情
请求格式Query String
group_id66cf14575dc58a095d35835a
  • 响应参数说明；
参数名称数据类型说明
dataString文件流
  • 响应示例。
项目详情
报文格式文件流
报文内容略

真诚点赞 诚不我欺

底库管理-工服底库