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

物料接口文档

master
吕成旭 1 year ago
parent
66f51f8c7d
commit
49f4ecede2
14 changed files with 622 additions and 8 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. 80
      mes/产品/修改产品.md
  2. 159
      mes/产品/列出产品.md
  3. 78
      mes/产品/列出产品标签形式.md
  4. 60
      mes/产品/删除产品.md
  5. 157
      mes/产品/查询产品详情.md
  6. 80
      mes/产品/添加产品.md
  7. 2
      mes/供应商/修改供应商.md
  8. 2
      mes/供应商/列出供应商.md
  9. 2
      mes/供应商/删除供应商.md
  10. 2
      mes/供应商/查询供应商详情.md
  11. 2
      mes/供应商/添加供应商.md
  12. 2
      mes/物料/列出物料类别.md
  13. 2
      mes/物料/删除物料.md
  14. 2
      mes/物料/查询物料详情.md

80
mes/产品/修改产品.md
View File

@ -0,0 +1,80 @@
### 修改产品（UpdateProduct）编码
此接口用于修改产品
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/UpdateProduct
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| productCode | string | 是| 产品编码 |
| familyCode | string | 是 | 标签形式 |
| processGroupId | int | 是 | 组件绑定生产流程id |
| crysTypeId | int | 是 | 晶体类型-id |
| busbarTypeId | int | 是 | 栅线类型-id |
| cellQty | int | 是 | 电池片数量-id |
| modSpecId | int | 是 | 组件规格-id |
| processType | int | 是 | 工艺类型-id |
| featureCode | int | 否 | 产品特征-id |
| modWeight | string | 否| 组件重量 |
| fgCode | string | 否| |
示例 1：修改一个产品基本字段
```
{
"data": {
profile: "测试厂区",
productCode: "088+089ART-MW",
familyCode: "ART550-144MHA",
processGroupId: 34,
crysTypeId: 12,
busbarTypeId: 31,
cellQty: 64,
modSpecId: 345,
processType: 22,
featureCode: 34,
modWeight:"",
fgCode:"",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "修改产品失败",
"data": {}
}
```

159
mes/产品/列出产品.md
View File

