编辑 | blame | 历史 | 原始文档

OQC检验单列表搜索功能 API 文档

接口概述

接口路径: /MesOqcItemsDetect02/getPage
请求方法: POST
功能描述: 获取OQC检验单分页数据,支持按物料编码、物料名称、创建人员进行搜索过滤

请求参数

基础参数(必需)

参数名 类型 必填 说明
pageIndex Number 页码,从1开始
limit Number 每页数据条数
createUser String 当前登录用户账号
result String 检验状态筛选:"未完成" 或 "已完成"

搜索参数(可选)

以下三个搜索参数互斥,只能使用其中一个:

参数名 类型 必填 说明
itemNo String 物料编码模糊搜索
itemName String 物料名称模糊搜索
createUser String 创建人员精确匹配(注意:此时会覆盖基础参数中的createUser)

请求示例

1. 基础查询(无搜索)

{
  "pageIndex": 1,
  "limit": 20,
  "createUser": "admin",
  "result": "未完成"
}

2. 按物料编码搜索

{
  "pageIndex": 1,
  "limit": 20,
  "createUser": "admin", 
  "result": "未完成",
  "itemNo": "MT001"
}

3. 按物料名称搜索

{
  "pageIndex": 1,
  "limit": 20,
  "createUser": "admin",
  "result": "已完成", 
  "itemName": "螺丝"
}

4. 按创建人员搜索

{
  "pageIndex": 1,
  "limit": 20,
  "createUser": "张三",
  "result": "未完成"
}

响应格式

成功响应

{
  "data": [
    {
      "id": "123456",
      "releaseNo": "OQC202412290001",
      "itemNo": "MT001",
      "itemName": "螺丝M6*20",
      "planQty": 100,
      "fcheckResu": "合格",
      "fsubmit": 1,
      "createDate": "2024-12-29 10:30:00",
      "createUser": "张三",
      "modify1By": "李四",
      "modify1Date": "2024-12-29 14:20:00",
      "fcheckUser": "王五"
    }
  ],
  "totalCount": 85
}

响应字段说明

字段名 类型 说明
data Array 检验单数据列表
totalCount Number 符合条件的总记录数

数据项字段说明

字段名 类型 说明
id String 检验单ID
releaseNo String 检验单号
itemNo String 物料编码
itemName String 物料名称
planQty Number 计划数量
fcheckResu String 检验结果:合格/不合格/未检验
fsubmit Number 提交状态:1-已提交,0-待提交
createDate String 创建时间
createUser String 创建人员
modify1By String 检验人员
modify1Date String 检验时间
fcheckUser String 送检人员

搜索逻辑说明

  1. 搜索触发: 前端用户在搜索框输入内容并确认时触发搜索
  2. 搜索类型: 用户可通过下拉选择搜索类型(物料编码/物料名称/创建人员)
  3. 搜索匹配:
  • 物料编码、物料名称支持模糊匹配
  • 创建人员支持精确匹配
  1. 分页重置: 执行搜索时页码重置为1
  2. 清空搜索: 用户点击清空按钮时移除所有搜索条件

错误处理

请求失败响应

{
  "success": false,
  "message": "请求失败原因",
  "code": "ERROR_CODE"
}

注意事项

  1. 搜索参数为空字符串时等同于不传该参数
  2. 创建人员搜索会覆盖基础查询中的createUser参数
  3. 建议后端对搜索关键词进行SQL注入防护
  4. 支持中文搜索,注意字符编码处理
  5. 分页参数pageIndex从1开始,不是从0开始

前端调用方式

前端通过以下方式调用:
javascript this.$post({ url: "/MesOqcItemsDetect02/getPage", data: requestData }).then(res => { // 处理返回数据 }).catch(error => { // 错误处理 });

---
文档版本: v1.0
更新时间: 2024年12月29日
维护人员: 前端开发团队