C300-OpenAPI
  1. API
C300-OpenAPI
  • 使用指南
    • 快速开始(API & 事件订阅)
    • API 参考
    • 事件订阅参考
    • Webwidget使用说明
    • 认证 API
      • 创建 Token
      • 刷新 Token
    • 制造域 MFR
      • 基础数据
        • BOM
          • API
            • 创建 BOM
            • 删除 BOM
            • 更新 BOM
            • 查询 BOM
          • 事件
            • BOM 创建
            • BOM 删除
            • BOM 更新
            • BOM 审核通过
            • BOM 审核驳回
        • 标准工序
          • API
            • 更新标准工序
            • 查询工序
            • 分批查询工序
            • 创建标准工序
            • 删除标准工序
          • 事件
            • 标准工序创建
            • 标准工序删除
            • 标准工序更新
        • 工艺路线
          • API
            • 删除工艺路线
            • 创建工艺路线
            • 更新工艺路线
            • 上传工艺路线图纸信息
            • 查询工艺路线
          • 事件
            • 工艺路线创建
            • 工艺路线删除
            • 工艺路线更新
        • 生产小组
          • API
            • 查询小组
            • 创建生产小组
            • 分批查询小组
            • 更新生产小组
          • 事件
        • 工作中心
          • API
            • 创建工作中心
            • 删除工作中心
            • 更新工作中心
            • 查询工作中心
            • 分批查询工作中心
          • 事件
        • 生产流程
          • API
          • 事件
            • 生产流程创建
            • 生产流程删除
            • 生产流程更新
      • 生产单
        • API
          • ButlerController
            • 更新访客信息
          • 更新生产单
          • 创建生产单
          • 批量删除生产单
          • 查询计划用料
          • 分批查询计划用料
          • 查询生产单工序
          • 修改计划用料
          • 完成生产单
          • 作废生产单
          • 查询生产单
          • 分批查询生产单
          • 创建序列号
        • 事件
          • 生产单创建
          • 生产单删除
          • 生产单更新
          • 生产单作废
          • 生产单完成
          • 生产单审核通过
          • 生产单审核驳回
          • 生产单重审
          • 生产计划用料更新
          • 生产计划用料添加
          • 生产计划用料删除
          • 生产单计划排程
          • 生产单派发
          • 生产单工序派发
          • 生产单加入计划
      • 生产任务单
        • 事件
          • 生产任务流转
        • 查询生产任务单
        • 分批查询生产任务单
      • 生产领料单
        • API
          • 创建申请领料单
        • 事件
      • 生产备料出库任务
        • API
          • 更新生产备料出库任务
          • 查询生产备料出库任务
        • 事件
          • 生产备料出库任务创建
          • 生产备料出库任务删除
          • 生产备料出库任务更新
          • 生产备料出库任务审核通过
          • 生产备料出库任务审核驳回
          • 生产备料出库任务完成
      • 生产领料出库任务
        • API
          • 更新生产领料出库任务
        • 事件
      • 生产补料出库任务
        • API
          • 更新生产补料出库任务
        • 事件
      • 生产还料入库任务
        • API
          • 更新生产还料入库任务
          • 查询生产还料入库任务
        • 事件
          • 生产还料入库任务创建
          • 生产还料入库任务删除
          • 生产还料入库任务更新
          • 生产还料入库任务审核通过
          • 生产还料入库任务审核驳回
          • 生产还料入库任务完成
      • 生产入库任务
        • API
          • 查询生产入库任务
          • 更新生产入库任务
        • 事件
          • 生产入库任务创建
          • 生产入库任务删除
          • 生产入库任务更新
          • 生产入库任务完成
      • 生产报废入库任务
        • API
          • 更新生产报废入库任务
          • 完成生产报废入库任务
          • 查询报废入库
          • 分批查询报废入库
        • 事件
          • 生产报废入库任务创建
          • 生产报废入库任务删除
          • 生产报废入库任务更新
          • 生产报废入库任务完成
      • 生产报工记录
        • API
          • 删除生产报工记录
          • 创建生产报工记录
          • 查询报工记录
          • 分批查询报工记录
        • 事件
          • 生产报工记录创建
          • 生产报工记录删除
          • 生产报工记录更新
      • 委外管理
        • 委外采购单
          • API
            • 创建委外采购单
            • 更新委外采购单审核状态
            • 更新委外采购单
            • 查询委外采购单行
            • 分批查询委外采购单行
          • 事件
            • 委外采购单创建
            • 委外采购单删除
            • 委外采购单更新
            • 委外采购单审核通过
            • 委外采购单审核驳回
            • 委外采购单完成
            • 委外采购单作废
        • 委外收料单
          • API
            • 创建委外收料单
            • 创建并自动完成委外收料单
          • 事件
            • 委外收料单创建
            • 委外收料单删除
            • 委外收料单更新
            • 委外收料单审核通过
            • 委外收料单审核驳回
            • 委外收料单完成
            • 委外收料单作废
        • 委外备料出库任务
          • API
            • 更新委外备料出库任务
            • 确认委外备料出库任务
          • 事件
            • 委外备料出库任务创建
            • 委外备料出库任务删除
            • 委外备料出库任务更新
            • 委外备料出库任务完成
            • 委外备料出库任务作废
        • 委外入库任务
          • API
            • 更新委外入库任务
          • 事件
            • 生产委外入库任务创建
            • 生产委外入库任务删除
            • 生产委外入库任务更新
            • 生产委外入库任务完成
            • 生产委外入库任务作废
            • 库存委外入库任务创建
            • 库存委外入库任务删除
            • 库存委外入库任务更新
            • 库存委外入库任务完成
            • 库存委外入库任务作废
    • 质量域QLTY
      • 生产检验任务
        • 事件
          • 生产检验任务创建
          • 生产检验任务删除
          • 生产检验任务更新
      • 生产检验报工记录
        • API
          • 创建生产检验报工记录
          • 删除生产检验报工记录
          • 作废生产检验报工记录
          • 查询检验记录
          • 分批查询检验记录
          • 查询检验记录行
          • 分批查询检验记录行
        • 事件
          • 生产检验报工记录创建
          • 生产检验报工记录删除
          • 生产检验报工记录更新
      • 生产检验待处理不合格品单
        • 事件
          • 生产检验待处理不合格品单创建
          • 生产检验待处理不合格品单作废
      • 生产检验不合格品处理单
        • 事件
          • 生产检验不合格品处理单创建
          • 生产检验不合格品处理单删除
          • 生产检验不合格品处理单更新
          • 生产检验不合格品处理单审核通过
          • 生产检验不合格品处理单审核驳回
          • 生产检验不合格品处理单完成
          • 生产检验不合格品处理单作废
      • 收料待报检任务
        • 事件
          • 收料待报检任务创建
          • 收料待报检任务更新
          • 收料待报检任务作废
      • 收料检验单
        • API
          • 创建收料检验单
          • 作废收料检验单
          • 删除收料检验单
          • 更新收料检验单审核状态
        • 事件
      • 收料检验报工记录
        • 事件
          • 收料检验报工记录创建
          • 收料检验报工记录删除
      • 收料检待处理不合格品单
        • 事件
          • 收料检待处理不合格品单创建
          • 收料检待处理不合格品单作废
      • 收料检验不合格品处理单
        • 事件
          • 收料检验不合格品处理单创建
          • 收料检验不合格品处理单删除
          • 收料检验不合格品处理单更新
          • 收料检验不合格品处理单审核通过
          • 收料检验不合格品处理单审核驳回
          • 收料检验不合格品处理单完成
          • 收料检验不合格品处理单作废
      • 收料放行单
        • 事件
          • 收料放行单创建
          • 收料放行单删除
          • 收料放行单更新
          • 收料放行单审核通过
          • 收料放行单审核驳回
          • 收料放行单完成
          • 收料放行单作废
      • 收料检验库存申请单
        • 事件
          • 收料检验库存申请单创建
          • 收料检验库存申请单删除
          • 收料检验库存申请单更新
          • 收料检验库存申请单审核通过
          • 收料检验库存申请单审核驳回
          • 收料检验库存申请单完成
          • 收料检验库存申请单作废
      • 库存检验单
        • 事件
          • 库存检验单创建
          • 库存检验单删除
          • 库存检验单更新
          • 库存检验单审核通过
          • 库存检验单审核驳回
          • 库存检验单完成
          • 库存检验单作废
      • 库存检验不合格品处理单
        • 事件
          • 库存检验不合格品处理单创建
          • 库存检验不合格品处理单删除
          • 库存检验不合格品处理单更新
          • 库存检验不合格品处理单审核通过
          • 库存检验不合格品处理单审核驳回
          • 库存检验不合格品处理单完成
          • 库存检验不合格品处理单作废
    • 计划域PLN
      • 生产单计划
        • 事件
          • 生产单计划确认
      • 车间计划
        • 事件
          • 车间计划派发
          • 当前排产编辑
    • 供应链域 SC
      • 基础数据
        • 客户
          • API
            • 创建客户
            • 删除客户
            • 更新客户
            • 查询客户列表
            • 启用客户
            • 禁用客户
            • 查询客户分类列表
            • 查询企业地址
          • 事件
            • 客户创建
            • 客户删除
            • 客户更新
            • 客户禁用
            • 客户启用
            • 客户审核通过
            • 客户审核驳回
        • 客户分类
          • API
            • 创建客户分类
            • 删除客户分类
            • 更新客户分类
            • 查询客户分类列表
          • 事件
            • 客户分类创建
            • 客户分类删除
            • 客户分类更新
        • 供应商
          • API
            • 禁用供应商
            • 启用供应商
            • 创建供应商
            • 删除供应商
            • 查询供应商
            • 更新供应商
            • 分批查询供应商
          • 事件
            • 供应商创建
            • 供应商删除
            • 供应商更新
            • 供应商禁用
            • 供应商启用
            • 供应商审核通过
            • 供应商审核驳回
        • 供应商分类
          • API
            • 创建供应商分类
            • 删除供应商分类
            • 更新供应商分类
            • 查询供应商分类
            • 分批查询供应商分类
          • 事件
            • 供应商分类创建
            • 供应商分类删除
            • 供应商分类更新
        • 销售价目表
          • API
          • 事件
            • 销售价目表创建
            • 销售价目表删除
            • 销售价目表更新
            • 销售价目表审核通过
            • 销售价目表审核驳回
        • 采购价目表
          • API
          • 事件
            • 采购价目表创建
            • 采购价目表删除
            • 采购价目表更新
            • 采购价目表审核通过
            • 采购价目表审核驳回
        • 企业地址
          • API
            • 创建企业地址
            • 删除企业地址
            • 更新企业地址
            • 查询企业地址
          • 事件
      • 销售管理
        • 销售订单
          • API
            • 创建销售订单
            • 删除销售订单
            • 更新销售订单
            • 作废销售订单
            • 查询销售订单
            • 更新销售订单审核状态
            • 查询订单
          • 事件
            • 销售订单创建
            • 销售订单删除
            • 销售订单更新
            • 销售订单审核通过
            • 销售订单审核驳回
            • 销售订单完成
            • 销售订单作废
            • 销售订单加入计划
        • 发货单
          • API
            • 创建发货单
            • 删除发货单
            • 更新发货单
            • 作废发货单
            • 查询发货列表
          • 事件
            • 发货单创建
            • 发货单删除
            • 发货单更新
            • 发货单审核通过
            • 发货单审核驳回
            • 发货单完成
            • 发货单作废
        • 退货单
          • API
            • 创建退货单
            • 作废并删除退货单
          • 事件
            • 退货单创建
            • 退货单删除
            • 退货单更新
            • 退货单审核通过
            • 退货单审核驳回
            • 退货单完成
            • 退货单作废
        • 销售出库任务
          • API
            • 确认销售发货出库任务
          • 事件
            • 销售出库任务创建
            • 销售出库任务删除
            • 销售出库任务更新
            • 销售出库任务完成
            • 销售出库任务作废
        • 销售退货入库任务
          • API
            • 更新销售退货入库任务
          • 事件
            • 销售退货入库任务创建
            • 销售退货入库任务删除
            • 销售退货入库任务更新
            • 销售退货入库任务完成
            • 销售退货入库任务作废
      • 采购管理
        • 采购申请单
          • API
            • 查询采购申请列表
            • 新建采购申请
            • 编辑采购申请
            • 删除采购申请
          • 事件
            • 采购申请单作废
            • 采购申请单创建
            • 采购申请单更新
            • 采购申请单删除
            • 采购申请单审核驳回
            • 采购申请单审核通过
            • 采购申请单完成
        • 采购订单
          • API
            • 创建采购订单
            • 删除采购订单
            • 更新采购订单
            • 查询采购订单
            • 作废采购订单
            • 审核采购订单
            • 获取采购单分享链接
          • 事件
            • 采购订单创建
            • 采购订单删除
            • 采购订单更新
            • 采购订单作废
            • 采购订单审核通过
            • 采购订单审核驳回
            • 采购订单完成
        • 采购收料单
          • API
            • 创建采购收料单
            • 删除采购收料单
            • 修改采购收料单
            • 查询采购收料单
            • 作废采购收料单
          • 事件
            • 采购收料单创建
            • 采购收料单删除
            • 采购收料单更新
            • 采购收料单作废
            • 采购收料单审核通过
            • 采购收料单审核驳回
            • 采购收料单完成
        • 采购退料单
          • API
            • 作废采购退料出库任务
            • 删除采购退料出库任务
          • 事件
            • 采购退料单删除
            • 采购退料单创建
            • 采购退料单更新
            • 采购退料单审核驳回
            • 采购退料单审核通过
            • 采购退料单完成
            • 采购退料单作废
        • 采购入库任务
          • API
            • 更新采购入库任务
            • 撤销采购入库任务
          • 事件
            • 采购入库任务创建
            • 采购入库任务删除
            • 采购入库任务更新
            • 采购入库任务完成
            • 采购入库任务作废
            • 采购检验完入库任务创建
            • 采购检验完入库任务更新
            • 采购检验完入库任务完成
            • 采购检验完入库任务作废
        • 采购退料出库任务
          • API
            • 创建采购退料出库任务
            • 创建并自动完成采购退料出库任务
          • 事件
    • 厂内物流域 LOG
      • 库存任务
        • 查询还料入库任务
        • 查询备料任务
        • 确认生产入库任务
        • 确认备料出库任务
        • 确认领料出库任务
        • 确认补料出库任务
        • 创建领料申请
        • 确认还料入库任务
        • 确认生成报废任务
        • 确认库存申请入库任务
        • 确认库存申请出库任务
        • 确认移库任务
        • 确认销售发货出库任务
        • 确认销售退货入库任务
        • 完成报废入库
        • 确认生产委外入库
        • 查询生产入库任务
      • 基础数据
        • 物料
          • API
            • 删除物料单位
            • 分页物料查询
            • 创建物料
            • 创建物料单位
            • 更新物料单位
            • 更新物料
            • 批量创建物料
            • 删除物料
            • 启用物料
            • 禁用物料
            • 更新物料审核状态
            • 上传物料图纸
            • 分页查询查询物料列表
          • 事件
            • 物料创建
            • 物料删除
            • 物料更新
            • 物料审核通过
            • 物料审核驳回
            • 物料重审
            • 物料启用
            • 物料禁用
        • 物料分类
          • API
            • 删除物料分类
            • 创建物料分类
            • 更新物料分类
            • 查询物料分类
            • 分批查询物料分类
          • 事件
            • 物料分类创建
            • 物料分类删除
            • 物料分类更新
        • 单位
          • API
            • 查询单位
            • 分批查询单位
          • 事件
            • 单位创建
            • 单位删除
            • 单位更新
        • 规格
          • API
            • 删除规格
            • 创建规格
            • 更新规格
            • 查询规格
            • 分批查询规格
          • 事件
        • 仓库
          • API
            • 创建仓库
            • 删除仓库
            • 更新仓库
            • 查询仓库
            • 分批查询仓库
          • 事件
            • 仓库创建
            • 仓库删除
            • 仓库更新
            • 仓库启用
            • 仓库禁用
        • 库位
          • API
            • 创建库位
            • 查询库位
            • 分批查询库位
          • 事件
            • 库位创建
            • 库位删除
            • 库位更新
            • 默认库位设置
      • 库存申请单
        • API
          • 删除入库申请
          • 创建出库申请单
          • 创建移库申请单
          • 作废出库申请
          • 创建入库申请单
          • 作废入库申请
          • 删除出库申请
          • 创建并自动完成出库申请单
          • 创建并自动完成移库申请单
          • 查询出库申请单
          • 创建并自动完成入库申请单
          • 查询入库申请单
        • 事件
          • 申请出库单创建
          • 申请出库单删除
          • 申请出库单更新
          • 申请出库单审核通过
          • 申请出库单审核驳回
          • 申请出库单完成
          • 申请出库单作废
          • 申请入库单创建
          • 申请入库单删除
          • 申请入库单更新
          • 申请入库单审核通过
          • 申请入库单审核驳回
          • 申请入库单完成
          • 申请入库单作废
          • 申请移库单创建
          • 申请移库单删除
          • 申请移库单更新
          • 申请移库单审核通过
          • 申请移库单审核驳回
          • 申请移库单完成
          • 申请移库单作废
      • 申请出库任务
        • API
          • 更新申请出库任务
          • 查询出库申请列表
        • 事件
          • 申请出库任务创建
          • 申请出库任务删除
          • 申请出库任务更新
          • 申请出库任务完成
          • 申请出库任务作废
      • 申请入库任务
        • API
          • 更新申请入库任务
          • 查询入库申请列表
        • 事件
          • 申请入库任务创建
          • 申请入库任务删除
          • 申请入库任务更新
          • 申请入库任务完成
          • 申请入库任务作废
      • 直接移库任务
        • API
          • 移库出入库记录
          • 更新移库任务
        • 事件
          • 申请移库任务创建
          • 申请移库任务删除
          • 申请移库任务更新
          • 申请移库任务完成
          • 申请移库任务作废
      • 物料库存
        • API
          • 查询物料可用库存明细记录
          • 【删除】查询物料库存数量
          • 查询物料库存明细信息
          • 查询物料可用库存明细记录
          • 查询物料库存明细信息
        • 事件
      • 组装拆卸单
        • API
          • 查询组装拆卸单
        • 事件
          • 组装单创建
          • 组装单删除
          • 组装单更新
          • 组装单审核通过
          • 组装单审核驳回
          • 组装单完成
          • 组装单作废
          • 拆卸单创建
          • 拆卸单删除
          • 拆卸单更新
          • 拆卸单审核通过
          • 拆卸单审核驳回
          • 拆卸单完成
          • 拆卸单作废
      • 出入库记录
        • 事件
          • 出入库记录创建
          • 出入库记录撤销
    • 设备域EQUIP
      • 基础数据
        • 设备
          • API
            • 创建设备
            • 更新设备
            • 删除设备
            • 查询设备
          • 事件
            • 设备创建
            • 设备删除
            • 设备更新
            • 设备分类创建
            • 设备分类删除
            • 设备分类更新
      • IOT对接
        • 对接设备数据
    • 3Chat域
      • 智能体(Agent)
        • API
          • 发送消息
        • 事件
      • 渠道(Channel)
        • API
          • 发送消息
        • 事件
      • 流程(Flow)
        • API
          • Coze
      • 会话(Dialog)
        • API
          • 查询
        • 事件
          • 创建会话
      • 访客(Visitor)
        • API
          • 查询
          • 更新
        • 事件
          • 创建访客
          • 更新访客
      • 对话(Conversation)
        • API
          • 主动转人工服务
          • 查询
        • 事件
          • 创建对话
          • 更新对话
          • 再次加入对话
          • 转人工
    • 用户与租户域 USER
      • 员工
        • API
          • 创建员工
          • 更新员工
        • 事件
          • 员工创建
          • 员工删除
          • 员工更新
          • 员工启用
          • 员工禁用
          • 部门创建
          • 部门删除
          • 部门更新
      • 部门
        • API
          • 创建部门
          • 更新部门
        • 事件
    • 基础域DM
      • 文件管理
        • API
          • 上传文件
        • 事件
      • 低代码平台CPS
        • API
          • 查询表单详情
            POST
          • 查询表单列表
            POST
          • 保存或更新表单
            POST
          • 删除表单
            POST
      • 开发平台
        • API
          • 更新事件日志状态
    • 采购申请
  • 客户案例
    • 集成案例
      • MES与畅捷通T+无缝集成,破解业财数据割离难题
  1. API