@ -0,0 +1,159 @@
### 列出产品（ListProduct）
此接口用于获取产品列表，搜索产品
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/ListProduct
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| search | string | 否 | 产品编码产品描述模糊查询 |
示例 1：模糊查询产品列表
```
{
"data": {
profile:"测试厂区",
search: "组件001",
}
}
```
---
### 响应
响应字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| productCode | string | 产品编码 |
| familyCode | string | 标签形式 |
| processGroupId | int | 组件绑定生产流程id |
| crysTypeId | int | 晶体类型-id |
| crysTypeDesc | string | 晶体类型-对应下拉选项的文本 |
| crysTypeValue | string | 晶体类型-对应下拉选项的值 |
| busbarTypeId | int | 栅线类型-id |
| busbarTypeDesc | string | 栅线类型-对应下拉选项的文本 |
| busbarTypeValue | string | 栅线类型-对应下拉选项的值 |
| cellQty | int | 电池片数量-实际数量 |
| cellQtyDesc | string | 晶体类型-对应下拉选项的文本 |
| cellQtyValue | string | 晶体类型-对应下拉选项的值 |
| modSpecId | int | 组件规格-id |
| modSpecDesc | string | 组件规格-对应下拉选项的文本 |
| modSpecValue | string | 组件规格-对应下拉选项的值 |
| processType | int | 工艺类型-id |
| processTypedesc | string | 工艺类型-对应下拉选项的文本 |
| processTypeValue | string | 工艺类型-对应下拉选项的值 |
| featureCode | int | 产品特征-id |
| featureCodeDesc | string | 产品特征-对应下拉选项的文本 |
| featureCodeValue | string | 产品特征-对应下拉选项的值 |
| modWeight | string | 组件重量 |
| fgCode | string | |
| createDate | string | 创建时间 |
| lastUpdate | string | 最近更新时间 |
| lastUpdateuser | string | 最近更新账号 |
| serialCodeRule | string | 组件生码编码规则 |
| palletCodeRule | string | 包装生码编码规则 |
| attrs | Array | 产品属性列表 |
attrs字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| id | string | id字段 |
| attributeId | string | 属性Id |
| attributeDesc | string | 属性名称 |
| productCode | string | 产品编号 |
| description | string | 属性代码描述 |
| code | string | 属性代码 |
| createTime | string | 创建时间 |
| createUser | string | 创建人 |
查询成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": [
{
productCode:"088+089ART-MW",
familyCode:"ART550-144MHA",
processGroupId:0,
crysTypeId:38,
crysTypeDesc:"单晶",
crysTypeValue:"M",
busbarTypeId:37,
busbarTypeDesc:"11BB",
busbarTypeValue:"11BB",
cellQty:144,
cellQtyDesc:"144",
cellQtyValue:"144",
modSpecId:49,
modSpecDesc:"2279*1134*35",
modSpecValue:"2279*1134*35",
processType:39,
processTypedesc:"单玻组件",
processTypeValue:"单玻组件",
featureCode:9,
featureCodeDesc:"P",
featureCodeValue:"P",
modWeight:"",
fgCode:"",
createDate:"2022-01-10 23:10:01.890",
lastUpdate:"2022-01-16 22:24:32.273",
lastUpdateuser:"mesadmin",
serialCodeRule:"DM405M10-54HSW",
palletCodeRule:"DM405M10-54HSW-bz",
attrs:[
{
id:"7add1e54-d99e-4432-8175-c5afd80ae058",
attributeId:"Product_GLASS_TYPE",
attributeDesc:"玻璃类型",
productCode:"088+089ART-MW",
description:"双玻",
code:"双玻",
createTime:"2023-06-07 14:59:06.800",
createUser:""
},
{
id:"c671f463-5f66-4b99-9083-44fe9293a83e",
attributeId:"Product_PACK_QTY",
attributeDesc:"包装数量",
productCode:"088+089ART-MW",
description:"31",
code:"31",
createTime:"2023-06-07 14:59:06.800",
createUser:""
}
],
}
]
}
```
查询报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "查询错误",
"data": {}
}
```

78
mes/产品/列出产品标签形式.md
View File

@ -0,0 +1,78 @@
### 列出产品标签形式（ListDfFamilys）
此接口用于获取列出产品标签形式下拉列表
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/ListDfFamilys
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| search | string | 否 | 产品标签形式编码、描述模糊查询 |
示例 1：模糊查询产品标签形式
```
{
"data": {
profile: "测试厂区",
search: "11BB",
}
}
```
---
### 响应
响应字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| familyCode | string | 标签形式编码 |
| descriptions | string | 标签形式描述 |
| aliasName | string | 创建者 |
| flag | int | 数据状态：0禁用 1启用 |
| createTime | string | 创建时间 |
查询成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": [
{
familyCode: "AG-HD108N-415",
descriptions: "AG-HD108N-415",
aliasName: "mesadmin",
flag: 1,
createTime: "2022-01-10 23:10:01.890"
}
]
}
```
查询报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "查询错误",
"data": {}
}
```

60
mes/产品/删除产品.md
View File

@ -0,0 +1,60 @@
### 删除产品（DeleteProduct）编码
此接口用于删除产品
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/DeleteProduct
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| productCode | string | 是| 产品编码 |
示例 1：删除指定产品
```
{
"data": {
profile: "测试厂区",
productCode: "088+089ART-MW",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "删除产品失败",
"data": {}
}
```

157
mes/产品/查询产品详情.md
View File

@ -0,0 +1,157 @@
### 查询产品详情（QueryProduct）
此接口用于查询产品详情
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/QueryProduct
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| productCode | string | 否 | 产品编码 |
示例 1：查询产品信息
```
{
"data": {
profile:"测试厂区",
productCode:"088+089ART-MW",
}
}
```
---
### 响应
响应字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| productCode | string | 产品编码 |
| familyCode | string | 标签形式 |
| processGroupId | int | 组件绑定生产流程id |
| crysTypeId | int | 晶体类型-id |
| crysTypeDesc | string | 晶体类型-对应下拉选项的文本 |
| crysTypeValue | string | 晶体类型-对应下拉选项的值 |
| busbarTypeId | int | 栅线类型-id |
| busbarTypeDesc | string | 栅线类型-对应下拉选项的文本 |
| busbarTypeValue | string | 栅线类型-对应下拉选项的值 |
| cellQty | int | 电池片数量-实际数量 |
| cellQtyDesc | string | 晶体类型-对应下拉选项的文本 |
| cellQtyValue | string | 晶体类型-对应下拉选项的值 |
| modSpecId | int | 组件规格-id |
| modSpecDesc | string | 组件规格-对应下拉选项的文本 |
| modSpecValue | string | 组件规格-对应下拉选项的值 |
| processType | int | 工艺类型-id |
| processTypedesc | string | 工艺类型-对应下拉选项的文本 |
| processTypeValue | string | 工艺类型-对应下拉选项的值 |
| featureCode | int | 产品特征-id |
| featureCodeDesc | string | 产品特征-对应下拉选项的文本 |
| featureCodeValue | string | 产品特征-对应下拉选项的值 |
| modWeight | string | 组件重量 |
| fgCode | string | |
| createDate | string | 创建时间 |
| lastUpdate | string | 最近更新时间 |
| lastUpdateuser | string | 最近更新账号 |
| serialCodeRule | string | 组件生码编码规则 |
| palletCodeRule | string | 包装生码编码规则 |
| attrs | Array | 产品属性列表 |
attrs字段
| 字段 | 类型 | 说明 |
| :-- | :-- | :-- |
| id | string | id字段 |
| attributeId | string | 属性Id |
| attributeDesc | string | 属性名称 |
| productCode | string | 产品编号 |
| description | string | 属性代码描述 |
| code | string | 属性代码 |
| createTime | string | 创建时间 |
| createUser | string | 创建人 |
查询成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {
productCode:"088+089ART-MW",
familyCode:"ART550-144MHA",
processGroupId:0,
crysTypeId:38,
crysTypeDesc:"单晶",
crysTypeValue:"M",
busbarTypeId:37,
busbarTypeDesc:"11BB",
busbarTypeValue:"11BB",
cellQty:144,
cellQtyDesc:"144",
cellQtyValue:"144",
modSpecId:49,
modSpecDesc:"2279*1134*35",
modSpecValue:"2279*1134*35",
processType:39,
processTypedesc:"单玻组件",
processTypeValue:"单玻组件",
featureCode:9,
featureCodeDesc:"P",
featureCodeValue:"P",
modWeight:"",
fgCode:"",
createDate:"2022-01-10 23:10:01.890",
lastUpdate:"2022-01-16 22:24:32.273",
lastUpdateuser:"mesadmin",
serialCodeRule:"DM405M10-54HSW",
palletCodeRule:"DM405M10-54HSW-bz",
attrs:[
{
id:"7add1e54-d99e-4432-8175-c5afd80ae058",
attributeId:"Product_GLASS_TYPE",
attributeDesc:"玻璃类型",
productCode:"088+089ART-MW",
description:"双玻",
code:"双玻",
createTime:"2023-06-07 14:59:06.800",
createUser:""
},
{
id:"c671f463-5f66-4b99-9083-44fe9293a83e",
attributeId:"Product_PACK_QTY",
attributeDesc:"包装数量",
productCode:"088+089ART-MW",
description:"31",
code:"31",
createTime:"2023-06-07 14:59:06.800",
createUser:""
}
],
}
}
```
查询报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "查询产品详情失败",
"data": {}
}
```

80
mes/产品/添加产品.md
View File

