From 544e31806270acab49bade61ae4073478b5396e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=95=E6=88=90=E6=97=AD?= <1043274364@qq.com> Date: Mon, 26 Jun 2023 14:10:02 +0800 Subject: [PATCH] =?UTF-8?q?=E7=89=A9=E6=96=99=E6=8E=A5=E5=8F=A3=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- mes/物料/修改物料.md | 99 ++++++++++++++++++++++++ mes/物料/列出物料.md | 128 +++++++++++++++++++++++++++++++ mes/物料/列出物料类别.md | 90 ++++++++++++++++++++++ mes/物料/删除物料.md | 60 +++++++++++++++ mes/物料/查询物料详情.md | 112 +++++++++++++++++++++++++++ mes/物料/添加物料.md | 98 +++++++++++++++++++++++ 6 files changed, 587 insertions(+) create mode 100644 mes/物料/修改物料.md create mode 100644 mes/物料/列出物料.md create mode 100644 mes/物料/列出物料类别.md create mode 100644 mes/物料/删除物料.md create mode 100644 mes/物料/查询物料详情.md create mode 100644 mes/物料/添加物料.md diff --git a/mes/物料/修改物料.md b/mes/物料/修改物料.md new file mode 100644 index 0000000..0838d0e --- /dev/null +++ b/mes/物料/修改物料.md @@ -0,0 +1,99 @@ +### 修改物料（UpdateMaterial） + +此接口用于修改物料 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/UpdateMaterial + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| materialCode | string | 是 | 物料编码 | +| materialTypeCode | string | 是 | 物料类别代码 | +| descriptions | string | 否 | 物料描述 | +| attrs | Array | 否 | 物料属性 | +| flag | int | 否 | 数据状态：0禁用 1启用，默认1| + +attrs字段 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| materialCode | string | 是 | 物料编码 | +| materialTypeCode | string | 是 | 物料类别代码 | +| attrCode | string | 是 | 属性代码 | +| attrName | string | 否 | 属性名称 | +| value | string | 否 | 物料属性值 | +| valueCode | string | 否 | 物料属性值代码 | +| flag | int | 否 | 数据状态：0禁用 1启用，默认1 | + +示例 1：修改电池片及物料属性值 + +``` +{ + "data": { + profile:"测试厂区", + materialCode:"CELL001", + materialTypeCode:"CELL", + descriptions:"电池片描述", + flag:1, + attrs:[ + { + materialCode:"CELL001", + materialTypeCode:"CELL", + attrCode:"crys_type", + attrName:"晶体结构", + value:"单晶", + valueCode:"单晶", + flag:1 + }, + { + materialCode:"CELL001", + materialTypeCode:"CELL", + attrCode:"cell_uop", + attrName:"单片功率", + value:"7.82", + valueCode:"7.82", + flag:1 + } + ], + } +} +``` + +--- + +### 响应 + + + +执行成功时，响应如下： + +``` +{ + "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..8bbc78d --- /dev/null +++ b/mes/物料/列出物料.md @@ -0,0 +1,128 @@ +### 列出物料（ListMaterial） + +此接口用于获取物料列表，搜索物料 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListMaterial + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| search | string | 否 | 物料编码物料描述模糊查询 | +| type| string | 否 | 传递物料类型code | + +示例 1：模糊查询玻璃主材 + +``` +{ + "data": { + profile:"测试厂区", + search: "玻璃", + type: "" + } +} +``` + +示例 2：根据物料类别查询玻璃主材 + +``` +{ + "data": { + profile:"测试厂区", + search: "", + type: "GLASS" + } +} +``` + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| materialCode | string | 物料编码 | +| materialTypeCode | string | 物料类别代码 | +| materialTypeDesc | string | 物料类别名称 | +| descriptions | string | 物料描述 | +| flag | int | 数据状态：0禁用 1启用 | +| createTime | string | 创建时间 | +| attrs | Array | 物料属性 | + +attrs字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| materialCode | string | 物料编码 | +| materialTypeCode | string | 物料类别代码 | +| materialTypeDesc | string | 物料类别名称 | +| attrCode | string | 属性代码 | +| attrName | string | 属性名称 | +| value | string | 物料属性值 | +| valueCode | string | 物料属性值代码 | +| flag | int | 数据状态：0禁用 1启用 | + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": [ + { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + descriptions:"电池片描述", + flag:1, + createTime:"2023-04-09 18:10:01", + attrs:[ + { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + attrCode:"crys_type", + attrName:"晶体结构", + value:"单晶", + valueCode:"单晶", + flag:1 + }, + { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + attrCode:"cell_uop", + attrName:"单片功率", + value:"7.82", + valueCode:"7.82", + flag:1 + } + ], + } + ] +} +``` + +查询报错： + +``` +{ + "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..f72087b --- /dev/null +++ b/mes/物料/列出物料类别.md @@ -0,0 +1,90 @@ +### 列出物料类别（ListMaterialType） + +此接口用于获取物料列表，搜索物料 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/ListMaterialType + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| search | string | 否 | 物料类型模糊查询 | + +示例 1：模糊查询玻璃 + +``` +{ + "data": { + profile:"测试厂区", + search: "电池", + } +} +``` + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| profile | string | 厂区代码 | +| materialTypeCode | string | 物料类别代码 | +| materialTypeDesc | string | 物料类别名称 | +| unit | string | 单位 | +| flag | int | 数据状态：0禁用 1启用 | +| ManagerType | string | 创建时间 | +| Sort | int | 序号 | +| ErpCode | string | | + + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": [ + { + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + unit:"pcs", + flag:1, + ManagerType:"Photovoltaic", + Sort:1, + ErpCode:"", + }, + { + materialTypeCode:"EVA", + materialTypeDesc:"EVA", + unit:"m2", + flag:1, + ManagerType:"Photovoltaic", + Sort:2, + ErpCode:"", + } + ] +} +``` + +查询报错： + +``` +{ + "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..54196dc --- /dev/null +++ b/mes/物料/删除物料.md @@ -0,0 +1,60 @@ +### 删除物料（DeleteMaterial） + +此接口用于删除物料 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/DeleteMaterial + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| materialCode | string | 否 | 物料编码 | + +示例 1：删除电池片及物料属性值 + +``` +{ + "data": { + profile:"测试厂区", + materialCode:"CELL001", + } +} +``` + +--- + +### 响应 + + + +执行成功时，响应如下： + +``` +{ + "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..fbb5858 --- /dev/null +++ b/mes/物料/查询物料详情.md @@ -0,0 +1,112 @@ +### 查询物料详情（QueryMaterial） + +此接口用于查询物料详情 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/QueryMaterial + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| materialCode | string | 否 | 物料编码 | + +示例 1：删除电池片及物料属性值 + +``` +{ + "data": { + profile:"测试厂区", + materialCode:"CELL001", + } +} +``` + +--- + +### 响应 + +响应字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| materialCode | string | 物料编码 | +| materialTypeCode | string | 物料类别代码 | +| materialTypeDesc | string | 物料类别名称 | +| descriptions | string | 物料描述 | +| flag | int | 数据状态：0禁用 1启用 | +| createTime | string | 创建时间 | +| attrs | Array | 物料属性 | + +attrs字段 + +| 字段 | 类型 | 说明 | +| :-- | :-- | :-- | +| materialCode | string | 物料编码 | +| materialTypeCode | string | 物料类别代码 | +| materialTypeDesc | string | 物料类别名称 | +| attrCode | string | 属性代码 | +| attrName | string | 属性名称 | +| value | string | 物料属性值 | +| valueCode | string | 物料属性值代码 | +| flag | int | 数据状态：0禁用 1启用 | + +查询成功时，响应如下： + +``` +{ + "clock": "2023-06-25 20:00:00.000", + "status": "ok", + "data": { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + descriptions:"电池片描述", + flag:1, + createTime:"2023-04-09 18:10:01", + attrs:[ + { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + attrCode:"crys_type", + attrName:"晶体结构", + value:"单晶", + valueCode:"单晶", + flag:1 + }, + { + materialCode:"CELL001", + materialTypeCode:"CELL", + materialTypeDesc:"电池片", + attrCode:"cell_uop", + attrName:"单片功率", + value:"7.82", + valueCode:"7.82", + flag:1 + } + ], + } +} +``` + +查询报错： + +``` +{ + "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..16fc9ab --- /dev/null +++ b/mes/物料/添加物料.md @@ -0,0 +1,98 @@ +### 添加物料（AddMaterial） + +此接口用于添加物料 + +--- + +### 基本信息 + +方法：POST + +URL: http://localhost:8033/open/AddMaterial + +--- + +### 请求 + +请求参数 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| profile | string | 是 | 厂区代码 | +| materialCode | string | 是 | 物料编码 | +| materialTypeCode | string | 是 | 物料类别代码 | +| descriptions | string | 否 | 物料描述 | +| attrs | Array | 否 | 物料属性 | +| flag | int | 否 | 数据状态：0禁用 1启用，默认1| + +attrs字段 + +| 参数名 | 类型 | 必填 | 说明 | +| :-- | :-- | :-- | :-- | +| materialCode | string | 是 | 物料编码 | +| materialTypeCode | string | 是 | 物料类别代码 | +| attrCode | string | 是 | 属性代码 | +| attrName | string | 否 | 属性名称 | +| value | string | 否 | 物料属性值 | +| valueCode | string | 否 | 物料属性值代码 | +| flag | int | 否 | 数据状态：0禁用 1启用，默认1 | + +示例 1：添加电池片及物料属性值 + +``` +{ + "data": { + profile:"测试厂区", + materialCode:"CELL001", + materialTypeCode:"CELL", + descriptions:"电池片描述", + flag:1, + attrs:[ + { + materialCode:"CELL001", + materialTypeCode:"CELL", + attrCode:"crys_type", + attrName:"晶体结构", + value:"单晶", + valueCode:"单晶", + flag:1 + }, + { + materialCode:"CELL001", + materialTypeCode:"CELL", + attrCode:"cell_uop", + attrName:"单片功率", + value:"7.82", + valueCode:"7.82", + flag:1 + } + ], + } +} +``` + +--- + +### 响应 + + +执行成功时，响应如下： + +``` +{ + "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