ectd-ui/src/api/sas/document/document.md
2026-09-15 10:54:51 +08:00

5.8 KiB

文档预览相关 API

获取文档信息

  • 接口: /admin/api/shanghaijinzhiqiao/document/getDocInfo
  • 方法: POST
  • 参数:
    {
      wdid: number; // 文档ID
      sfhqdqzxdrw: string; // 是否获取当前最新文档 0-否 1-是
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      data: {
        id: number; // 文档ID
        wdmc: string; // 文档名称
        gfwjm: string; // 规范文件名
        ybt: string; // 叶标题
        wdlx: string; // 文档类型
        cjrxm: string; // 创建人姓名
        cjsj: string; // 创建时间
        wjbbh: string; // 文件版本号
        xzz: Array<Array<{userName: string; type: string}>>; // 协作者
        dgr_str: Array<Array<{userName: string; type: string}>>; // 定稿人
        spr_str: Array<Array<{userName: string; type: string}>>; // 内容审批者
        gsspr_str: Array<{userName: string; type: string}>; // 格式审批者
        dqrwzt: string; // 当前任务状态
        dqrwzt_value: string; // 当前任务状态值
        cpmc: string; // 产品名称
        sqmc: string; // 申请名称
        wdid_m: number; // 文档ID(主)
        wjid: number; // 文件ID
        userid: number; // 用户ID
        lcbh: string; // 流程编号
        is_save: boolean; // 是否可保存
        isdg: string; // 是否定稿 0-否 1-是
        sfbsc: string; // 是否被删除 0-否 1-是
        is_feiqi: boolean; // 是否可废弃
        is_fenlei: boolean; // 是否可分类
        fl: string; // 分类
        bt_update: boolean; // 是否可更新
        bt_update_re_pdf: boolean; // 是否可重新导入PDF
        bt0: boolean; // 是否显示下一步按钮(OA流程)
        bt1: boolean; // 是否显示下一步按钮(定稿人)
        bt2: boolean; // 是否显示审批文档按钮
        bt3: boolean; // 是否显示下一步按钮(格式审批)
        hh_count: number; // 会话数量
        listcode: Array<{ // 流程步骤列表
          code_name: string; // 步骤名称
          code_value: string; // 步骤值
          css: string; // 样式
        }>;
      }
    }
    

获取历史版本列表

  • 接口: /admin/api/shanghaijinzhiqiao/document/getDocHistory
  • 方法: POST
  • 参数:
    {
      id: number; // 文档ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      data: {
        list: Array<{
          id: number; // 版本ID
          wdbbh: string; // 文档版本号
          wdzjxgsj: string; // 最后修改时间
          wdzhxgz: string; // 最后修改人
          dzmc: string; // 动作名称
        }>;
        mapxz: {
          id: number; // 当前版本ID
        }
      }
    }
    

切换文档版本

  • 接口: /admin/api/shanghaijinzhiqiao/document/switchDocVersion
  • 方法: POST
  • 参数:
    {
      bbid: string; // 版本ID
      wdid: string; // 文档ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

更新规范文件名

  • 接口: /admin/api/shanghaijinzhiqiao/document/updateDocFileName
  • 方法: POST
  • 参数:
    {
      flowid: number; // 流程ID
      wjm: string; // 文件名
      type: string; // 类型 1-规范文件名 2-叶标题
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

定稿操作

  • 接口: /admin/api/shanghaijinzhiqiao/document/docDinggao
  • 方法: POST
  • 参数:
    {
      wdid: number; // 文档ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

编辑操作

  • 接口: /admin/api/shanghaijinzhiqiao/document/docBianji
  • 方法: POST
  • 参数:
    {
      wdid: number; // 文档ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

废弃文档

  • 接口: /admin/api/shanghaijinzhiqiao/document/docFeiqi
  • 方法: POST
  • 参数:
    {
      lcid: number; // 流程ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

恢复文档

  • 接口: /admin/api/shanghaijinzhiqiao/document/docHuifu
  • 方法: POST
  • 参数:
    {
      wjid: number; // 文件ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

转换PDF

  • 接口: /admin/api/shanghaijinzhiqiao/document/doc2pdf
  • 方法: POST
  • 参数:
    {
      wjid: number; // 文件ID
      sfdpz: string; // 是否带批注 1-是 2-否
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      msg: string; // 提示信息
    }
    

查询PDF转换进度

  • 接口: /admin/api/shanghaijinzhiqiao/document/getPdfProgress
  • 方法: POST
  • 参数:
    {
      wjid: number; // 文件ID
    }
    
  • 返回:
    {
      code: number; // 0-失败 1-成功
      data: {
        zhzt: string; // 转换状态 0-等待中 1-转换中 2-转换失败 3-转换成功 4-转换完成
        zhjd: number; // 转换进度(百分比)
        zhjg: string; // 转换结果
      }
    }
    

检查文件是否存在更新

  • 接口: /admin/api/shanghaijinzhiqiao/document/checkFileExists
  • 方法: POST
  • 参数:
    {
      wjid: number; // 文件ID
    }
    
  • 返回:
    {
      code: number; // 0-文件已更新 1-文件未更新
      data?: {
        hh_sum: number; // 会话数量
      }
    }
    

下载文件

  • 接口: /admin/api/shanghaijinzhiqiao/FileDownloadEvent2/downFile
  • 方法: GET
  • 参数:
    {
      flowId: number; // 流程ID
    }
    
  • 返回: 文件流

下载历史版本文件

  • 接口: /admin/api/shanghaijinzhiqiao/FileDownloadEvent2/hisDownFile
  • 方法: GET
  • 参数:
    {
      hisId: number; // 历史版本ID
    }
    
  • 返回: 文件流