Open
/
open-api
18
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

bom接口文档

master
吕成旭 1 year ago
parent
fbba8e7b05
commit
fabcf68fed
6 changed files with 442 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 61
      mes/BOM/BOM删除材料.md
  2. 75
      mes/BOM/BOM添加材料.md
  3. 61
      mes/BOM/修改BOM.md
  4. 80
      mes/BOM/列出BOM.md
  5. 104
      mes/BOM/查询BOM明细.md
  6. 61
      mes/BOM/添加BOM.md

61
mes/BOM/BOM删除材料.md
View File

@ -0,0 +1,61 @@
### BOM删除材料（BomDeletePart）
此接口用于删除Bom材料信息
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/BomDeletePart
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| bomId | string | 是 | BomId |
| bomPartNbr | string | 是 | 物料料号 |
示例 1：删除Bom材料信息
```
{
"data": {
profile:"测试厂区",
bomId:"1407",
bomPartNbr:"M.1.1.N.100"
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "删除材料失败",
"data": {}
}
```

75
mes/BOM/BOM添加材料.md
View File

@ -0,0 +1,75 @@
### BOM添加材料（BomAddPart）
此接口用于向Bom添加材料信息
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/BomAddPart
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| bomId | string | 是 | BomId |
| bomPartNbr | string | 是 | 物料料号 |
| isPrimary | int | 是 | 是否为主料：0否 1是 |
| PrimaryPart | string | 是 | 主料料号,如果isPrimary=0，则需要传递该字段 |
| SerialRequirement | double | 是 | 材料单耗 |
| PartType | string | 是 | 物料类别id |
| LostRatio | double | 是 | 物料耗损 |
| GlueType | string | 否 | |
| Supplier | string | 否 | 供应商编码 |
示例 1：向Bom添加材料信息
```
{
"data": {
profile:"测试厂区",
bomId:"1407",
bomPartNbr:"M.1.1.N.100",
isPrimary:1,
PrimaryPart:"M.1.1.N.100",
SerialRequirement:3,
PartType:"CELL",
LostRatio:3,
GlueType:"",
Supplier:"CS2",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "添加材料失败",
"data": {}
}
```

61
mes/BOM/修改BOM.md
View File

@ -0,0 +1,61 @@
### 修改BOM（UpdateConfigBom）
此接口用于修改BOM
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/UpdateConfigBom
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| bomId | string | 是 | bomid |
| descriptions | string | 否 | bom描述 |
示例 1：修改bom描述，bomid不可修改
```
{
"data": {
profile:"测试厂区",
bomId:"BOM001",
descriptions:"修改后的BOM描述",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "修改Bom失败",
"data": {}
}
```

80
mes/BOM/列出BOM.md
View File

@ -0,0 +1,80 @@
### 列出Bom（ListConfigBom）
此接口用于获取Bom列表，搜索Bom
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/ListConfigBom
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| search | string | 否 | BomId、Bom描述模糊查询 |
示例 1：模糊查询bom列表
```
{
"data": {
profile:"测试厂区",
search: "bom",
}
}
```
---
### 响应
响应字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| bomId | string | bomId |
| descriptions | string | bom描述 |
| flag | int | 数据状态：0禁用 1启用 |
| createTime | string | 创建时间 |
查询成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
list:[{
bomId:"CXBOM",
descriptions:"CXBOM",
flag:1,
createTime:"2023-04-09 18:10:01"
},{
bomId:"testBom002",
descriptions:"测试BOM002",
flag:1,
createTime:"2023-04-09 18:10:01"
}]
}
}
```
查询报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "错误信息",
"data": {}
}
```

104
mes/BOM/查询BOM明细.md
View File

@ -0,0 +1,104 @@
### 查询Bom明细（ListConfigBomPart）
此接口用于获取Bom列表，搜索Bom
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/ListConfigBomPart
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| bomId | string | 否 | BomId |
示例 1：模糊查询bom列表
```
{
"data": {
profile:"测试厂区",
bomId: "1407",
}
}
```
---
### 响应
响应字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| bomId | string | bomId |
| descriptions | string | bom描述 |
| bomPartNbr | string | 物料料号 |
| isPrimary | int | 是否为主料：0否 1是 |
| PrimaryPart | string | 主料料号 |
| SerialRequirement | double | 材料单耗 |
| Uom | string | 材料单位 |
| PartType | string | 物料类别id |
| PartTypeDesc | string | 物料类别描述 |
| LostRatio | double | 物料耗损 |
| GlueType | string | |
| Supplier | string | 供应商编码 |
查询成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
list:[{
bomId:"1407",
descriptions:"1407号bom",
bomPartNbr:"M.1.1.N.100",
isPrimary:1,
PrimaryPart:"M.1.1.N.100",
SerialRequirement:3,
Uom:"Pcs",
PartType:"CELL",
PartTypeDesc:"电池片",
LostRatio:3,
GlueType:"",
Supplier:"CS2",
},{
bomId:"1407",
descriptions:"1407号bom",
bomPartNbr:"401908010191",
isPrimary:1,
PrimaryPart:"401908010191",
SerialRequirement:1,
Uom:"Pcs",
PartType:"JBOX",
PartTypeDesc:"接线盒",
LostRatio:0,
GlueType:"",
Supplier:"CS2",
}]
}
}
```
查询报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "错误信息",
"data": {}
}
```

61
mes/BOM/添加BOM.md
View File

@ -0,0 +1,61 @@
### 添加BOM（AddConfigBom）
此接口用于添加BOM
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/AddConfigBom
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| bomId | string | 是 | bomid |
| descriptions | string | 否 | bom描述 |
示例 1：添加bom
```
{
"data": {
profile:"测试厂区",
bomId:"BOM001",
descriptions:"新的bom",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "添加Bom失败",
"data": {}
}
```
Write Preview
Loading…
Cancel
Save