d

2026-09-24 14:51:47 +08:00
1 parent 693a013279
commit 8ad04e20ca
@@ -1,2 +1,130 @@
 # 查测试机的文档

+调用`queryTestUnitListByProjectName`工具，按照[请求参数说明](#请求参数说明)，并结合[工具调用的4种情况](#工具调用的4种情况)处理查询。
+
+## 请求参数说明
+
+|参数名称|是否必传|取值规则|
+|---|---|---|
+|`ownerCode`|是|取上下文中的`creatorCode`|
+|`size`|是|固定数值，传20|
+|`workingStatusKey`|是|固定传1，只查空闲的|
+|`onlineStatusKey`|是|固定传2，只查在线的|
+|`lockStatus`|是|固定传0，只查未锁定的|
+
+重要：其他参数，调用侧没有要求，一律不传。
+
+## 工具调用的4种情况
+
+- 返回了1条，根据[展示给用户的格式](#展示给用户的格式)，让用户确认是否要用这台测试机，得到用户的肯定答复后，调用测再继续执行，若用户拒绝，调用测的流程到此结束。
+- 返回了多条，根据[展示给用户的格式](#展示给用户的格式)，让用户选1台测试机，调用侧继续执行。
+- 返回了0条，告知用户您当前没有可以测试机使用，请先申请测试机，调用测的流程到此结束。
+- 查询异常，把错误信息展示给用户，友好的告诉用户，查询测试机失败了，调用侧的流程到此结束。
+
+## 展示给用户的格式
+
+|机器ID|机器名称|在线状态|闲忙状态|锁定状态|
+|---|---|---|---|---|
+|123|测试机123|在线|使用中|已锁定|
+|456|测试机456|离线|闲置中|未锁定|
+
+## 响应参数说明
+
+|参数名称|参数描述|
+|---|---|
+|testUnitGroupUuid|机器分组ID|
+|testUnitUuid|机器ID|
+|testUnitName|机器名称|
+|onlineStatus|在线状态（枚举值：1=离线，2=在线）|
+|workingStatusKey|闲忙状态（枚举值：1=闲置中，2=使用中）|
+|lockStatus|锁定状态（枚举值：0=未锁定，1=已锁定）|
+|ipAddress|IP地址|
+|projectCode|项目编号|
+|projectName|项目名称|
+|projectPhase|项目阶段|
+|programName|项目集名称|
+|modelName|五码|
+|groupName|分组名称|
+|mo|工单|
+|fgPn|SKU|
+|skuShortName|SKU别名|
+|skuExtensionNo|SKU编号|
+|testUnitTypeKey|测试机类型键或物料组|
+|matterDescription|物料描述|
+|userCode|当前使用人用户ID|
+|userName|当前使用人用户名称|
+|ownerCode|机器管理员用户ID|
+|ownerName|机器管理员用户名称|
+|shippingSn|出货流水号或机器SSN|
+|mbPn|主板料号|
+|mbSn|主板流水号|
+|fgSn|整机流水号|
+|gerberVersion|主板Gerber版本|
+
+## 响应参数示例
+
+### 查询成功
+
+```json
+{
+  "records": [
+    {
+      "projectCode": "PRJ2024001",
+      "projectName": "Project Alpha",
+      "projectPhase": "EVT",
+      "programName": "Alpha Program",
+      "modelName": "LM12345",
+      "groupName": "Group-A",
+      "mo": "MO2024010001",
+      "fgPn": "FG-SKU-001",
+      "skuShortName": "SKU-A",
+      "skuExtensionNo": "EXT001",
+      "testUnitTypeKey": 1,
+      "matterDescription": "主板物料",
+      "workingStatusKey": 2,
+      "tokenStatus": 1,
+      "lockStatus": 0,
+      "isStore": 0,
+      "gmtCreate": "2024-09-20 10:30:00",
+      "userCode": 10086,
+      "userName": "张三",
+      "borrowStatus": 1,
+      "ownerCode": "ADMIN001",
+      "ownerName": "李四",
+      "shippingSn": "SN20240920001",
+      "mbPn": "MB-PN-001",
+      "gerberVersion": "V1.2",
+      "testUnitUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+      "testUnitSource": "1",
+      "onlineStatus": 2,
+      "mbSn": "MBSN20240001",
+      "fgSn": "FGSN20240001",
+      "comments": "测试机备注",
+      "testUnitGroupUuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+      "testUnitName": "测试机-01",
+      "groupLeaderName": "王五",
+      "groupLeaderCode": "GL001",
+      "ipAddress": "192.168.1.100",
+      "ipAddressBridge": "10.0.0.100",
+      "vncParam": "vnc://192.168.1.100:5900",
+      "lcfcUuid": "lcfc-uuid-001",
+      "mbUuid": "mb-uuid-001"
+    }
+  ],
+  "total": 50,
+  "size": 10,
+  "current": 1,
+  "optimizeCountSql": true,
+  "searchCount": true,
+  "pages": 5
+}
+```
+
+### 查询异常
+
+```json
+{
+  "code": 500,
+  "msg": "系统异常"
+}
+```