查询表单列表

POST
/api/public/metadata-app/v2/data/query/search

类似于search_count功能,很遗憾目前并未提供专用的接口用于查数量,不过你可以巧妙利用搜索接口实现你想要的功能。

1. 与数据搜索一样,根据你设置的条件查总数量。返回结果中recordsTotal的值为查询的总条数。
2. 参数调整:除了指定的搜索条件外,设置以下参数可以提高接口查询性能(可选)。
设置start = 0,length = 1,这样就会只查一条数据,减少不必要的数据返回。
设置raw = true,查原始数据,关联对象属性值不填充,加快查询速度。

请求参数

Header 参数

Body 参数application/json

示例
{
    "body": {
        "start": 0,
        "length": 20,
        "sorts": [
            {
                "property": "code", // 排序字段apiName
                "direction": "DESC", // 排序方式,DESC或ASC
                "scope": "VALUE" // 排序字段的作用域,目前仅支持VALUE
            }
        ],
        "templateApiName": "template_lwyhT",
        "filter": {
            "field_RCoX9__c": 100,
            "field_ICxU8__c": "abc" // 如果多条件精确匹配,该字段可以传数组,例如:["abc","edg","xyz"]
        },
        "condition": {
            "columnType": "VALUE", // 列类型
            "dataApiName": "object_SRvLd__c", // 实体ApiName
            "fieldApiName": "field_RCoX9__c", // 实体字段ApiName
            "dataType": "NUM", // 字段类型
            "keyword": "EQ", // 关键字
            "params": [
                100
            ], // 条件值
        },
        "fields": [
            "code",
            "field_RCoX9__c",
            "field_ICxU8__c"
        ],
        "dataIds": [
            "6391c806b463873cf8f068cb",
            "6391bab134ca192519668f4a"
        ],
        "fuzzy": false, // 是否模糊匹配,默认false
        "raw": false, // 是否查原始数据,默认false
        "print": false, // 是否以打印格式返回,默认false
        "authority": {
            "enabled": true, // 是否启用权限条件,默认为true
            "returnType": "EXCEPTION" // 无权限时返回类型,默认为抛出异常,也可用EMPTY返回空集合
        },
        "conditionalFilter": { // ConditionBO过滤条件
            "filter": { // 表单字段过滤条件
                "template_lwyhT": {
                    "field_RCoX9__c": 100
                }
            },
            "conditionDefinition": {
                "nodes": [
                    {
                        "dataSourceType": "VARIABLE",
                        "leftFieldTemplateId": 41535,
                        "leftFieldTemplateName": "一一",
                        "leftFieldTemplateApiName": "template_xrQj9",
                        "leftFieldId": 284529,
                        "leftFieldApiName": "field_bYXeY__c",
                        "leftFieldName": "日期",
                        "conditionType": "EQ",
                        "rightShowInfo": "今日",
                        "rightConstant": "TODAY",
                        "leftParentheses": "(",
                        "rightParentheses": ")"
                    },
                    {
                        "dataSourceType": "CONSTANT",
                        "leftFieldTemplateId": 41535,
                        "leftFieldTemplateName": "一一",
                        "leftFieldTemplateApiName": "template_xrQj9",
                        "leftFieldId": 284530,
                        "leftFieldApiName": "field_Nf6D9__c",
                        "leftFieldName": "单选",
                        "conditionType": "IS_NOT_NULL",
                        "rightShowInfo": "",
                        "leftParentheses": "(",
                        "rightParentheses": ")"
                    }
                ],
                "logics": [
                    "OR",
                    "OR"
                ],
                "joinTable": { // 连表查询参数,非必须
                    "joinTemplateApiName": "template_sApnS",
                    "joinTemplateFieldApiName": "field_zxACW__c"
                }
            },
            "fuzzy": false // 是否模糊匹配,默认false
        },
        "workflow": { // 流程参数,目前给Web端用,查看指定TAB数据
            "tab": "ALL",
            "staffId": 10040412
        },
        "parent": {
            "templateApiName": "template_JHEHl", // 父表单ApiName
            "parentIds": [
                "6391b560c5b14224b45be375"
            ] // 父数据ID
        },
        "join": {
            "joinTables": { // 连表信息
                "template_Z6F5g": { // 表单ApiName
                    "filter": { // 过滤条件
                        "code": "00000001",
                    },
                    "fields": [
                        "code",
                        "field_xxxx"
                    ], // 查询字段,可为空,默认查所有字段
                    "sorts": [ // 排序,可为空,为空按照子表id降序排列
                        {
                            "property": "code", // 排序字段apiName
                            "direction": "DESC", // 排序方式,DESC或ASC
                            "scope": "VALUE" // 排序字段的作用域,目前仅支持VALUE
                        }
                    ]
                },
                "template_O70cG": {
                    "filter": {
                        "code": [
                            "00000001",
                            "00000002"
                        ]
                    },
                    "fields": []
                },
            },
            "flat": false, // 数据是否平铺,默认不平铺
        },
        "associate": { // 关联列表查询参数
            "templateApiName": "template_JHEHl", // 表单ApiName
            "dataIds": [
                "00000000000"
            ] // 数据id
        },
        "defaultSort": {
            "enabled": false, // 是否开启,默认关闭。
            "view": "ALL" // 视图名称,与工作流参数tab一致
        }
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/public/metadata-app/v2/data/query/search' \
--header 'Cookie;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": {
        "start": 0,
        "length": 20,
        "sorts": [
            {
                "property": "code", // 排序字段apiName
                "direction": "DESC", // 排序方式,DESC或ASC
                "scope": "VALUE" // 排序字段的作用域,目前仅支持VALUE
            }
        ],
        "templateApiName": "template_lwyhT",
        "filter": {
            "field_RCoX9__c": 100,
            "field_ICxU8__c": "abc" // 如果多条件精确匹配,该字段可以传数组,例如:["abc","edg","xyz"]
        },
        "condition": {
            "columnType": "VALUE", // 列类型
            "dataApiName": "object_SRvLd__c", // 实体ApiName
            "fieldApiName": "field_RCoX9__c", // 实体字段ApiName
            "dataType": "NUM", // 字段类型
            "keyword": "EQ", // 关键字
            "params": [
                100
            ], // 条件值
        },
        "fields": [
            "code",
            "field_RCoX9__c",
            "field_ICxU8__c"
        ],
        "dataIds": [
            "6391c806b463873cf8f068cb",
            "6391bab134ca192519668f4a"
        ],
        "fuzzy": false, // 是否模糊匹配,默认false
        "raw": false, // 是否查原始数据,默认false
        "print": false, // 是否以打印格式返回,默认false
        "authority": {
            "enabled": true, // 是否启用权限条件,默认为true
            "returnType": "EXCEPTION" // 无权限时返回类型,默认为抛出异常,也可用EMPTY返回空集合
        },
        "conditionalFilter": { // ConditionBO过滤条件
            "filter": { // 表单字段过滤条件
                "template_lwyhT": {
                    "field_RCoX9__c": 100
                }
            },
            "conditionDefinition": {
                "nodes": [
                    {
                        "dataSourceType": "VARIABLE",
                        "leftFieldTemplateId": 41535,
                        "leftFieldTemplateName": "一一",
                        "leftFieldTemplateApiName": "template_xrQj9",
                        "leftFieldId": 284529,
                        "leftFieldApiName": "field_bYXeY__c",
                        "leftFieldName": "日期",
                        "conditionType": "EQ",
                        "rightShowInfo": "今日",
                        "rightConstant": "TODAY",
                        "leftParentheses": "(",
                        "rightParentheses": ")"
                    },
                    {
                        "dataSourceType": "CONSTANT",
                        "leftFieldTemplateId": 41535,
                        "leftFieldTemplateName": "一一",
                        "leftFieldTemplateApiName": "template_xrQj9",
                        "leftFieldId": 284530,
                        "leftFieldApiName": "field_Nf6D9__c",
                        "leftFieldName": "单选",
                        "conditionType": "IS_NOT_NULL",
                        "rightShowInfo": "",
                        "leftParentheses": "(",
                        "rightParentheses": ")"
                    }
                ],
                "logics": [
                    "OR",
                    "OR"
                ],
                "joinTable": { // 连表查询参数,非必须
                    "joinTemplateApiName": "template_sApnS",
                    "joinTemplateFieldApiName": "field_zxACW__c"
                }
            },
            "fuzzy": false // 是否模糊匹配,默认false
        },
        "workflow": { // 流程参数,目前给Web端用,查看指定TAB数据
            "tab": "ALL",
            "staffId": 10040412
        },
        "parent": {
            "templateApiName": "template_JHEHl", // 父表单ApiName
            "parentIds": [
                "6391b560c5b14224b45be375"
            ] // 父数据ID
        },
        "join": {
            "joinTables": { // 连表信息
                "template_Z6F5g": { // 表单ApiName
                    "filter": { // 过滤条件
                        "code": "00000001",
                    },
                    "fields": [
                        "code",
                        "field_xxxx"
                    ], // 查询字段,可为空,默认查所有字段
                    "sorts": [ // 排序,可为空,为空按照子表id降序排列
                        {
                            "property": "code", // 排序字段apiName
                            "direction": "DESC", // 排序方式,DESC或ASC
                            "scope": "VALUE" // 排序字段的作用域,目前仅支持VALUE
                        }
                    ]
                },
                "template_O70cG": {
                    "filter": {
                        "code": [
                            "00000001",
                            "00000002"
                        ]
                    },
                    "fields": []
                },
            },
            "flat": false, // 数据是否平铺,默认不平铺
        },
        "associate": { // 关联列表查询参数
            "templateApiName": "template_JHEHl", // 表单ApiName
            "dataIds": [
                "00000000000"
            ] // 数据id
        },
        "defaultSort": {
            "enabled": false, // 是否开启,默认关闭。
            "view": "ALL" // 视图名称,与工作流参数tab一致
        }
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "message": "",
    "data": {
        "list": [
            {
                "": {}
            }
        ],
        "start": 0,
        "length": 0,
        "recordsTotal": 0
    }
}
修改于 2025-08-18 06:00:45
上一页
查询表单详情
下一页
保存或更新表单
Built with