跳转至

设计时系统版本信息(VersionsController)

分页获取系统版本/信息列表,可按名称或类型过滤;供设计器查看历史版本或系统信息。

  • 接口类型:REST 资源
  • 基址:${myapps.context-path.designer:}/api/designtime(类级 @RequestMapping,produces = APPLICATION_JSON_VALUE)
  • Tag:设计时-系统信息

公共说明

  • 鉴权:是(需 designerToken)。控制器继承自 AbstractDesignTimeController(基类为 @RestController)。鉴权机制详见 index.md「鉴权说明」。
  • 响应:统一 Resource(见 ../index.md「统一响应结构」)。成功 errcode=0;异常 errcode=500。
  • HTTP 方法:受 CommonSecurityFilter 限制,仅允许 GET/POST/HEAD/OPTIONS。

1. 获取系统信息列表

按名称与类型分页查询系统信息(版本)列表。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/systeminfo(完整:{designer-context}/api/designtime/systeminfo)
  • 鉴权:是(需 designerToken)
  • Tag:设计时-系统信息

请求参数

参数名 位置 类型 必填 说明
name query string 否 名称关键字
type query int 否 类型(缺省 0;0 视为不过滤,服务端将 type=0 转为 null 传入查询)
currpage query string 否 当前页数(缺省 1,未标注 @RequestParam,由 Spring MVC 按请求参数绑定)
pagelines query string 否 每页行数(缺省 10,同上)

说明:currpage/pagelines 形参未标注 @RequestParam,由 Spring MVC 按请求参数绑定,故均可缺省;空字符串时回退到默认值。

请求示例

GET /api/designtime/systeminfo?name=&type=0&currpage=1&pagelines=10 HTTP/1.1

响应

结构:统一 Resource(见 ../index.md「统一响应结构」)。 data:DataPackage<Versions>(含分页字段与 datas)。

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "linesPerPage": 10,
    "pageNo": 1,
    "pageCount": 1,
    "rowCount": 1,
    "datas": [
      { "id": "...", "name": "...", "type": 1, "...": "..." }
    ]
  },
  "errors": null
}
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }