GLink平台开发者中心V2.0

# 文件接口

# 定义

# 文件上传参数

FileRecordModel

主键 类型 id 描述
业务主键 String businessId
业务类型编码 String businessTypeCode
上传人主键 String authorId
上传人名称 String author
描述 String remark

# 文件记录响应体

FileRecordResModel

名称 类型 字段 描述
主键 String id
业务主键 String businessId
业务类型编码 String businessTypeCode
上传人主键 String authorId
上传人 String author
描述 String remark
附件名称 String fileName
附件格式 String fileSuffix
文件路径 String filePath 无需返回给外部接口，但内部接口会使用
文件组 String fileGroup
预览文件路径 String previewFilePath
预览文件大小 Long previewFileSize
预览文件组 String previewFileGroup
可预览 Integer preview 0 不可预览 1 可预览
上传状态 Integer state 0初始状态 1 上传完成 2 解析中 3 解析完成
上传时间 Date uploadTime
文件大小 Long fileSize

# 附件上传返回体

FileUploadResModel

名称 类型 字段 描述
上传成功文件列表 List <FileRecordResModel> successFiles 上传成功文件响应列表
上传失败文件列表 List <FileRecordResModel> failFiles 上传失败文件响应列表

# 分页模型

PageModel

名称 类型 字段 描述
分页大小 int pageSize 每页显示记录数
当前页 int currentPage 当前页码

# 接口

# 文件上传（带业务参数）

  • 请求路径

    /files/upload

  • 接口参数

    名称 类型 字段名 描述
    文件列表 List <MultipartFile> files 必填
    文件记录实体 FileRecordModel fileRecordModel 非必填

  • 返回信息

    名称 类型 字段名 描述
    文件上传返回体 FileUploadResModel fileUploadResModel

# 文件下载（带业务参数）

  • 请求路径

    /files/download/{fileId}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    文件上传返回体 OutStream 直接返回文件流

# 根据业务类型与业务主键查询文件信息列表

  • 请求路径

    /files/infos/

  • 接口参数

    名称 类型 字段名 描述
    文件记录实体 FileRecordModel model 非必填

  • 返回信息

    名称 类型 字段名 描述
    文件记录返回体 List <FileRecordResModel> fileRecordResModels

# 根据业务类型与业务主键查询文件信息列表

  • 请求路径

    /files/infos/

  • 接口参数

    名称 类型 字段名 描述
    文件记录实体 FileRecordModel model 非必填

  • 返回信息

    名称 类型 字段名 描述
    文件记录返回体 List <FileRecordResModel> fileRecordResModels

# 根据业务类型与业务主键查询文件信息列表

  • 请求路径

    /files/infos/

  • 接口参数

    名称 类型 字段名 描述
    文件记录实体 FileRecordModel model 非必填

  • 返回信息

    名称 类型 字段名 描述
    文件记录返回体 List <FileRecordResModel> fileRecordResModels

# 根据文件id更新文件

  • 请求方式

    PUT

  • 请求路径

    /files/stream/{id}

  • 接口参数

    名称 类型 字段名 描述
    文件 MultipartFile file 必填

  • 返回信息

    名称 类型 字段名 描述
    是否成功 boolean reasult 是否更新成功

# 根据文件id获取文件信息

  • 请求路径

    /files/infos/{fileId}

  • 接口参数

  • 返回信息

    名称 类型 字段名 描述
    文件记录返回体 FileRecordResModel fileRecordResModel

# 根据业务类型与业务主键查询文件信息列表分页

  • 请求路径

    /files/infos/page

  • 接口参数

    名称 类型 字段名 描述
    文件记录实体 FileRecordModel model 非必填
    分页模型 PageModel pageModel

  • 返回信息

    名称 类型 字段名 描述
    文件记录返回体 List <FileRecordResModel> fileRecordResModels

# 获取文件预览pdf

  • 请求路径

    /files/preview/{fileId}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    文件上传返回体 OutStream 直接返回文件流

# 删除文件

  • 请求路径

    /files/{fileId}

  • 请求方式

    Delete

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    删除标识 Boolean 删除标识

# 批量删除文件

  • 请求路径

    /files/batch

  • 请求方式

    Delete

  • 接口参数

    名称 类型 字段名 描述
    文件主键 List <String> fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    删除标识 Boolean 删除标识

# 生成临时下载url

  • 请求路径

    /files/temp/downloadurl/{fileId}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    临时下载url String 临时下载url

# 生成临时预览url

  • 请求路径

    /files/temp/previewurl/{fileId}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    临时预览url String 临时预览url

注：以下是内部接口，公文无需调用

# 生成临时下载code（内部）

  • 请求路径

    /files/temp/downloadurl/{fileId}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填

  • 返回信息

    名称 类型 字段名 描述
    临时下载code String 临时下载code

# 临时下载地址（内部）

  • 请求路径

    /files/download/{fileId}/{tmpCode}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填
    临时下载code String tmpCode 必填

  • 返回信息

    名称 类型 字段名 描述
    文件上传返回体 OutStream 直接返回文件流

# 临时预览地址（内部）

  • 请求路径

    /files/preview/{fileId}/{tmpCode}

  • 接口参数

    名称 类型 字段名 描述
    文件主键 String fileId 必填
    临时下载code String tmpCode 必填

  • 返回信息

    名称 类型 字段名 描述
    文件上传返回体 OutStream 直接返回文件流

← 流程中心接口文档 →