跳转至

设计时 EIP 集成管理(EipController)

EIP(Enterprise Information Portal)集成配置的设计时管理:列表查询、详情获取、新建、更新与批量删除。

  • 接口类型:REST 资源
  • 基址${myapps.context-path.designer:}/api/designtime/applications(类级 @RequestMappingproduces = APPLICATION_JSON_VALUE
  • Tag:设计时-EIP 模块

公共说明

  • 鉴权:是(需 designerToken)。控制器继承自 AbstractDesignTimeController(基类为 @RestController),通过 Security.getDesignerIdFromToken(request) 从 designerToken JWT 中解析设计器用户。鉴权机制详见 index.md「鉴权说明」。
  • 路径变量{applicationId}{eipId} 均为**明文设计时 ID**。
  • 响应:统一 Resource(见 ../index.md「统一响应结构」)。成功 errcode=0;保存时抛 OBPMValidateException(名称重复)返回 errcode=40001;其他异常 errcode=500
  • HTTP 方法:受 CommonSecurityFilter 限制,仅允许 GET/POST/HEAD/OPTIONS
  • 请求体约定:POST/PUT 接收原始 JSON 字符串(@RequestBody String content),由服务端用 JSONObject.fromObject 解析后通过 json2objEipVO;DELETE 接收 JSON 字符串数组(@RequestBody String[])。
  • 隶属关系:新建/更新时 applicationidparentId 均固定设为 applicationId(EIP 直接挂在应用下,无模块层)。

1. 获取 EIP 列表

分页获取指定应用下的 EIP 列表,可按名称查询。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/{applicationId}/eips(完整:{designer-context}/api/designtime/applications/{applicationId}/eips
  • 鉴权:是(需 designerToken)
  • Tag:设计时-EIP 模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
name query string 按名称查询关键字
pageNo query string 页码(缺省 1
linesPerPage query string 每页条数(缺省 10

说明:name/pageNo/linesPerPage 形参未标注 @RequestParam,由 Spring MVC 按请求参数绑定,故均可缺省。

请求示例

GET /api/designtime/applications/{applicationId}/eips?name=&pageNo=1&linesPerPage=10 HTTP/1.1

响应

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

成功示例

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


2. 获取 EIP 详情

按 EIP Id 获取完整 EIP 对象。

  • 接口类型:REST 资源
  • 请求方式GET
  • 请求路径/{applicationId}/eips/{eipId}
  • 鉴权:是(需 designerToken)
  • Tag:设计时-EIP 模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
eipId path string EIP Id

响应

dataEipVO 完整对象。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "...", "name": "...", "xml": "...", "description": "...", "...": "..." }, "errors": null }
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


3. 新建 EIP

在指定应用下新建 EIP。请求体解析为 EipVO 后强制覆盖 applicationidparentId(均设为 applicationId),保存前做名称重名校验。HTTP 状态码 201

  • 接口类型:REST 资源
  • 请求方式POST
  • 请求路径/{applicationId}/eips
  • 鉴权:是(需 designerToken)
  • Tag:设计时-EIP 模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
content body string(JSON) EIP 对象 JSON

请求体

对应 EipVO 对象 JSON(namexmldescription 等)。

{ "name": "<EIP 名>", "xml": "<EIP 配置 XML>", "description": "..." }

响应

dataJSONObject,仅含 id(新建 EIP Id)。

{ "errcode": 0, "errmsg": "ok", "data": { "id": "<EIP Id>" }, "errors": null }
失败示例(名称重复):
{ "errcode": 40001, "errmsg": "名称已经存在!", "data": null, "errors": null }
失败示例(其他异常):
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


4. 更新 EIP

按 EIP Id 更新 EIP 对象。先按 eipId 查出原对象并克隆,再用请求体中的 xml/name/description 覆盖(其余字段保留原值),强制清空 uri 后保存。HTTP 状态码 201(源码 @ResponseStatus(HttpStatus.CREATED),更新场景亦返回 201)。

  • 接口类型:REST 资源
  • 请求方式PUT
  • 请求路径/{applicationId}/eips/{eipId}
  • 鉴权:是(需 designerToken)
  • Tag:设计时-EIP 模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
eipId path string EIP Id(用于查找原对象)
content body string(JSON) EIP 对象 JSON(取 xml/name/description

请求体

对应 EipVO 对象 JSON(仅 xml/name/description 会被采用)。

{ "name": "<EIP 名>", "xml": "<EIP 配置 XML>", "description": "..." }

响应

datanull(成功)。

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }
失败示例(名称重复):
{ "errcode": 40001, "errmsg": "名称已经存在!", "data": null, "errors": null }
失败示例(其他异常):
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


5. 删除 EIP(可批量)

按 EIP Id 数组批量删除 EIP(删除前收集各 EIP 的路径信息)。

  • 接口类型:REST 资源
  • 请求方式DELETE
  • 请求路径/{applicationId}/eips
  • 鉴权:是(需 designerToken)
  • Tag:设计时-EIP 模块

请求参数

参数名 位置 类型 必填 说明
applicationId path string 应用Id
ids body string EIP Id 字符串数组

请求体

["<eipId1>", "<eipId2>"]

响应

dataString,固定为 "删除成功"

{ "errcode": 0, "errmsg": "ok", "data": "删除成功", "errors": null }
失败示例
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }