diff --git a/mes/BOM/BOM删除材料.md b/mes/BOM/BOM删除材料.md new file mode 100644 index 0000000..dd8e864 --- /dev/null +++ b/mes/BOM/BOM删除材料.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/BOM添加材料.md b/mes/BOM/BOM添加材料.md new file mode 100644 index 0000000..b15ffca --- /dev/null +++ b/mes/BOM/BOM添加材料.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/产品绑定BOM.md b/mes/BOM/产品绑定BOM.md new file mode 100644 index 0000000..f50e665 --- /dev/null +++ b/mes/BOM/产品绑定BOM.md @@ -0,0 +1,61 @@ +### 产品绑定BOM（ProductBindBom） + +此接口用于产品绑定BOM信息 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ProductBindBom + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| productCode | string | 是 | 产品编码 | +| bomId | string | 是 | BomId | + +示例 1：产品绑定BOM信息 + +``` +{ + "data": { + profile:"测试厂区", + productCode:"088+089ART-MW", + bomId:"1407" + } +} +``` + +--- + +### 响应 + + +执行成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": {} +} +``` + +执行报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "执行失败", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/修改BOM.md b/mes/BOM/修改BOM.md new file mode 100644 index 0000000..985ee7d --- /dev/null +++ b/mes/BOM/修改BOM.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/列出BOM.md b/mes/BOM/列出BOM.md new file mode 100644 index 0000000..d9502b4 --- /dev/null +++ b/mes/BOM/列出BOM.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/查询BOM明细.md b/mes/BOM/查询BOM明细.md new file mode 100644 index 0000000..6e079e1 --- /dev/null +++ b/mes/BOM/查询BOM明细.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/BOM/添加BOM.md b/mes/BOM/添加BOM.md new file mode 100644 index 0000000..f90539e --- /dev/null +++ b/mes/BOM/添加BOM.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/产品/修改产品.md b/mes/产品/修改产品.md new file mode 100644 index 0000000..129e4d3 --- /dev/null +++ b/mes/产品/修改产品.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/产品/列出产品.md b/mes/产品/列出产品.md new file mode 100644 index 0000000..2257c69 --- /dev/null +++ b/mes/产品/列出产品.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/产品/删除产品.md b/mes/产品/删除产品.md new file mode 100644 index 0000000..ebd2493 --- /dev/null +++ b/mes/产品/删除产品.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/产品/查询产品详情.md b/mes/产品/查询产品详情.md new file mode 100644 index 0000000..c029ae7 --- /dev/null +++ b/mes/产品/查询产品详情.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/产品/添加产品.md b/mes/产品/添加产品.md new file mode 100644 index 0000000..7fb0442 --- /dev/null +++ b/mes/产品/添加产品.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/供应商/修改供应商.md b/mes/供应商/修改供应商.md index a592f29..ee7cac8 100644 --- a/mes/供应商/修改供应商.md +++ b/mes/供应商/修改供应商.md @@ -37,7 +37,7 @@ URL: http://localhost:8033/open/UpdateSupplier | v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 | | v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 | -示例 1：模糊查询玻璃 +示例 1：修改供应商 ``` { diff --git a/mes/供应商/列出供应商.md b/mes/供应商/列出供应商.md index 1204c44..e84e325 100644 --- a/mes/供应商/列出供应商.md +++ b/mes/供应商/列出供应商.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/ListSupplier | profile | string | 是 | 厂区编码 | | search | string | 否 | 供应商编码、名称模糊查询 | -示例 1：模糊查询玻璃 +示例 1：模糊查询供应商 ``` { diff --git a/mes/供应商/删除供应商.md b/mes/供应商/删除供应商.md index 3a2f1c6..3ef6a38 100644 --- a/mes/供应商/删除供应商.md +++ b/mes/供应商/删除供应商.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/DeleteSupplier | profile | string | 是 | 厂区编码 | | supplierCode | string | 否 | 供应商编码 | -示例 1：模糊查询玻璃 +示例 1：删除供应商 ``` { diff --git a/mes/供应商/查询供应商详情.md b/mes/供应商/查询供应商详情.md index ffb82df..5a478ab 100644 --- a/mes/供应商/查询供应商详情.md +++ b/mes/供应商/查询供应商详情.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/QuerySupplier | profile | string | 是 | 厂区编码 | | supplierCode | string | 否 | 供应商编码 | -示例 1：模糊查询玻璃 +示例 1：查询供应商详情 ``` { diff --git a/mes/供应商/添加供应商.md b/mes/供应商/添加供应商.md index d1aca66..a766ef2 100644 --- a/mes/供应商/添加供应商.md +++ b/mes/供应商/添加供应商.md @@ -37,7 +37,7 @@ URL: http://localhost:8033/open/AddSupplier | v_flag_jboxglue | int | 否 | 线盒胶供应商,0否 1是 | | v_flag_isolatingbar | int | 否 | 隔离条供应商,0否 1是 | -示例 1：模糊查询玻璃 +示例 1：添加供应商 ``` { diff --git a/mes/物料/列出物料类别.md b/mes/物料/列出物料类别.md index aa62f84..c589fb5 100644 --- a/mes/物料/列出物料类别.md +++ b/mes/物料/列出物料类别.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/ListMaterialType | profile | string | 是 | 厂区代码 | | search | string | 否 | 物料类型模糊查询 | -示例 1：模糊查询玻璃 +示例 1：模糊查询电池物料类别 ``` { diff --git a/mes/物料/删除物料.md b/mes/物料/删除物料.md index 54196dc..b05ddc0 100644 --- a/mes/物料/删除物料.md +++ b/mes/物料/删除物料.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/DeleteMaterial | profile | string | 是 | 厂区代码 | | materialCode | string | 否 | 物料编码 | -示例 1：删除电池片及物料属性值 +示例 1：删除物料 ``` { diff --git a/mes/物料/查询物料详情.md b/mes/物料/查询物料详情.md index fbb5858..5b1471b 100644 --- a/mes/物料/查询物料详情.md +++ b/mes/物料/查询物料详情.md @@ -21,7 +21,7 @@ URL: http://localhost:8033/open/QueryMaterial | profile | string | 是 | 厂区代码 | | materialCode | string | 否 | 物料编码 | -示例 1：删除电池片及物料属性值 +示例 1：查询物料详情 ``` { diff --git a/mes/账号/修改账号.md b/mes/账号/修改账号.md new file mode 100644 index 0000000..e5eaa7b --- /dev/null +++ b/mes/账号/修改账号.md @@ -0,0 +1,74 @@ +### 修改账号 +此接口用于给mes修改账号昵称或启用状态。 +此接口需要认证，详情请查看《认证方式》。 + +--- + +### 基本信息 +方法：POST +URL: http://localhost:8033/open/editUser + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名，仅小写，英文与数字 | +| Nick | String | 否 | 昵称 | +| IsActive | Bool | 否 | 是否启用 true:是｜false:否 | + +__请求示例：__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云", + "IsActive":true + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态，ok：成功，error：错误，exception：异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/修改账号密码.md b/mes/账号/修改账号密码.md new file mode 100644 index 0000000..dabb6ab --- /dev/null +++ b/mes/账号/修改账号密码.md @@ -0,0 +1,72 @@ +### 修改账号密码 +此接口用于给mes修改账号密码。 +此接口需要认证，详情请查看《认证方式》。 + +--- + +### 基本信息 +方法：POST +URL: http://localhost:8033/open/editUserPwd + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名，仅小写，英文与数字 | +| Password | String | 是 | 密码 | + +__请求示例：__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Password":"1441qfda" + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态，ok：成功，error：错误，exception：异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/新增账号.md b/mes/账号/新增账号.md new file mode 100644 index 0000000..36039fa --- /dev/null +++ b/mes/账号/新增账号.md @@ -0,0 +1,76 @@ +### 新增账号 +此接口用于给mes创建账号。 +此接口需要认证，详情请查看《认证方式》。 + +--- + +### 基本信息 +方法：POST +URL: http://localhost:8033/open/addUser + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名，仅小写，英文与数字 | +| Nick | String | 是 | 昵称 | +| Password | String | 是 | 密码 | +| IsActive | Bool | 是 | 是否启用 true:是｜false:否 | + +__请求示例：__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云", + "Password":"123456", + "IsActive":true + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态，ok：成功，error：错误，exception：异常 | +| data | object | 成功后返回具体内容 | + +__data:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/账号/用户信息列表.md b/mes/账号/用户信息列表.md new file mode 100644 index 0000000..272e06f --- /dev/null +++ b/mes/账号/用户信息列表.md @@ -0,0 +1,81 @@ +### 用户信息列表 +此接口用于查询mes的用户信息 +此接口需要认证，详情请查看《认证方式》。 + +--- + +### 基本信息 +方法：POST +URL: http://localhost:8033/open/userList + +--- + +### 请求 + +__请求参数__ + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | String | 是 | 厂区配置profile | +| UserName | String | 是 | 用户名，仅小写，英文与数字 | +| Nick | String | 是 | 昵称 | + +__请求示例：__ +``` + +{ + { + "data":{ + "profile": "测试", + "UserName":"0901001", + "Nick":"赵云" + } + } +} + +```` + +--- + +### 响应 +__响应字段__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| clock | string | 当前服务器时钟。 | +| status | string | 状态，ok：成功，error：错误，exception：异常 | +| data | object | 成功后返回具体内容 | + +__data.users:__ +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| userName | String | 用户名，仅小写，英文与数字 | +| nick | String | 昵称 | +| isActive | Bool | 是否启用 true:是｜false:否 | + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + "users":[ + { + "userName":"0901001", + "nick":"赵云", + "isActive":true + } + ] + } +} + +``` +__出现错误信息响应__ +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "error", + "message": "用户名已存在", + "data": {} +} +``` + + diff --git a/mes/选项/列出产品标签形式.md b/mes/选项/列出产品标签形式.md new file mode 100644 index 0000000..1893ab3 --- /dev/null +++ b/mes/选项/列出产品标签形式.md @@ -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": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出产品特征.md b/mes/选项/列出产品特征.md new file mode 100644 index 0000000..40296ea --- /dev/null +++ b/mes/选项/列出产品特征.md @@ -0,0 +1,74 @@ +### 列出产品特征下拉选项（ListFeatureCode） + +此接口用于获取列出产品特征下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListFeatureCode + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 产品特征选项模糊查询 | + +示例 1：模糊查询产品特征选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "P", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "P", + SourceDesc: "P" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出工艺类型.md b/mes/选项/列出工艺类型.md new file mode 100644 index 0000000..03807b7 --- /dev/null +++ b/mes/选项/列出工艺类型.md @@ -0,0 +1,74 @@ +### 列出工艺类型下拉选项（ListProcessType） + +此接口用于获取列出工艺类型下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListProcessType + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 工艺类型选项模糊查询 | + +示例 1：模糊查询工艺类型选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "双玻", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "双玻组件", + SourceDesc: "双玻组件" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出晶体类型.md b/mes/选项/列出晶体类型.md new file mode 100644 index 0000000..ddf95b4 --- /dev/null +++ b/mes/选项/列出晶体类型.md @@ -0,0 +1,74 @@ +### 列出晶体类型下拉选项（ListCrysType） + +此接口用于获取列出晶体类型下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListCrysType + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 晶体类型选项模糊查询 | + +示例 1：模糊查询晶体类型选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "单晶", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "M", + SourceDesc: "单晶" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出栅线类型.md b/mes/选项/列出栅线类型.md new file mode 100644 index 0000000..ad3d76d --- /dev/null +++ b/mes/选项/列出栅线类型.md @@ -0,0 +1,74 @@ +### 列出栅线类型下拉选项（ListBusBar） + +此接口用于获取列出栅线类型下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListBusBar + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 栅线类型选项模糊查询 | + +示例 1：模糊查询栅线类型选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "11BB", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "11BB", + SourceDesc: "11BB" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出电池片数量.md b/mes/选项/列出电池片数量.md new file mode 100644 index 0000000..534765b --- /dev/null +++ b/mes/选项/列出电池片数量.md @@ -0,0 +1,74 @@ +### 列出电池片数量下拉选项（ListCellQty） + +此接口用于获取列出电池片数量下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListCellQty + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 电池片数量选项模糊查询 | + +示例 1：模糊查询电池片数量选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "108", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "108", + SourceDesc: "108" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file diff --git a/mes/选项/列出组件规格.md b/mes/选项/列出组件规格.md new file mode 100644 index 0000000..6e4e069 --- /dev/null +++ b/mes/选项/列出组件规格.md @@ -0,0 +1,74 @@ +### 列出组件规格下拉选项（ListModSize） + +此接口用于获取列出组件规格下拉列表 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListModSize + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 组件规格选项模糊查询 | + +示例 1：模糊查询组件规格选项 + +``` +{ + "data": { + profile: "测试厂区", + search: "1728", + } +} +``` + + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| SourceId | string | id | +| SourceValue | string | 选项值 | +| SourceDesc | string | 选项描述 | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data":{ + list:[{ + SourceId: 1, + SourceValue: "1728*1134*30", + SourceDesc: "1728*1134*30" + }] + } +} +``` + +查询报错： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "exception", + "message": "查询错误", + "data": {} +} +``` \ No newline at end of file