Merge branch 'master' of http://121.37.141.193/huli/open-api

1 year ago · e9dd357ca5
8 changed files with 587 additions and 56 deletions
--- a/mes/厂区/列出厂区.md
+++ b/mes/厂区/列出厂区.md
@ -0,0 +1,66 @@
+### 列出所有厂区（ListFactory）
+
+此接口列出 MES 平台中已配置的厂区。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL: http://localhost:8033/open/checked
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+此接口没有专用的参数：
+
+```
+{
+    "data": {}
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| factories | array | 厂区记录的数组。 |
+| - profile | string | 厂区配置名称，唯一。 |
+| - alias | string | 厂区的名称，用于界面显示，多个厂区可使用相同的名称。 |
+
+认证成功时，响应如下：
+
+```
+{
+    "clock": "2008-08-08 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "factories": [
+            {
+                "profile": "test",
+                "alias": "测试环境"
+            },
+            {
+                "profile": "某甲",
+                "alias": "中国某甲能源股份有限公司"
+            },
+            {
+                "profile": "某乙",
+                "alias": "中国某乙能源股份有限公司"
+            },
+            {
+                "profile": "某丙",
+                "alias": "中国某丙能源股份有限公司"
+            }
+        ]
+    }
+}
+```
--- a/mes/原材料分批/原材料批次列表.md
+++ b/mes/原材料分批/原材料批次列表.md
@ -62,7 +62,8 @@ __data:__
 {
  "clock": "2023-06-25 20:00:00.000",
  "status": "ok",
-  "data": [
+  "data": {
+    "batches":[
      {
        "key":"123",
        "workOrder":"123456",
@ -83,6 +84,7 @@ __data:__
      }
    ]
  }    
+}

 ```

--- a/mes/原材料分批/原材料批次详细信息.md
+++ b/mes/原材料分批/原材料批次详细信息.md
@ -85,6 +85,7 @@ __MaterialAttrs:__
  "clock": "2023-06-25 20:00:00.000",
  "status": "ok",
  "data": {
+    "batch":{
      "key":"",
      "workOrder":"123456",
      "batchNumber":"CELL1000",
@ -123,6 +124,7 @@ __MaterialAttrs:__
      ]
    }
  }
