智驱力社区

1. 添加开放库

接口功能描述：添加开放信息至底库，添加前判断限制最多1000个开放底库；
接口路径：[POST] http://设备IP:9091/ks/open\_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "123", "name": "消防通道堵塞" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "65ad08db522e4b09379b5ad5", "error_code": 0, "message": { "zh": "新增开放底库成功！", "en": "Add open lib successful!" } }

2. 修改开放底库

接口功能描述：修改开放底库信息；
接口路径：[PUT] http://设备IP:9091/ks/open\_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	开放底库id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	名称
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
请求内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "id": "6593e3aa522e4b9ab8456f5e", "name": "逃生通道" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新开放底库成功！", "en": "Update open lib successful!" } }

3. 查询开放底库

接口功能描述：查询开放底库（按设备、分组、名称、外部id、更新时间查询）；
接口路径：[GET] http://设备IP:9091/ks/open\_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	名称
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	逃生通道
start_time	1704211200
end_time	1704384000

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询开放底库成功！",
        "en": "Query open library successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f14e275dc58a689059a3d9",
                "external_id": null,
                "group_id": "66f14e225dc58a689059a3d7",
                "name": "1",
                "desc": null,
                "feature": null,
                "image": null,
                "update_time": 1727090215
            }
        ],
        "total": 1
    }
}

4. 删除开放底库

接口功能描述：删除工服；
接口路径：[DELETE] http://设备IP:9091/ks/open\_lib；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	开放底库id数组
group_id	String	否	分组ID
external_ids	Array	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "ids": ["6593e3aa522e4b9ab8454f54"] }

响应参数说明

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "删除开放底库成功！", "en": "Delete open lib successful!" } }

5. 载入底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://设备IP:9091/ks/open\_lib/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

6. 添加或修改开放底库图像

接口功能描述：添加或者修改开放底库图像；
接口路径：[PUT] http://设备IP:9091/ks/open\_lib/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	工服id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	开放底库图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8454f54
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新开放底库成功！", "en": "Update open lib successful!" } }

7. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://设备IP:9091/ks/open\_lib/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

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

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

8. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://设备IP:9091/ks/open\_lib/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	File	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	66cf14575dc58a095d35835a
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入开放底库成功！", "en": "Import open library successful!" } }

9. 批量导出

接口功能描述：批量导出开放底库；
接口路径：[GET] http://设备IP:9091/ks/open\_lib/xlsx；
请求参数说明；

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

表. 请求参数

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

请求示例；

项目	详情
请求格式	Query String
group_id	66cf14575dc58a095d35835a

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

1. 添加开放库

2. 修改开放底库

3. 查询开放底库

4. 删除开放底库

5. 载入底库

6. 添加或修改开放底库图像

7. 下载模板

8. 批量导入

9. 批量导出

底库管理-开放底库