@ -0,0 +1,80 @@
### 添加产品（AddProduct）编码
此接口用于添加产品
---
### 基本信息
方法：POST
URL: http://localhost:8033/open/AddProduct
---
### 请求
请求参数
| 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区代码 |
| productCode | string | 是| 产品编码 |
| familyCode | string | 是 | 标签形式 |
| processGroupId | int | 是 | 组件绑定生产流程id |
| crysTypeId | int | 是 | 晶体类型-id |
| busbarTypeId | int | 是 | 栅线类型-id |
| cellQty | int | 是 | 电池片数量-id |
| modSpecId | int | 是 | 组件规格-id |
| processType | int | 是 | 工艺类型-id |
| featureCode | int | 否 | 产品特征-id |
| modWeight | string | 否| 组件重量 |
| fgCode | string | 否| |
示例 1：添加一个产品
```
{
"data": {
profile: "测试厂区",
productCode: "088+089ART-MW",
familyCode: "ART550-144MHA",
processGroupId: 34,
crysTypeId: 12,
busbarTypeId: 31,
cellQty: 64,
modSpecId: 345,
processType: 22,
featureCode: 34,
modWeight:"",
fgCode:"",
}
}
```
---
### 响应
执行成功时，响应如下：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "ok",
"data": {}
}
```
执行报错：
```
{
"clock": "2023-06-25 20:00:00.000",
"status": "exception",
"message": "添加产品失败",
"data": {}
}
```

2
mes/供应商/修改供应商.md
View File

@ -37,7 +37,7 @@ URL: http://localhost:8033/open/UpdateSupplier
| v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 | | v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 |
| v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 | | v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 |
示例 1：模糊查询玻璃 示例 1：修改供应商
``` ```
{ {

2
mes/供应商/列出供应商.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/ListSupplier
| profile | string | 是 | 厂区编码 | | profile | string | 是 | 厂区编码 |
| search | string | 否 | 供应商编码、名称模糊查询 | | search | string | 否 | 供应商编码、名称模糊查询 |
示例 1：模糊查询玻璃 示例 1：模糊查询供应商
``` ```
{ {

2
mes/供应商/删除供应商.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/DeleteSupplier
| profile | string | 是 | 厂区编码 | | profile | string | 是 | 厂区编码 |
| supplierCode | string | 否 | 供应商编码 | | supplierCode | string | 否 | 供应商编码 |
示例 1：模糊查询玻璃 示例 1：删除供应商
``` ```
{ {

2
mes/供应商/查询供应商详情.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/QuerySupplier
| profile | string | 是 | 厂区编码 | | profile | string | 是 | 厂区编码 |
| supplierCode | string | 否 | 供应商编码 | | supplierCode | string | 否 | 供应商编码 |
示例 1：模糊查询玻璃 示例 1：查询供应商详情
``` ```
{ {

2
mes/供应商/添加供应商.md
View File

@ -37,7 +37,7 @@ URL: http://localhost:8033/open/AddSupplier
| v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 | | v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 |
| v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 | | v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 |
示例 1：模糊查询玻璃 示例 1：添加供应商
``` ```
{ {

2
mes/物料/列出物料类别.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/ListMaterialType
| profile | string | 是 | 厂区代码 | | profile | string | 是 | 厂区代码 |
| search | string | 否 | 物料类型模糊查询 | | search | string | 否 | 物料类型模糊查询 |
示例 1：模糊查询玻璃 示例 1：模糊查询电池物料类别
``` ```
{ {

2
mes/物料/删除物料.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/DeleteMaterial
| profile | string | 是 | 厂区代码 | | profile | string | 是 | 厂区代码 |
| materialCode | string | 否 | 物料编码 | | materialCode | string | 否 | 物料编码 |
示例 1：删除电池片及物料属性值 示例 1：删除物料
``` ```
{ {

2
mes/物料/查询物料详情.md
View File

@ -21,7 +21,7 @@ URL: http://localhost:8033/open/QueryMaterial
| profile | string | 是 | 厂区代码 | | profile | string | 是 | 厂区代码 |
| materialCode | string | 否 | 物料编码 | | materialCode | string | 否 | 物料编码 |
示例 1：删除电池片及物料属性值 示例 1：查询物料详情
``` ```
{ {

Write Preview
Loading…
Cancel
Save