+}

 ```

--- a/mes/订单/修改订单.md
+++ b/mes/订单/修改订单.md
@ -0,0 +1,108 @@
+### 修改订单（EditOrder）
+
+此接口用于修改 MES 现有的订单记录，部分字段无法修改。
+
+创建订单时的 code、productCode、createTime、creator 和 type 字段无法修改，如果需要调整这些字段的内容，可以尝试删除订单后再次添加。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/addOrder
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区配置名称。 |
+| code | string | 是 | 订单号。 |
+| beginTime | string | 是 | 开始时间。 |
+| endTime | string | 是 | 结束时间。 |
+| customer | string | 否 | 客户名称。<br>不填时此字段的值将被改为空字符串。 |
+| saleNum | int | 是 | 投产组件数。<br>默此数量包含 B 级，用于追溯订单的材料消耗。 |
+| totalNum | int | 是 | 订单组件数。<br>默此数量一般只是 A 级。 |
+| inboundNum | int | 是 | 入库组件数限定值。<br>默不使用 WMS 卡关时指定为 0 即可。 |
+| powerGear | string | 否 | 功率等级。<br>若指定值，则内容必须是数字。<br>不填时此字段的值将被改为空字符串。 |
+| powerGearRange1 | string | 否 | 功率等级范围。<br>若指定值，则内容必须是数字。<br>不填时此字段的值将被改为空字符串。 |
+| powerGearRange2 | string | 否 | 功率等级范围。<br>若指定值，则内容必须是数字。<br>不填时此字段的值将被改为空字符串。 |
+
+请求示例：
+
+```
+{
+    "data": {
+        "profile": "test",
+        "code": "NewOrder001",
+        "beginTime": "2009-09-01 08:00:00",
+        "endTime": "2009-10-01 08:00:00",
+        "customer": "另一位尊贵的客户",
+        "saleNum": 8000,
+        "totalNum": 7000,
+        "inboundNum": 0,
+        "powerGear": "550",
+        "powerGearRange1": "550",
+        "powerGearRange2": "565"
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| order | array | 订单。 |
+| - code | string | 订单号。 |
+| - createTime | string | 此订单的创建时间。 |
+| - beginTime | string | 此订单的开始时间。 |
+| - endTime | string | 此订单的结束时间。 |
+| - creator | string | 创建此订单的账号。 |
+| - productCode | string | 产品编码。 |
+| - customer | string | 客户名称。 |
+| - saleNum | int | 投产组件数。 |
+| - totalNum | int | 订单组件数。 |
+| - inboundNum | int | 入库组件数限定值。 |
+| - powerGear | string | 功率等级。 |
+| - powerGearRange1 | string | 功率等级范围。 |
+| - powerGearRange2 | string | 功率等级范围。 |
+| - type | int | 0 = 厂区的订单，1 = 总部下发的订单 |
+
+修改成功时，会返回修改后的记录，响应体：
+
+```
+{
+    "clock": "2023-01-01 00:00:00.000",
+    "status": "ok",
+    "data": {
+        "order": {
+            "code": "NewOrder001",
+            "createTime": "2023-01-01 00:00:00",
+            "beginTime": "2009-09-01 08:00:00",
+            "endTime": "2009-10-01 08:00:00",
+            "creator": "admin",
+            "productCode": "DC202304",
+            "customer": "另一位尊贵的客户",
+            "totalNum": 7000,
+            "offlineNum": 0,
+            "onlineNum": 0,
+            "inboundNum": 0,
+            "saleNum": 8000,
+            "powerGear": "550",
+            "powerGearRange1": "550",
+            "powerGearRange2": "565",
+            "type": 0
+        }
+    }
+}
+```
--- a/mes/订单/列出所有订单.md
+++ b/mes/订单/列出所有订单.md
@ -0,0 +1,100 @@
+### 列出所有订单（ListOrder）
+
+此接口列出所有订单。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL: http://localhost:8033/open/listOrder
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区配置名称 |
+
+```
+{
+    "data": {
+        "profile": "test"
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| orders | array | 订单数组。 |
+| - code | string | 订单号。 |
+| - createTime | string | 此订单的创建时间。 |
+| - beginTime | string | 此订单的开始时间。 |
+| - endTime | string | 此订单的结束时间。 |
+| - creator | string | 创建此订单的账号。 |
+| - productCode | string | 产品编码。 |
+| - customer | string | 客户名称。 |
+| - saleNum | int | 投产组件数。 |
+| - totalNum | int | 订单组件数。 |
+| - inboundNum | int | 入库组件数限定值。 |
+| - powerGear | string | 功率等级。 |
+| - powerGearRange1 | string | 功率等级范围。 |
+| - powerGearRange2 | string | 功率等级范围。 |
+| - type | int | 0 = 厂区的订单，1 = 总部下发的订单 |
+
+认证成功时，响应如下：
+
+```
+{
+    "clock": "2008-08-08 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "orders": [
+            {
+                "code": "ORD001",
+                "createTime": "2008-08-08 20:00:00",
+                "beginTime": "2009-01-01 08:00:00",
+                "endTime": "2009-02-01 08:00:00",
+                "creator": "",
+                "productCode": "PRD001",
+                "customer": "A",
+                "saleNum": 1100,
+                "totalNum": 1000,
+                "inboundNum": 1000,
+                "powerGear": "600",
+                "powerGearRange1": "600",
+                "powerGearRange2": "620",
+                "type": 0
+            },
+            {
+                "code": "ORD002",
+                "createTime": "2008-08-08 20:00:00",
+                "beginTime": "2009-01-01 08:00:00",
+                "endTime": "2009-03-01 08:00:00",
+                "creator": "",
+                "productCode": "PRD001",
+                "customer": "B",
+                "saleNum": 1100,
+                "totalNum": 1000,
+                "inboundNum": 1000,
+                "powerGear": "600",
+                "powerGearRange1": "600",
+                "powerGearRange2": "620",
+                "type": 0
+            }
+        ]
+    }
+}
+```
--- a/mes/订单/删除订单.md
+++ b/mes/订单/删除订单.md
@ -0,0 +1,58 @@
+### 删除订单（DeleteOrder）
+
+此接口用于删除未使用的订单。
+
+若此订单已经创建工单，则无法立即删除订单；删除订单前，需要先删除此订单关联的工单。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/deleteOrder
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区配置名称。 |
+| code | string | 是 | 订单号。 |
+
+```
+{
+    "data": {
+        "profile": "test",
+        "code": "ORD001"
+    }
+}
+```
+
+---
+
+### 响应
+
+此接口没有响应的数据，删除成功时 status 为 ok：
+
+```
+{
+    "status": "ok",
+    "data": {}
+}`
+```
+
+删除失败时 status 是其它值：
+
+```
+{
+    "status": "exception",
+    "message": "订单【ORD001】已经开立【3】个工单，无法删除。"
+    "data": {}
+}
+```
--- a/mes/订单/添加订单.md
+++ b/mes/订单/添加订单.md
@ -0,0 +1,111 @@
+### 添加订单（AddOrder）
+
+此接口用于向 MES 添加订单记录，订单号必须唯一。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/addOrder
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区配置名称。 |
+| code | string | 是 | 订单号。 |
+| beginTime | string | 是 | 开始时间。 |
+| endTime | string | 是 | 结束时间。 |
+| creator | string | 否 | 创建人的用户名。 |
+| productCode | string | 是 | 产品编码。 |
+| customer | string | 否 | 客户名称。 |
+| saleNum | int | 是 | 投产组件数。<br>默此数量包含 B 级，用于追溯订单的材料消耗。 |
+| totalNum | int | 是 | 订单组件数。<br>默此数量一般只是 A 级。 |
+| inboundNum | int | 是 | 入库组件数限定值。<br>默不使用 WMS 卡关时指定为 0 即可。 |
+| powerGear | string | 否 | 功率等级。<br>若指定值，则内容必须是数字。 |
+| powerGearRange1 | string | 否 | 功率等级范围。<br>若指定值，则内容必须是数字。 |
+| powerGearRange2 | string | 否 | 功率等级范围。<br>若指定值，则内容必须是数字。 |
+| type | int | 否 | 0 = 厂区的订单，1 = 总部下发的订单。<br>默认值：0 |
+
+请求示例：
+
+```
+{
+    "data": {
+        "profile": "test",
+        "code": "NewOrder001",
+        "beginTime": "2008-09-01 08:00:00",
+        "endTime": "2008-10-01 08:00:00",
+        "creator": "admin",
+        "productCode": "DC202304",
+        "customer": "尊贵的客户",
+        "saleNum": 11000,
+        "totalNum": 10000,
+        "inboundNum": 0,
+        "powerGear": "600",
+        "powerGearRange1": "600",
+        "powerGearRange2": "620"
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| order | array | 订单。 |
+| - code | string | 订单号。 |
+| - createTime | string | 此订单的创建时间。 |
+| - beginTime | string | 此订单的开始时间。 |
+| - endTime | string | 此订单的结束时间。 |
+| - creator | string | 创建此订单的账号。 |
+| - productCode | string | 产品编码。 |
+| - customer | string | 客户名称。 |
+| - saleNum | int | 投产组件数。 |
+| - totalNum | int | 订单组件数。 |
+| - inboundNum | int | 入库组件数限定值。 |
+| - powerGear | string | 功率等级。 |
+| - powerGearRange1 | string | 功率等级范围。 |
+| - powerGearRange2 | string | 功率等级范围。 |
+| - type | int | 0 = 厂区的订单，1 = 总部下发的订单 |
+
+添加成功时，会返回已添加的记录，响应体：
+
+```
+{
+    "clock": "2023-01-01 00:00:00.000",
+    "status": "ok",
+    "data": {
+        "order": {
+            "code": "NewOrder001",
+            "createTime": "2023-01-01 00:00:00",
+            "beginTime": "2008-09-01 08:00:00",
+            "endTime": "2008-10-01 08:00:00",
+            "creator": "admin",
+            "productCode": "DC202304",
+            "customer": "顾客是上帝",
+            "totalNum": 10000,
+            "offlineNum": 0,
+            "onlineNum": 0,
+            "inboundNum": 0,
+            "saleNum": 11000,
+            "powerGear": "600",
+            "powerGearRange1": "600",
+            "powerGearRange2": "620",
+            "type": 0
+        }
+    }
+}
+```
--- a/mes/订单/获取订单信息.md
+++ b/mes/订单/获取订单信息.md
@ -0,0 +1,84 @@
+### 获取订单信息（GetOrder）
+
+此接口列出单挑订单记录。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL: http://localhost:8033/open/listOrder
+
+认证：需要（如何认证请查看《认证方式》）
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区配置名称。 |
+| code | string | 是 | 订单号。 |
+
+```
+{
+    "data": {
+        "profile": "test",
+        "code": "ORD001"
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| order | array | 订单。 |
+| - code | string | 订单号。 |
+| - createTime | string | 此订单的创建时间。 |
+| - beginTime | string | 此订单的开始时间。 |
+| - endTime | string | 此订单的结束时间。 |
+| - creator | string | 创建此订单的账号。 |
+| - productCode | string | 产品编码。 |
+| - customer | string | 客户名称。 |
+| - saleNum | int | 投产组件数。 |
+| - totalNum | int | 订单组件数。 |
+| - inboundNum | int | 入库组件数限定值。 |
+| - powerGear | string | 功率等级。 |
+| - powerGearRange1 | string | 功率等级范围。 |
+| - powerGearRange2 | string | 功率等级范围。 |
+| - type | int | 0 = 厂区的订单，1 = 总部下发的订单 |
+
+认证成功时，响应如下：
+
+```
+{
+    "clock": "2008-08-08 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "order": {
+            "code": "ORD001",
+            "createTime": "2008-08-08 20:00:00",
+            "beginTime": "2009-01-01 08:00:00",
+            "endTime": "2009-02-01 08:00:00",
+            "creator": "",
+            "productCode": "PRD001",
+            "customer": "A",
+            "saleNum": 1100,
+            "totalNum": 1000,
+            "inboundNum": 1000,
+            "powerGear": "600",
+            "powerGearRange1": "600",
+            "powerGearRange2": "620",
+            "type": 0
+        }
+    }
+}
+```