增加工单接口。

1 year ago · 6241aad8bd
6 changed files with 435 additions and 1 deletions
--- a/mes/工单/修改工单.md
+++ b/mes/工单/修改工单.md
@ -0,0 +1,120 @@
+### 修改工单
+
+此接口可修改工单的属性。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/editWorkorder
+
+认证：需要
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区。 |
+| code | string | 是 | 工单号。 |
+| areaCode | string | 是 | 车间编号。 |
+| typeCode | string | 是 | 工单类型编号。301 = 正常工单<br>300 = 返工工单 |
+| orderCode | string | 否 | 订单号，不指定此参数时将修改为空。 |
+| orderTypeCode | string | 否 | 订单类型编号，不指定此参数时将修改为空。<br>General = 常规订单<br>Supervision = 监造订单 |
+| customer | string | 否 | 客户，不指定此参数时将修改为空。 |
+| oemCustomer | string | 否 | OEM 客户，不指定此参数时将修改为空。 |
+| productCode | string | 是 | 产品编码。 |
+| productGrade | string | 是 | 产品等级。 |
+| planNum | int | 是 | 计划数量。 |
+| warnNum | int | 是 | 预警数量。 |
+| targetNum | int | 是 | 工单交付数量。 |
+| beginTime | string | 是 | 开始时间。 |
+| endTime | string | 是 | 结束时间 |
+
+请求示例
+
+```
+{
+    "data":  {
+        "profile": "测试",
+        "code": "NewWorkorder001",
+        "areaCode": "1",
+        "typeCode": "301",
+        "orderCode": "NewOrder001",
+        "orderTypeCode": "General",
+        "customer": "客户 2",
+        "oemCustomer": "OEM 客户 2",
+        "productCode": "1000",
+        "productGrade": "600",
+        "planNum": 15200,
+        "warnNum": 14800,
+        "targetNum": 15000,
+        "beginTime": "2009-08-08 20:00:00",
+        "endTime": "2009-08-24 20:00:00",
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| workorder | object | 工单。 |
+| - code | string | 工单号。 |
+| - areaCode | string | 车间编号。 |
+| - areaDesc | string | 车间描述。 |
+| - typeCode | string | 工单类型。 |
+| - typeDesc | string | 工单类型。 |
+| - orderCode | string | 订单号。 |
+| - orderTypeCode | string | 订单类型。 |
+| - orderTypeDesc | string | 订单类型。 |
+| - customer | string | 客户。 |
+| - oemCustomer | string | OEM 客户。 |
+| - productCode | string | 产品编码。 |
+| - productGrade | string | 产品等级。 |
+| - planNum | int | 计划数量。 |
+| - warnNum | int | 预警数量。 |
+| - targetNum | int | 工单交付数量。 |
+| - beginTime | string | 工单开始时间。 |
+| - endTime | string | 工单结束时间 |
+| - createTime | string | 工单创建时间。 |
+
+成功时的响应示例：
+
+```
+{
+    "clock": "2023-01-01 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "workorder": {
+            "code": "NewWorkorder001",
+            "areaCode": "1",
+            "areaDesc": null,
+            "typeCode": "301",
+            "type_desc": "正常工单",
+            "orderCode": "NewOrder001",
+            "orderTypeCode": "General",
+            "orderTypeDesc": "常规订单",
+            "customer": "客户",
+            "oemCustomer": "OEM 客户",
+            "productCode": "1000",
+            "productGrade": "600",
+            "planNum": 5200,
+            "warnNum": 4800,
+            "targetNum": 5000,
+            "beginTime": "2008-08-08 20:00:00",
+            "endTime": "2008-08-24 20:00:00",
+            "createTime": "2023-01-01 20:00:00"
+        }
+    }
+}
+```
--- a/mes/工单/列出工单.md
+++ b/mes/工单/列出工单.md
@ -0,0 +1,54 @@
+### 列出工单
+
+此接口列出所有工单号。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/listWorkorder
+
+认证：需要
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区。 |
+
+请求示例
+
+```
+{
+    "data":  {
+        "profile": "测试"
+    }
+}
+```
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| codes | array | 工单号数组。 |
+
+```
+{
+  "status": "ok",
+  "data": {
+      "codes": [
+          "NewWorkorder001",
+          "NewWorkorder002",
+          "NewWorkorder003"
+      ]
+  }
+}
+```
--- a/mes/工单/删除工单.md
+++ b/mes/工单/删除工单.md
@ -0,0 +1,46 @@
+### 获取工单
+
+此接口用于删除尚未生成组件序列号的工单；如果工单已经生成了组件序列号，那么这个工单将无法删除。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/getWorkorder
+
+认证：需要
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区。 |
+| code | string | 是 | 工单号。 |
+
+请求示例
+
+```
+{
+    "data":  {
+        "profile": "测试",
+        "code": "NewWorkorder001"
+    }
+}
+```
+
+### 响应
+
+删除工单成功时，接口返回的 API 状态是 ok，没有其它字段。
+
+```
+{
+  "status": "ok",
+  "data": {}
+}
+```
--- a/mes/工单/添加工单.md
+++ b/mes/工单/添加工单.md
@ -0,0 +1,120 @@
+### 添加工单
+
+此接口可创建未签核的工单，工单号必须唯一。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/addWorkorder
+
+认证：需要
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区。 |
+| code | string | 是 | 工单号。 |
+| areaCode | string | 是 | 车间编号。 |
+| typeCode | string | 是 | 工单类型编号。301 = 正常工单<br>300 = 返工工单 |
+| orderCode | string | 否 | 订单号。 |
+| orderTypeCode | string | 否 | 订单类型编号。<br>General = 常规订单<br>Supervision = 监造订单 |
+| customer | string | 否 | 客户。 |
+| oemCustomer | string | 否 | OEM 客户。 |
+| productCode | string | 是 | 产品编码。 |
+| productGrade | string | 是 | 产品等级。 |
+| planNum | int | 是 | 计划数量。 |
+| warnNum | int | 是 | 预警数量。 |
+| targetNum | int | 是 | 工单交付数量。 |
+| beginTime | string | 是 | 开始时间。 |
+| endTime | string | 是 | 结束时间 |
+
+请求示例
+
+```
+{
+    "data":  {
+        "profile": "测试",
+        "code": "NewWorkorder001",
+        "areaCode": "1",
+        "typeCode": "301",
+        "orderCode": "NewOrder001",
+        "orderTypeCode": "General",
+        "customer": "客户",
+        "oemCustomer": "OEM 客户",
+        "productCode": "1000",
+        "productGrade": "600",
+        "planNum": 5200,
+        "warnNum": 4800,
+        "targetNum": 5000,
+        "beginTime": "2008-08-08 20:00:00",
+        "endTime": "2008-08-24 20:00:00",
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| workorder | object | 工单。 |
+| - code | string | 工单号。 |
+| - areaCode | string | 车间编号。 |
+| - areaDesc | string | 车间描述。 |
+| - typeCode | string | 工单类型。 |
+| - typeDesc | string | 工单类型。 |
+| - orderCode | string | 订单号。 |
+| - orderTypeCode | string | 订单类型。 |
+| - orderTypeDesc | string | 订单类型。 |
+| - customer | string | 客户。 |
+| - oemCustomer | string | OEM 客户。 |
+| - productCode | string | 产品编码。 |
+| - productGrade | string | 产品等级。 |
+| - planNum | int | 计划数量。 |
+| - warnNum | int | 预警数量。 |
+| - targetNum | int | 工单交付数量。 |
+| - beginTime | string | 工单开始时间。 |
+| - endTime | string | 工单结束时间 |
+| - createTime | string | 工单创建时间。 |
+
+成功时的响应示例：
+
+```
+{
+    "clock": "2023-01-01 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "workorder": {
+            "code": "NewWorkorder001",
+            "areaCode": "1",
+            "areaDesc": null,
+            "typeCode": "301",
+            "type_desc": "正常工单",
+            "orderCode": "NewOrder001",
+            "orderTypeCode": "General",
+            "orderTypeDesc": "常规订单",
+            "customer": "客户",
+            "oemCustomer": "OEM 客户",
+            "productCode": "1000",
+            "productGrade": "600",
+            "planNum": 5200,
+            "warnNum": 4800,
+            "targetNum": 5000,
+            "beginTime": "2008-08-08 20:00:00",
+            "endTime": "2008-08-24 20:00:00",
+            "createTime": "2023-01-01 20:00:00"
+        }
+    }
+}
+```
--- a/mes/工单/获取工单.md
+++ b/mes/工单/获取工单.md
@ -0,0 +1,94 @@
+### 获取工单
+
+此接口用于根据工单号获取工单信息。
+
+---
+
+### 基本信息
+
+方法：POST
+
+URL：http://localhost:8033/open/getWorkorder
+
+认证：需要
+
+---
+
+### 请求
+
+请求参数
+
+| 参数名 | 类型 | 必填 | 说明 |
+| :-- | :-- | :-- | :-- |
+| profile | string | 是 | 厂区。 |
+| code | string | 是 | 工单号。 |
+
+请求示例
+
+```
+{
+    "data":  {
+        "profile": "测试",
+        "code": "NewWorkorder001"
+    }
+}
+```
+
+---
+
+### 响应
+
+响应字段
+
+| 字段 | 类型 |  说明 |
+| :-- | :-- | :-- |
+| workorder | object | 工单。 |
+| - code | string | 工单号。 |
+| - areaCode | string | 车间编号。 |
+| - areaDesc | string | 车间描述。 |
+| - typeCode | string | 工单类型。 |
+| - typeDesc | string | 工单类型。 |
+| - orderCode | string | 订单号。 |
+| - orderTypeCode | string | 订单类型。 |
+| - orderTypeDesc | string | 订单类型。 |
+| - customer | string | 客户。 |
+| - oemCustomer | string | OEM 客户。 |
+| - productCode | string | 产品编码。 |
+| - productGrade | string | 产品等级。 |
+| - planNum | int | 计划数量。 |
+| - warnNum | int | 预警数量。 |
+| - targetNum | int | 工单交付数量。 |
+| - beginTime | string | 工单开始时间。 |
+| - endTime | string | 工单结束时间 |
+| - createTime | string | 工单创建时间。 |
+
+成功时的响应示例：
+
+```
+{
+    "clock": "2023-01-01 20:00:00.000",
+    "status": "ok",
+    "data": {
+        "workorder": {
+            "code": "NewWorkorder001",
+            "areaCode": "1",
+            "areaDesc": null,
+            "typeCode": "301",
+            "type_desc": "正常工单",
+            "orderCode": "NewOrder001",
+            "orderTypeCode": "General",
+            "orderTypeDesc": "常规订单",
+            "customer": "客户",
+            "oemCustomer": "OEM 客户",
+            "productCode": "1000",
+            "productGrade": "600",
+            "planNum": 5200,
+            "warnNum": 4800,
+            "targetNum": 5000,
+            "beginTime": "2008-08-08 20:00:00",
+            "endTime": "2008-08-24 20:00:00",
+            "createTime": "2023-01-01 20:00:00"
+        }
+    }
+}
+```
--- a/mes/订单/删除订单.md
+++ b/mes/订单/删除订单.md
@ -44,7 +44,7 @@ URL：http://localhost:8033/open/deleteOrder
 {
    "status": "ok",
    "data": {}
-}`
+}
 ```

 删除失败时 status 是其它值：