title: myApps.5.0trunk v1.0.0
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: “@tarslib/widdershins v4.0.17”
myApps.5.0trunk
v1.0.0
Base URLs:
myApps设计时/登陆模块
POST 注销
POST /api/designtime/logout
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| accessToken | cookie | string | 否 | none |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 登陆
POST /api/designtime/login
Body 请求参数
{
"username": "admin",
"password": "VlbWxpbms=dG",
"checkcode": "ssss"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » username | body | string | 是 | 用户账号 | none |
| » password | body | string | 是 | 用户密码 | none |
| » checkcode | body | string | 是 | 验证码(base64) | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"designerToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhdXRoMCIsImV4cCI6MTY1ODI5MjM0MCwidXNlcm5hbWUiOiJBaTZobGxoTmpTMnVsbDlUS0diIn0.GwtyQB9brDChLzLOKI3IpY_4ETtvhsz-YnpJAyL9XvY"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | none |
| » errmsg | string | true | none | 状态码对应的信息文本 | none |
| » data | object | true | none | 返回数据 | none |
| »» designerToken | string | true | none | none |
myApps设计时/软件(applications)
GET 生成概览
GET /api/designtime/applications/{applicationId}/overview
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET 获取平台模式回调日志
GET /api/designtime/applications/{applicationId}/getCallBackLogs
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"targetHost": "服务器地址",
"callBackTime": "回调时间",
"callBackResult": "回调结果",
"callBackParam": "回到参数",
"token": "令牌",
"key": "密钥"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | |
| » errmsg | string | true | none | 状态码对应的信息文本 |
PUT 更新软件
PUT /api/designtime/applications/{applicationId}
Body 请求参数
{
"name": "name",
"description": "description",
"type": 1,
"activated": true,
"orderNo": 1,
"datasourceId": "datasourceId"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 软件名称 | none |
| » description | body | string | 是 | 描述 | none |
| » type | body | integer | 是 | 开发模式 | none |
| » activated | body | boolean | 是 | 激活状态 | none |
| » orderNo | body | integer | 是 | 排序号 | none |
| » datasourceId | body | string | 是 | 数据源id | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取软件详情
GET /api/designtime/applications/{applicationId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"description": "description",
"type": 1,
"activated": true,
"orderNo": 1,
"datasourceId": "datasourceId",
"datasourceName": "datasourceName"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 软件id | none |
| »» name | string | true | none | 软件名称 | none |
| »» description | string | true | none | 描述 | none |
| »» type | integer | true | none | 开发模式 | none |
| »» activated | boolean | true | none | 激活状态 | none |
| »» orderNo | integer | true | none | 排序号 | none |
| »» datasourceId | string | true | none | 数据源id | none |
| »» datasourceName | string | true | none | none |
POST 新建软件
POST /api/designtime/applications
Body 请求参数
{
"name": "name",
"description": "description",
"type": 1,
"activated": true,
"orderNo": 1,
"datasourceId": "datasourceId"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 软件名称 | none |
| » description | body | string | 是 | 描述 | none |
| » type | body | integer | 是 | 开发模式 | none |
| » activated | body | boolean | 是 | 激活状态 | none |
| » orderNo | body | integer | 是 | 排序号 | none |
| » datasourceId | body | string | 是 | 数据源id | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 软件id | none |
GET 获取软件列表
GET /api/designtime/applications
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| searchword | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 第几页 | |
| linesPerPage | query | string | 否 | 每页显示条数 | |
| type | query | string | 否 | 类型 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 3,
"linesPerPage": 2147483647,
"pageNo": 1,
"datas": [
{
"id": "aaITQNiVuTz324lCKD1",
"name": "KM",
"type": 0,
"description": "obpm的km装用软件",
"activated": true
},
{
"id": "sOZu9kthmxyP8qQfq0e",
"name": "4.0功能示例",
"type": 0,
"description": "适用于4.0+版本的功能测试",
"activated": true
},
{
"id": "__rn7jHtWcWVGkgBDKaHr",
"name": "新建的软件",
"type": 0,
"description": "新建的软件",
"activated": true
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | true | none | 软件id | none |
| »»» name | string | true | none | 软件名称 | none |
| »»» type | integer | true | none | none | |
| »»» description | string | true | none | 描述 | none |
| »»» activated | boolean | true | none | none | |
| »» pageCount | integer | true | none | none |
DELETE 删除软件(可批量)
DELETE /api/designtime/applications
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | 软件id | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/模块(Modules)
GET 获取日志记录
GET /api/designtime/applications/records/{id}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| id | path | string | 是 | 资源id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"time": "2022-02-26 15:59:22",
"id": "73164bb9ddf0d7af09323628162e6f9814e1ce6d",
"message": "删除:脚本",
"username": "Admin"
},
{
"time": "2022-02-26 15:59:07",
"id": "cbaf20341188a9fdde9e97666f785ac9067b687a",
"message": "改动:脚本",
"username": "Admin"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» time | string | true | none | 时间 | none |
| »» id | string | true | none | 日志id | none |
| »» message | string | true | none | 操作信息 | none |
| »» username | string | true | none | 操作人 | none |
DELETE 删除模块
DELETE /api/designtime/applications/modules
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | none |
| » errmsg | string | true | none | 对返回码的文本信息说明 | none |
GET 获取树形结构所有模块列表
GET /api/designtime/applications/{applicationId}/allmodules
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| currentModuleId | query | string | 否 | 当前模块id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "",
"value": "无"
},
{
"id": "__CAQYDSxmmOxMhrnq9b5",
"value": "接口测试"
},
{
"id": "__nIR7tcVaHuUwph5r4cc",
"value": "|---请假测试"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | true | none | none | |
| »» value | string | true | none | none |
GET 获取模块列表(根据上级获取)
GET /api/designtime/applications/{applicationId}/modules
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| parentId | query | string | 否 | 上级id(顶级模块上级id为软件id) |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"superior": "__lztGCe2TRNqowHluDem",
"hasChild": false,
"name": "导出导入数据",
"id": "__N5tQwhFZNLHo7S7nFpd",
"applicationId": "sOZu9kthmxyP8qQfq0e",
"uri": "/4.0功能示例.application/高级应用.module/导出导入数据.module/导出导入数据.module"
},
{
"superior": "__lztGCe2TRNqowHluDem",
"hasChild": false,
"name": "iscript应用",
"id": "__PX4mEhGcLp6nUIrchka",
"applicationId": "sOZu9kthmxyP8qQfq0e",
"uri": "/4.0功能示例.application/高级应用.module/iscript应用.module/iscript应用.module"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | none |
| » errmsg | string | true | none | 状态码对应的信息文本 | none |
| » data | [object] | true | none | 返回数据 | none |
| »» superior | string | true | none | 上级模块id | none |
| »» hasChild | boolean | true | none | none | |
| »» name | string | true | none | 模块名称 | none |
| »» id | string | true | none | 模块id | none |
| »» applicationId | string | true | none | none | |
| »» uri | string | true | none | none |
POST 新建模块
POST /api/designtime/applications/{applicationId}/modules
Body 请求参数
{
"name": "name",
"description": "description",
"superior": "superior",
"orderNo": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 模块名称 | none |
| » description | body | string | 是 | 描述 | none |
| » superior | body | string | 是 | 上级模块id | none |
| » orderNo | body | integer | 是 | 排序号 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
PUT 更新模块
PUT /api/designtime/applications/{applicationId}/modules/{moduleId}
Body 请求参数
{
"name": "name",
"description": "description",
"superior": "superior",
"orderNo": 1
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 模块名称 | none |
| » description | body | string | 是 | 描述 | none |
| » superior | body | string | 是 | 上级模块id | none |
| » orderNo | body | integer | 是 | 排序号 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取模块详情
GET /api/designtime/applications/modules/{moduleId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"superiorName": "报表",
"orderNo": 0,
"name": "报表示例",
"description": "",
"id": "__jdnS7aKT9LklWZGoZgD",
"uri": "/4.0功能示例.application/报表.module/报表示例.module/报表示例.module",
"superior": "__rqFRoJeZB0x0DvHwY2v"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» superiorName | string | true | none | none | |
| »» orderNo | integer | true | none | 排序号 | none |
| »» name | string | true | none | 模块名称 | none |
| »» description | string | true | none | 描述 | none |
| »» id | string | true | none | 模块id | none |
| »» uri | string | true | none | none | |
| »» superior | string | true | none | 上级模块id | none |
myApps设计时/ 表单(Forms)
POST 新建表单
POST /api/designtime/applications/{applicationId}/modules/{moduleId}/forms
Body 请求参数
{
"name": "name",
"templatecontext": "templatecontext",
"discription": "discription",
"type": 1,
"styleId": "styleId",
"showLog": true,
"showWaterMark": true,
"waterMarkScript": "waterMarkScript",
"isopenablescript": "isopenablescript",
"iseditablescript": "iseditablescript",
"mappingStr": "mappingStr",
"orderno": 1,
"permissionType": "permissionType",
"layoutType": "layoutType"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » templatecontext | body | string | 是 | 源代码文本 | none |
| » discription | body | string | 是 | 描述 | none |
| » type | body | integer | 是 | 类型 | none |
| » styleId | body | string | 是 | 样式库id | none |
| » showLog | body | boolean | 是 | 显示日志操作 | none |
| » showWaterMark | body | boolean | 是 | 是否显示水印 | none |
| » waterMarkScript | body | string | 是 | 水印脚本 | none |
| » isopenablescript | body | string | 是 | 是否可打开脚本 | none |
| » iseditablescript | body | string | 是 | 是否可编辑脚本 | none |
| » mappingStr | body | string | 是 | 映射表数据 | none |
| » orderno | body | integer | 是 | 排序号 | none |
| » permissionType | body | string | 是 | 权限 | none |
| » layoutType | body | string | 是 | 手机端表单控件布局样式 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取表单详情
GET /api/designtime/applications/modules/forms/{formId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | path | string | 是 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "GCSuCaakSQ30kvRXGyH",
"name": "表单_样式库",
"templatecontext": "<table width=\"90%\" border=\"2\" cellpadding=\"1\" cellspacing=\"1\" style=\"border: 2px solid rgb(180, 204, 238);\">\n <tbody>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238); text-align: center;\" colspan=\"4\"><span style=\"font-size: large;\"><strong>库存信息表</strong></span></td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">物品名称:</td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"><input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"POo2LQrkEILiw76ZPVw\" text=\"text\" name=\"名称\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">单价:</td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"><input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"WVrcTf3SRT9jJnEmMkR\" text=\"text\" name=\"单价\" texttype=\"text\" fieldtype=\"VALUE_TYPE_NUMBER\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">库存:</td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"><input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"8Qr1GXKS6qjvPXrjNdU\" text=\"text\" name=\"库存\" texttype=\"text\" fieldtype=\"VALUE_TYPE_NUMBER\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">备注:</td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"><textarea classname=\"cn.myapps.runtime.dynaform.form.ejb.TextareaField\" id=\"ILWGUkuf2JRt3RvWeLV\" name=\"备注\" readonlyshowvalonly=\"true\" fieldtype=\"VALUE_TYPE_TEXT\" discript=\"\" validaterule=\"\" valuescript=\"@quot;输入框字体显示红色@quot;\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" filtercondition=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" validatelibs=\"\" editmode=\"01\" processdescription=\"[];[]\" refreshmode=\"0\" refreshfields=\"\" style=\"margin: 0px; width: 298px; height: 49px;\"></textarea></td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\" colspan=\"2\"><span style=\"color: rgb(255, 0, 0);\">涉及功能点:</span></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\" colspan=\"2\"><span style=\"color: rgb(255, 0, 0);\">F020</span></td>\n </tr>\n </tbody>\n</table>\n<p><span style=\"font-size: larger;\"><span style=\"color: rgb(255, 0, 0);\"> </span></span></p>\n<p style=\"text-align: center;\"> </p>\n<p style=\"text-align: center;\"> </p>",
"type": 1,
"styleId": "HNaKnPtT0bKlXoTGqkx",
"showLog": false,
"openComment": false,
"recordlogForever": false,
"showType": "old",
"showWaterMark": false,
"style": {
"id": "HNaKnPtT0bKlXoTGqkx",
"name": "输入框字体_红",
"description": null,
"content": ".form-control{ \n color: red !important; \n }",
"version": 0,
"lastmodifytime": "2020-06-30T10:00:49.491+0000"
},
"version": 2,
"mappingStr": "{\"formName\":\"表单_样式库\",\"tableName\":\"\",\"columnMappings\":[]}",
"checkout": false,
"orderno": 1,
"permissionType": "public",
"layoutType": "horizontal",
"typeName": "NORMALFORM",
"inited": true,
"allFieldNames": [
"名称",
"单价",
"库存",
"备注"
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 表单id | none |
| »» name | string | true | none | 表单名称 | none |
| »» templatecontext | string | true | none | 源代码文本 $.data.discription 描述 | none |
| »» type | integer | true | none | 表单类型 | none |
| »» styleId | string | true | none | 样式库id | none |
| »» showLog | boolean | true | none | 显示日志操作 | none |
| »» openComment | boolean | true | none | none | |
| »» recordlogForever | boolean | true | none | none | |
| »» showType | string | true | none | none | |
| »» showWaterMark | boolean | true | none | 是否显示水印 | none |
| »» style | object | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» description | null | true | none | none | |
| »»» content | string | true | none | none | |
| »»» version | integer | true | none | none | |
| »»» lastmodifytime | string | true | none | none | |
| »» version | integer | true | none | none | |
| »» mappingStr | string | true | none | none | |
| »» checkout | boolean | true | none | none | |
| »» orderno | integer | true | none | none | |
| »» permissionType | string | true | none | none | |
| »» layoutType | string | true | none | none | |
| »» typeName | string | true | none | none | |
| »» inited | boolean | true | none | none | |
| »» allFieldNames | [string] | true | none | none |
GET 获取表单列表(可根据名字或者描述查询)
GET /api/designtime/applications/modules/{moduleId}/forms
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id | |
| name | query | string | 否 | 查询名称 | |
| description | query | string | 否 | 查询描述 | |
| type | query | string | 否 | 表单类型 | |
| pageNo | query | string | 否 | 当前页数 | |
| linesPerPage | query | string | 否 | 每页行数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 6,
"linesPerPage": 1,
"pageNo": 1,
"datas": [
{
"id": "NEo0BVgwvHgTNWM5bQ1",
"name": "类型_普通表单",
"type": 1,
"showLog": false,
"showWaterMark": false,
"waterMarkScript": "(function(){\nreturn \"显示这段文字为水印不正常\";\n})()",
"version": 3,
"mappingStr": "{\"formName\":\"类型_普通表单\",\"tableName\":\"\",\"columnMappings\":[]}",
"checkout": false,
"orderno": 1,
"permissionType": "public",
"layoutType": "horizontal",
"typeName": "NORMALFORM",
"inited": false
}
],
"pageCount": 6
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 表单id | none |
| »»» name | string | false | none | 表单名称 | none |
| »»» type | integer | false | none | none | |
| »»» showLog | boolean | false | none | none | |
| »»» showWaterMark | boolean | false | none | none | |
| »»» waterMarkScript | string | false | none | none | |
| »»» version | integer | false | none | none | |
| »»» mappingStr | string | false | none | none | |
| »»» checkout | boolean | false | none | none | |
| »»» orderno | integer | false | none | 排序号 | none |
| »»» permissionType | string | false | none | none | |
| »»» layoutType | string | false | none | none | |
| »»» typeName | string | false | none | none | |
| »»» inited | boolean | false | none | none | |
| »» pageCount | integer | true | none | none |
PUT 更新表单
PUT /api/designtime/applications/{applicationId}/modules/{moduleId}/forms/{formId}
Body 请求参数
{
"name": "name",
"templatecontext": "templatecontext",
"discription": "discription",
"type": 1,
"styleId": "styleId",
"showLog": true,
"showWaterMark": true,
"waterMarkScript": "waterMarkScript",
"isopenablescript": "isopenablescript",
"iseditablescript": "iseditablescript",
"mappingStr": "mappingStr",
"orderNo": 1,
"permissionType": "permissionType",
"layoutType": "layoutType"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| formId | path | string | 是 | 表单id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 表单名称 | none |
| » templatecontext | body | string | 是 | 源代码文本 | none |
| » discription | body | string | 是 | 描述 | none |
| » type | body | integer | 是 | 类型 | none |
| » styleId | body | string | 是 | 样式库id | none |
| » showLog | body | boolean | 是 | 显示日志操作 | none |
| » showWaterMark | body | boolean | 是 | 是否显示水印 | none |
| » waterMarkScript | body | string | 是 | 水印脚本 | none |
| » isopenablescript | body | string | 是 | 是否可打开脚本 | none |
| » iseditablescript | body | string | 是 | 是否可编辑脚本 | none |
| » mappingStr | body | string | 是 | 映射表数据 | none |
| » orderNo | body | integer | 是 | 排序号 | none |
| » permissionType | body | string | 是 | 权限 | none |
| » layoutType | body | string | 是 | 手机端表单控件布局样式 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除表单(可批量)
DELETE /api/designtime/applications/modules/forms
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | query | string | 否 | 软件id | |
| moduleId | query | string | 否 | 模块id | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取表单操作列表
GET /api/designtime/applications/modules/forms/{formId}/activitys
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | path | string | 是 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "id",
"name": "name"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | false | none | 操作id | none |
| »» name | string | false | none | 状态码对应的信息文本 | none |
GET 获取表单清除数据字段列表
GET /api/designtime/applications/modules/forms/{formId}/clearFields
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | path | string | 是 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "id",
"name": "name",
"type": "type"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | false | none | none | |
| »» id | string | false | none | 字段id | none |
| »» name | string | false | none | 字段名称 | none |
| »» type | string | false | none | none |
GET 获取字段列表
GET /api/designtime/applications/modules/forms/{formId}/fields
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | path | string | 是 | 表单id | |
| type | query | string | 否 | 字段类型(all,evenMapping[时间映射],dataMapping[数据映射]) |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "id",
"name": "name",
"type": "type"
},
{}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | false | none | none | |
| »» id | string | false | none | 字段id | none |
| »» name | string | false | none | 字段名称 | none |
| »» type | string | false | none | none |
DELETE 删除表单操作(可批量)
DELETE /api/designtime/applications/modules/forms/activitys
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 映射表单同步数据
POST /api/designtime/applications/modules/forms/synchronouslyData
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | query | string | 否 | 表单id | |
| tableName | query | string | 否 | 数据表名 | |
| domainId | query | string | 否 | 企业域id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "数据同步成功"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 帮助接口树形结构
GET /api/designtime/applications/modules/getHelpTreeIndex
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "html"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 获取数据库列名称映射
GET /api/designtime/applications/modules/forms/dataBaseColumnMap
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | query | string | 否 | 软件id | |
| tableName | query | string | 否 | 数据表名 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"": "选择"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» anonymous | string | false | none | none |
GET 获取数据表名称映射
GET /api/designtime/applications/modules/forms/dataBaseTableMap
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | query | string | 否 | 软件id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"": "选择"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» anonymous | string | false | none | none |
GET 获取表单操作详情
GET /api/designtime/applications/modules/forms/activitys/{activityId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| activityId | path | string | 是 | 操作id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__5LjlNkiKwgnxaMmQhAR",
"name": "测试",
"type": 34,
"colorType": "default",
"readonly": false,
"editMode": 0,
"orderno": 0,
"parentForm": "__3dBN0lXmsU09J5zZHKR",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"dispatcherParams": "[{\"paramKey\":\"\",\"paramValue\":\"\"}]",
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"targetList": "|"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 操作id | none |
| »» name | string | true | none | 操作名称 | none |
| »» type | integer | true | none | 类型 | none |
| »» colorType | string | true | none | none | |
| »» readonly | boolean | true | none | none | |
| »» editMode | integer | true | none | none | |
| »» orderno | integer | true | none | none | |
| »» parentForm | string | true | none | none | |
| »» jumpType | integer | true | none | none | |
| »» expSub | boolean | true | none | none | |
| »» disableFlowNode | boolean | true | none | none | |
| »» changeFlowOperator | boolean | true | none | none | |
| »» changeFlowCc | boolean | true | none | none | |
| »» dispatcherMode | integer | true | none | none | |
| »» dispatcherParams | string | true | none | none | |
| »» jumpMode | integer | true | none | none | |
| »» jumpActOpenType | integer | true | none | none | |
| »» withOld | boolean | true | none | none | |
| »» actionType | integer | true | none | none | |
| »» actionSelection | integer | true | none | none | |
| »» workFlowType | integer | true | none | none | |
| »» contextMenu | boolean | true | none | none | |
| »» showInToolbar | boolean | true | none | none | |
| »» targetList | string | true | none | none |
GET 重置字段编号(返回随机数)
GET /api/designtime/applications/modules/forms/getSequence
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "__K7d6QgG3FN0aLpTP6c9"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
POST 清除表单字段数据
POST /api/designtime/applications/modules/forms/cleardata
Body 请求参数
[
"field1",
"field2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | query | string | 否 | 表单id | |
| body | body | array[string] | 否 | 请求包体(字段名称) | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 表单帮助接口
GET /api/designtime/applications/modules/forms/help
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| id | query | string | 否 | 帮助id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"href": "application/application_module_form_info_advance_help.html",
"label": "Form_Info_Advance_Help"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | false | none | none | |
| »» href | string | true | none | none | |
| »» label | string | true | none | none |
PUT 更新表单操作
PUT /api/designtime/applications/{applicationId}/modules/forms/{formId}/activitys/{activityId}
Body 请求参数
{
"name": "name",
"type": "type",
"onActionForm": "onActionForm",
"onActionView": "onActionView",
"onActionFlow": "onActionFlow",
"onActionPrint": "onActionPrint",
"colorType": "colorType",
"beforeActionScript": "beforeActionScript",
"afterActionScript": "afterActionScript",
"hiddenScript": "hiddenScript",
"readonlyScript": "readonlyScript",
"startFlowScript": "startFlowScript",
"editMode": "editMode",
"flowShowType": "flowShowType",
"fileNameScript": "fileNameScript",
"orderNo": "orderNo",
"stateToShow": "stateToShow",
"parentView": "parentView",
"parentForm": "parentForm",
"impmappingconfigid": "impmappingconfigid",
"jumpType": "jumpType",
"expSub": "expSub",
"icon": "icon",
"disableFlowNode": "disableFlowNode",
"changeFlowOperator": "changeFlowOperator",
"changeFlowCc": "changeFlowCc",
"multiLanguageLabel": "multiLanguageLabel",
"dispatcherMode": "dispatcherMode",
"dispatcherUrl": "dispatcherUrl",
"dispatcherParams": "dispatcherParams",
"jumpMode": "jumpMode",
"jumpActOpenType": "jumpActOpenType",
"withOld": "withOld",
"actionDispatcherUrlScript": "actionDispatcherUrlScript",
"actionSelection": "actionSelection",
"relatedFormId": "relatedFormId",
"actionScript": "actionScript",
"workFlowType": "workFlowType",
"contextMenu": "contextMenu",
"showInToolbar": "showInToolbar",
"transpond": "transpond",
"targetList": "targetList",
"actionType": "actionType"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| formId | path | string | 是 | 表单id | |
| activityId | path | string | 是 | 表单操作d | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » type | body | string | 是 | none | |
| » onActionForm | body | string | 是 | none | |
| » onActionView | body | string | 是 | none | |
| » onActionFlow | body | string | 是 | none | |
| » onActionPrint | body | string | 是 | none | |
| » colorType | body | string | 是 | none | |
| » beforeActionScript | body | string | 是 | none | |
| » afterActionScript | body | string | 是 | none | |
| » hiddenScript | body | string | 是 | none | |
| » readonlyScript | body | string | 是 | none | |
| » startFlowScript | body | string | 是 | none | |
| » editMode | body | string | 是 | none | |
| » flowShowType | body | string | 是 | none | |
| » fileNameScript | body | string | 是 | none | |
| » orderNo | body | string | 是 | none | |
| » stateToShow | body | string | 是 | none | |
| » parentView | body | string | 是 | none | |
| » parentForm | body | string | 是 | none | |
| » impmappingconfigid | body | string | 是 | none | |
| » jumpType | body | string | 是 | none | |
| » expSub | body | string | 是 | none | |
| » icon | body | string | 是 | none | |
| » disableFlowNode | body | string | 是 | none | |
| » changeFlowOperator | body | string | 是 | none | |
| » changeFlowCc | body | string | 是 | none | |
| » multiLanguageLabel | body | string | 是 | none | |
| » dispatcherMode | body | string | 是 | none | |
| » dispatcherUrl | body | string | 是 | none | |
| » dispatcherParams | body | string | 是 | none | |
| » jumpMode | body | string | 是 | none | |
| » jumpActOpenType | body | string | 是 | none | |
| » withOld | body | string | 是 | none | |
| » actionDispatcherUrlScript | body | string | 是 | none | |
| » actionSelection | body | string | 是 | none | |
| » relatedFormId | body | string | 是 | none | |
| » actionScript | body | string | 是 | none | |
| » workFlowType | body | string | 是 | none | |
| » contextMenu | body | string | 是 | none | |
| » showInToolbar | body | string | 是 | none | |
| » transpond | body | string | 是 | none | |
| » targetList | body | string | 是 | none | |
| » actionType | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 新建表单操作
POST /api/designtime/applications/{applicationId}/modules/forms/{formId}/activitys
Body 请求参数
{
"id": "__3yNMG2GuepJVUeFtiqT",
"name": "自定义",
"type": 13,
"readonly": false,
"editMode": 0,
"orderno": 2,
"parentForm": "__kTZBUJsWDBI74HN854m",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"dispatcherParams": "[{\"paramKey\":\"\",\"paramValue\":\"\"}]",
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"targetList": "|",
"processPreview": false
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| formId | path | string | 是 | 表单id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 操作名称 | |
| » type | body | string | 是 | 操作类型 | |
| » onActionForm | body | string | 是 | 关联的表单 | |
| » onActionView | body | string | 是 | 关联的视图 | |
| » onActionFlow | body | string | 是 | 关联的流程 | |
| » onActionPrint | body | string | 是 | 关联的动态打印 | |
| » colorType | body | string | 是 | 颜色类型 | |
| » beforeActionScript | body | string | 是 | 动作执行前脚本 | |
| » afterActionScript | body | string | 是 | 动作执行后脚本 | |
| » hiddenScript | body | string | 是 | 隐藏脚本 | |
| » readonlyScript | body | string | 是 | 只读脚本 | |
| » startFlowScript | body | string | 是 | 流程启动脚本 | |
| » editMode | body | string | 是 | 编辑方式 | |
| » flowShowType | body | string | 是 | 流程操作显示方式 | |
| » fileNameScript | body | string | 是 | 文件路径脚本 | |
| » orderNo | body | string | 是 | 排序号 | |
| » stateToShow | body | string | 是 | 状态标签 | |
| » parentView | body | string | 是 | 关联的视图标识 | |
| » parentForm | body | string | 是 | 关联的表单标识 | |
| » impmappingconfigid | body | string | 是 | 关联的导入配置映射标识 | |
| » jumpType | body | string | 是 | 跳转类型 | |
| » expSub | body | string | 是 | 是否导入子表数据 | |
| » icon | body | string | 是 | 图标地址 | |
| » disableFlowNode | body | string | 是 | 禁止添加和删除流程节点 | |
| » changeFlowOperator | body | string | 是 | 仅允许修改流程节点操作人 | |
| » changeFlowCc | body | string | 是 | 仅允许修改流程抄送人 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » dispatcherMode | body | string | 是 | Dispatcher的模式 | |
| » dispatcherUrl | body | string | 是 | Dispatcher的Url | |
| » dispatcherParams | body | string | 是 | Dispatcher的参数 | |
| » jumpMode | body | string | 是 | 跳转按钮模式 | |
| » jumpActOpenType | body | string | 是 | 跳转按钮打开类型 | |
| » withOld | body | string | 是 | 是否带旧数据 | |
| » actionDispatcherUrlScript | body | string | 是 | 自定义按钮 执行后的跳转动作类型的地址脚本 | |
| » actionSelection | body | string | 是 | 自定义按钮 执行动作类型 | |
| » relatedFormId | body | string | 是 | 自定义按钮 关联表单id | |
| » actionScript | body | string | 是 | 自定义按钮 动作执行脚本 | |
| » workFlowType | body | string | 是 | 流程类型 | |
| » contextMenu | body | string | 是 | 右键菜单操作 | |
| » showInToolbar | body | string | 是 | 在工具栏中显示 | |
| » transpond | body | string | 是 | 转发操作 | |
| » targetList | body | string | 是 | 目标清单 | |
| » actionType | body | string | 是 | 自定义按钮 执行后的操作类型 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 操作id | none |
myApps设计时/摘要(Summarys)
PUT 更新表单摘要
PUT /api/designtime/applications/summarys
Body 请求参数
{
"id": "id",
"name": "name",
"parentId": "parentId",
"applicationid": "applicationid",
"title": "title",
"type": "type",
"formId": "formId",
"fieldNames": "fieldNames",
"summaryScript": "summaryScript",
"scope": "scope"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » id | body | string | 是 | none | |
| » name | body | string | 是 | 摘要名称 | none |
| » parentId | body | string | 是 | none | |
| » applicationid | body | string | 是 | none | |
| » title | body | string | 是 | 摘要标题 | none |
| » type | body | string | 是 | 摘要类型 | none |
| » formId | body | string | 是 | 关联表单的ID | none |
| » fieldNames | body | string | 是 | 摘要字段 | none |
| » summaryScript | body | string | 是 | 摘要脚本 | none |
| » scope | body | string | 是 | 作用域 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除表单摘要(可批量)
DELETE /api/designtime/applications/summarys
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | 摘要id | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 新建表单摘要
POST /api/designtime/applications/{applicationId}/summarys
Body 请求参数
{
"name": "name",
"parentId": "parentId",
"applicationid": "applicationid",
"title": "title",
"type": "type",
"formId": "formId",
"fieldNames": "fieldNames",
"summaryScript": "summaryScript",
"scope": "scope"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 摘要名称 | none |
| » parentId | body | string | 是 | none | |
| » applicationid | body | string | 是 | none | |
| » title | body | string | 是 | 摘要标题 | none |
| » type | body | string | 是 | 摘要类型 | none |
| » formId | body | string | 是 | 关联表单的ID | none |
| » fieldNames | body | string | 是 | 摘要字段 | none |
| » summaryScript | body | string | 是 | 摘要脚本 | none |
| » scope | body | string | 是 | 作用域 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取表单摘要列表
GET /api/designtime/applications/{applicationId}/summarys
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| formId | query | string | 否 | 表单id | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 | |
| scope | query | string | 否 | 表单类型 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageCount": 1,
"pageNo": 1,
"rowCount": 8,
"data": [
{
"id": "__ARDGaHaysmhswgS4vee",
"name": "短信分享",
"type": "00",
"title": "短信分享",
"uri": "/4.0功能示例.application/接口测试.module/请假测试.module/自由流程测试.form/短信分享.summary/短信分享.summary",
"fieldNames": "备注",
"summaryScript": "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t",
"scope": 1,
"formId": "__xTeazT2hYRCoxwLzEpn",
"formName": "自由流程测试"
},
{
"id": "__4FNqiUuyxffhYKCTGuv",
"name": "请假申请通知",
"type": "01",
"title": "请假申请通知",
"uri": "/4.0功能示例.application/流程示例.module/流程类型.module/串行流程.form/请假申请通知.summary/请假申请通知.summary",
"fieldNames": "请假天数;备注;$FormName",
"summaryScript": " (function(){ \n var str = \"\"; \n var curDoc = getCurrentDocument(); \n var user=curDoc.getAuthor(); \n var username=curDoc.getAuthor().getName(); \n var depid = user.getDefaultDepartment(); \n var deptProcess=getDepartmentProcess(); \n var dept = deptProcess.doView(depid); \n var deptname=dept.getName(); \n str =\" 标题: \"+getItemValue(\"流程标题\"); \n str +=\" 申请人: \"+username; \n str +=\" 部门: \"+deptname; \n return str; \n })() ",
"scope": 1,
"formId": "9c0aqDXwpcfHP2G5wCv",
"formName": "串行流程"
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageCount | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | true | none | 摘要id | none |
| »»» name | string | true | none | 摘要名称 | none |
| »»» type | string | true | none | 摘要类型(脚本、设计) | none |
| »»» title | string | true | none | 摘要标题 | none |
| »»» uri | string | true | none | none | |
| »»» fieldNames | string | true | none | none | |
| »»» summaryScript | string | true | none | none | |
| »»» scope | integer | true | none | 作用域(1:流程通知、分享,6:流程抄送,0:待办摘要) | none |
| »»» formId | string | true | none | none | |
| »»» formName | string | true | none | none |
GET 获取表单摘要详情
GET /api/designtime/applications/summarys/{summaryId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| summaryId | path | string | 是 | 摘要id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__ARDGaHaysmhswgS4vee",
"name": "短信分享",
"title": "短信分享",
"type": "00",
"formId": "__xTeazT2hYRCoxwLzEpn",
"fieldNames": "备注",
"summaryScript": "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t",
"scope": 1,
"orderby": "LASTMODIFIED"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 摘要id | none |
| »» name | string | true | none | 摘要名称 | none |
| »» title | string | true | none | 摘要标题 | none |
| »» type | string | true | none | 摘要类型 | none |
| »» formId | string | true | none | 关联表单的ID | none |
| »» fieldNames | string | true | none | 摘要字段 | none |
| »» summaryScript | string | true | none | 摘要脚本 | none |
| »» scope | integer | true | none | 作用域 | none |
| »» orderby | string | true | none | none |
myApps设计时/ 视图(Views)
GET 获取视图列表(可根据名字或者描述查询)
GET /api/designtime/applications/modules/{moduleId}/views
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id | |
| searchword | query | string | 否 | 查询名称或者描述 | |
| pageNo | query | string | 否 | 当前页数 | |
| linesPerPage | query | string | 否 | 每页行数 | |
| filterType | query | string | 否 | 过滤的视图类型(用“,”分隔) |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "id",
"name": "name",
"description": "description"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none |
POST 复制视图
POST /api/designtime/applications/modules/views/copy
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | query | string | 是 | 软件id | |
| moduleId | query | string | 是 | 模块id | |
| viewId | query | string | 是 | 视图id | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 新建视图
POST /api/designtime/applications/{applicationId}/modules/{moduleId}/views
Body 请求参数
{
"name": "name",
"description": "description",
"pagination": true,
"linesPerPage": 10,
"showTotalRow": true,
"refresh": true,
"readonly": true,
"relatedMap": "relatedMap",
"displayType": "displayType",
"showWaterMark": true,
"waterMarkScript": "waterMarkScript",
"searchFormId": "searchFormId",
"styleId": "styleId",
"relatedForm": "relatedForm",
"templateForm": "templateForm",
"permissionType": "permissionType",
"filterScript": "filterScript",
"sqlFilterScript": "sqlFilterScript",
"procedureFilterScript": "procedureFilterScript",
"filterCondition": "filterCondition",
"commonFilterCondition": "commonFilterCondition",
"authorityCondition": "authorityCondition",
"openType": "openType",
"editMode": "editMode"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| viewType | query | string | 否 | 视图类型 | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 视图名称 | |
| » description | body | string | 是 | 描述 | |
| » pagination | body | boolean | 是 | 是否分页 | |
| » linesPerPage | body | integer | 是 | 每页显示记录 | |
| » showTotalRow | body | boolean | 是 | 是否显示总计数 | |
| » refresh | body | boolean | 是 | 是否刷新 | |
| » readonly | body | boolean | 是 | 是否只读 | |
| » relatedMap | body | string | 是 | 视图列映射 | |
| » displayType | body | string | 是 | 数据呈现类型 | |
| » showWaterMark | body | boolean | 是 | 显示水印 | |
| » waterMarkScript | body | string | 是 | 水印脚本 | |
| » searchFormId | body | string | 是 | 查询表单id | |
| » styleId | body | string | 是 | 样式库id | |
| » relatedForm | body | string | 是 | 关联表单 | |
| » templateForm | body | string | 是 | 模板表单 | |
| » permissionType | body | string | 是 | 授权方式 | |
| » filterScript | body | string | 是 | 过滤脚本(编辑模式为Dql模式) | |
| » sqlFilterScript | body | string | 是 | 过滤脚本(编辑模式为Sql模式) | |
| » procedureFilterScript | body | string | 是 | 过滤脚本(编辑模式为存储过程模式) | |
| » filterCondition | body | string | 是 | 过滤条件(编辑模式为设计模式) | |
| » commonFilterCondition | body | string | 是 | 常用过滤条件 | |
| » authorityCondition | body | string | 是 | 权限过滤条件 | |
| » openType | body | string | 是 | 打开类型 | |
| » editMode | body | string | 是 | 编辑模式 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取视图详情
GET /api/designtime/applications/modules/views/{viewId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| viewId | path | string | 是 | 视图id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__efHSNhgap0C0IFBqcIW",
"name": "表单显示操作日志",
"orderno": 0,
"pagination": true,
"pageLines": "10",
"showTotalRow": true,
"refresh": false,
"refreshAll": false,
"newPage": false,
"lastModifyTime": "2020-04-21T07:46:15.255+0000",
"readonly": false,
"defaultShowMode": "month",
"collapsibleShowMode": "normal",
"showWaterMark": false,
"showActivityColumnType": 0,
"editAble": true,
"readAble": true,
"columns": [
{
"id": "__6L9WxMvQFyIZUtwg12y",
"name": "文本框",
"parentView": "__efHSNhgap0C0IFBqcIW",
"type": "COLUMN_TYPE_FIELD",
"formid": "__ijb6q2A7qTjmEIUQsLM",
"fieldName": "文本框",
"flowReturnCss": false,
"orderno": 0,
"sum": false,
"total": false,
"isOrderByField": "false",
"clickSorting": true,
"thouSign": false,
"color": "000000",
"fontSize": "12",
"groundColor": "FFFFFF",
"showIcon": false,
"visible": true,
"visible4ExpExcel": true,
"visible4Print": true,
"visible4PagePrint": true,
"showType": "01",
"showMoon": false,
"showAsLabel": false,
"showAsButton": false,
"displayType": "00",
"displayLength": "-1",
"showTitle": true,
"hiddenColumn": false,
"customIcon": false,
"isFilter": false,
"isShowThisColumn": false
},
{
"id": "__Pat8Sfotlh3PhURIl39",
"name": "日期选择框",
"parentView": "__efHSNhgap0C0IFBqcIW",
"type": "COLUMN_TYPE_FIELD",
"formid": "__ijb6q2A7qTjmEIUQsLM",
"fieldName": "日期选择框",
"flowReturnCss": false,
"orderno": 1,
"sum": false,
"total": false,
"isOrderByField": "false",
"clickSorting": true,
"thouSign": false,
"color": "000000",
"fontSize": "12",
"groundColor": "FFFFFF",
"showIcon": false,
"visible": true,
"visible4ExpExcel": true,
"visible4Print": true,
"visible4PagePrint": true,
"showType": "01",
"showMoon": false,
"showAsLabel": false,
"showAsButton": false,
"displayType": "00",
"displayLength": "-1",
"showTitle": true,
"hiddenColumn": false,
"customIcon": false,
"isFilter": false,
"isShowThisColumn": false
},
{
"id": "__iRXKwwVvGEUoq3OpwJX",
"name": "文件上传",
"parentView": "__efHSNhgap0C0IFBqcIW",
"type": "COLUMN_TYPE_FIELD",
"formid": "__ijb6q2A7qTjmEIUQsLM",
"fieldName": "文件上传",
"flowReturnCss": false,
"orderno": 2,
"sum": false,
"total": false,
"isOrderByField": "false",
"clickSorting": true,
"thouSign": false,
"color": "000000",
"fontSize": "12",
"groundColor": "FFFFFF",
"showIcon": false,
"visible": true,
"visible4ExpExcel": true,
"visible4Print": true,
"visible4PagePrint": true,
"showType": "01",
"showMoon": false,
"showAsLabel": false,
"showAsButton": false,
"displayType": "00",
"displayLength": "-1",
"showTitle": true,
"hiddenColumn": false,
"customIcon": false,
"isFilter": false,
"isShowThisColumn": false
},
{
"id": "__FZp8mw1V67mLDCaqO5f",
"name": "多行文本框",
"parentView": "__efHSNhgap0C0IFBqcIW",
"type": "COLUMN_TYPE_FIELD",
"formid": "__ijb6q2A7qTjmEIUQsLM",
"fieldName": "多行文本框",
"flowReturnCss": false,
"orderno": 3,
"sum": false,
"total": false,
"isOrderByField": "false",
"clickSorting": true,
"thouSign": false,
"color": "000000",
"fontSize": "12",
"groundColor": "FFFFFF",
"showIcon": false,
"visible": true,
"visible4ExpExcel": true,
"visible4Print": true,
"visible4PagePrint": true,
"showType": "01",
"showMoon": false,
"showAsLabel": false,
"showAsButton": false,
"displayType": "00",
"displayLength": "-1",
"showTitle": true,
"hiddenColumn": false,
"customIcon": false,
"isFilter": false,
"isShowThisColumn": false
}
],
"autoCompose": false,
"relatedForm": "__ijb6q2A7qTjmEIUQsLM",
"permissionType": "public",
"openType": 1,
"activities": [
{
"id": "__MPs12NOIweNBle2ouiN",
"name": "新建",
"type": 2,
"onActionForm": "__ijb6q2A7qTjmEIUQsLM",
"readonly": false,
"editMode": 0,
"orderno": 0,
"parentView": "__efHSNhgap0C0IFBqcIW",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"parentFullName": "表单显示操作日志"
},
{
"id": "__860LDbOdqAGymiFiVHS",
"name": "删除",
"type": 3,
"readonly": false,
"editMode": 0,
"orderno": 1,
"parentView": "__efHSNhgap0C0IFBqcIW",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"parentFullName": "表单显示操作日志"
}
],
"editMode": "00",
"width": 0,
"height": 0,
"intValue": 1,
"fullName": "表单显示操作日志",
"clickSortingFieldArr": [
"ITEM_文本框 ASC",
"ITEM_日期选择框 ASC",
"ITEM_文件上传 ASC",
"ITEM_多行文本框 ASC"
],
"simpleClassName": "ListView",
"sum": false
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 视图id | none |
| »» name | string | true | none | 视图名称 | none |
| »» orderno | integer | true | none | none | |
| »» pagination | boolean | true | none | none | |
| »» pageLines | string | true | none | none | |
| »» showTotalRow | boolean | true | none | none | |
| »» refresh | boolean | true | none | 刷新 | none |
| »» refreshAll | boolean | true | none | 刷新全部 | none |
| »» newPage | boolean | true | none | none | |
| »» lastModifyTime | string | true | none | none | |
| »» readonly | boolean | true | none | none | |
| »» defaultShowMode | string | true | none | none | |
| »» collapsibleShowMode | string | true | none | none | |
| »» showWaterMark | boolean | true | none | none | |
| »» showActivityColumnType | integer | true | none | none | |
| »» editAble | boolean | true | none | none | |
| »» readAble | boolean | true | none | none | |
| »» columns | [object] | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» parentView | string | true | none | none | |
| »»» type | string | true | none | none | |
| »»» formid | string | true | none | none | |
| »»» fieldName | string | true | none | none | |
| »»» flowReturnCss | boolean | true | none | none | |
| »»» orderno | integer | true | none | none | |
| »»» sum | boolean | true | none | none | |
| »»» total | boolean | true | none | none | |
| »»» isOrderByField | string | true | none | none | |
| »»» clickSorting | boolean | true | none | none | |
| »»» thouSign | boolean | true | none | none | |
| »»» color | string | true | none | none | |
| »»» fontSize | string | true | none | none | |
| »»» groundColor | string | true | none | none | |
| »»» showIcon | boolean | true | none | none | |
| »»» visible | boolean | true | none | none | |
| »»» visible4ExpExcel | boolean | true | none | none | |
| »»» visible4Print | boolean | true | none | none | |
| »»» visible4PagePrint | boolean | true | none | none | |
| »»» showType | string | true | none | none | |
| »»» showMoon | boolean | true | none | none | |
| »»» showAsLabel | boolean | true | none | none | |
| »»» showAsButton | boolean | true | none | none | |
| »»» displayType | string | true | none | none | |
| »»» displayLength | string | true | none | none | |
| »»» showTitle | boolean | true | none | none | |
| »»» hiddenColumn | boolean | true | none | none | |
| »»» customIcon | boolean | true | none | none | |
| »»» isFilter | boolean | true | none | none | |
| »»» isShowThisColumn | boolean | true | none | none | |
| »» autoCompose | boolean | true | none | none | |
| »» relatedForm | string | true | none | none | |
| »» permissionType | string | true | none | none | |
| »» openType | integer | true | none | none | |
| »» activities | [object] | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» type | integer | true | none | none | |
| »»» onActionForm | string | false | none | none | |
| »»» readonly | boolean | true | none | none | |
| »»» editMode | integer | true | none | none | |
| »»» orderno | integer | true | none | none | |
| »»» parentView | string | true | none | none | |
| »»» jumpType | integer | true | none | none | |
| »»» expSub | boolean | true | none | none | |
| »»» disableFlowNode | boolean | true | none | none | |
| »»» changeFlowOperator | boolean | true | none | none | |
| »»» changeFlowCc | boolean | true | none | none | |
| »»» dispatcherMode | integer | true | none | none | |
| »»» jumpMode | integer | true | none | none | |
| »»» jumpActOpenType | integer | true | none | none | |
| »»» withOld | boolean | true | none | none | |
| »»» actionType | integer | true | none | none | |
| »»» actionSelection | integer | true | none | none | |
| »»» workFlowType | integer | true | none | none | |
| »»» contextMenu | boolean | true | none | none | |
| »»» showInToolbar | boolean | true | none | none | |
| »»» parentFullName | string | true | none | none | |
| »» editMode | string | true | none | none | |
| »» width | integer | true | none | none | |
| »» height | integer | true | none | none | |
| »» intValue | integer | true | none | none | |
| »» fullName | string | true | none | none | |
| »» clickSortingFieldArr | [string] | true | none | none | |
| »» simpleClassName | string | true | none | none | |
| »» sum | boolean | true | none | none |
PUT 更新视图
PUT /api/designtime/applications/{applicationId}/modules/{moduleId}/views/{viewId}
Body 请求参数
"{\n \"name\": \"name\",\n \"description\": \"description\",\n \"pagination\": true,\n \"linesPerPage\": 10,\n \"showTotalRow\": true,\n \"refresh\": true,\n \"readonly\": true,\n \"relatedMap\": \"relatedMap\",\n \"displayType\": \"displayType\",\n \"showWaterMark\": true,\n \"waterMarkScript\": \"waterMarkScript\",\n \"searchFormId\": \"searchFormId\",\n \"styleId\": \"styleId\",\n \"relatedForm\": \"relatedForm\",\n \"templateForm\": \"templateForm\",\n \"permissionType\": \"permissionType\",\n \"filterScript\": \"filterScript\",\n \"sqlFilterScript\": \"sqlFilterScript\",\n \"procedureFilterScript\": \"procedureFilterScript\",\n \"filterCondition\": \"filterCondition\",\n \"commonFilterCondition\": \"commonFilterCondition\",\n \"authorityCondition\": \"authorityCondition\",\n \n}\n"
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| viewId | path | string | 是 | 视图id | |
| viewType | query | string | 否 | 视图类型 | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 视图名称 | |
| » description | body | string | 是 | 描述 | |
| » pagination | body | boolean | 是 | 是否分页 | |
| » linesPerPage | body | integer | 是 | 每页显示记录 | |
| » showTotalRow | body | boolean | 是 | 是否显示总计数 | |
| » refresh | body | boolean | 是 | 是否刷新 | |
| » readonly | body | boolean | 是 | 是否只读 | |
| » relatedMap | body | string | 是 | 视图列映射 | |
| » displayType | body | string | 是 | 数据呈现类型 | |
| » showWaterMark | body | boolean | 是 | 显示水印 | |
| » waterMarkScript | body | string | 是 | 水印脚本 | |
| » searchFormId | body | string | 是 | 查询表单id | |
| » styleId | body | string | 是 | 样式库id | |
| » relatedForm | body | string | 是 | 关联表单 | |
| » templateForm | body | string | 是 | 模板表单 | |
| » permissionType | body | string | 是 | 授权方式 | |
| » filterScript | body | string | 是 | 过滤脚本(编辑模式为Dql模式) | |
| » sqlFilterScript | body | string | 是 | 过滤脚本(编辑模式为Sql模式) | |
| » procedureFilterScript | body | string | 是 | 过滤脚本(编辑模式为存储过程模式) | |
| » filterCondition | body | string | 是 | 过滤条件(编辑模式为设计模式) | |
| » commonFilterCondition | body | string | 是 | 常用过滤条件 | |
| » authorityCondition | body | string | 是 | 权限过滤条件 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除视图(可批量)
DELETE /api/designtime/applications/modules/views
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 一键生成视图
POST /api/designtime/applications/modules/views
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | query | string | 否 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除视图列(可批量)
DELETE /api/designtime/applications/modules/views/columns
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取视图列列表
GET /api/designtime/applications/modules/views/{viewId}/columns
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| viewId | path | string | 是 | 视图id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "id",
"name": "name",
"orderNo": "orderNo"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | false | none | 视图列id | none |
| »» name | string | false | none | 视图列名称 | none |
| »» orderNo | string | false | none | 排序号 | none |
GET 获取视图列详情
GET /api/designtime/applications/modules/views/columns/{columnId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| columnId | path | string | 是 | 列id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "e4mPoW3ONQCraI9qIu7",
"name": "备注",
"parentView": "AQ694g2I14fsf66Bnjc",
"type": "COLUMN_TYPE_FIELD",
"formid": "QmqwntKkFulspkYsjER",
"fieldName": "备注",
"flowReturnCss": false,
"orderno": 3,
"sum": false,
"total": false,
"isOrderByField": "false",
"clickSorting": true,
"thouSign": false,
"color": "000000",
"fontSize": "12",
"groundColor": "FFFFFF",
"showIcon": false,
"visible": true,
"visible4ExpExcel": true,
"visible4Print": true,
"visible4PagePrint": true,
"showType": "01",
"showMoon": false,
"showAsLabel": false,
"showAsButton": false,
"displayType": "00",
"displayLength": "-1",
"showTitle": true,
"hiddenColumn": false,
"customIcon": false,
"isFilter": false,
"isShowThisColumn": false
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» parentView | string | true | none | none | |
| »» type | string | true | none | none | |
| »» formid | string | true | none | none | |
| »» fieldName | string | true | none | none | |
| »» flowReturnCss | boolean | true | none | none | |
| »» orderno | integer | true | none | none | |
| »» sum | boolean | true | none | none | |
| »» total | boolean | true | none | none | |
| »» isOrderByField | string | true | none | none | |
| »» clickSorting | boolean | true | none | none | |
| »» thouSign | boolean | true | none | none | |
| »» color | string | true | none | none | |
| »» fontSize | string | true | none | none | |
| »» groundColor | string | true | none | none | |
| »» showIcon | boolean | true | none | none | |
| »» visible | boolean | true | none | none | |
| »» visible4ExpExcel | boolean | true | none | none | |
| »» visible4Print | boolean | true | none | none | |
| »» visible4PagePrint | boolean | true | none | none | |
| »» showType | string | true | none | none | |
| »» showMoon | boolean | true | none | none | |
| »» showAsLabel | boolean | true | none | none | |
| »» showAsButton | boolean | true | none | none | |
| »» displayType | string | true | none | none | |
| »» displayLength | string | true | none | none | |
| »» showTitle | boolean | true | none | none | |
| »» hiddenColumn | boolean | true | none | none | |
| »» customIcon | boolean | true | none | none | |
| »» isFilter | boolean | true | none | none | |
| »» isShowThisColumn | boolean | true | none | none |
POST 新建视图列
POST /api/designtime/applications/{applicationId}/modules/views/{viewId}/columns
Body 请求参数
{
"name": "name",
"parentView": "parentView",
"valueScript": "valueScript",
"hiddenScript": "hiddenScript",
"type": "type",
"formid": "formid",
"fieldName": "fieldName",
"fieldId": "fieldId",
"flowReturnCss": "flowReturnCss",
"imageName": "imageName",
"fontColor": "fontColor",
"orderNo": "orderNo",
"sum": "sum",
"total": "total",
"isOrderByField": "isOrderByField",
"multiLanguageLabel": "multiLanguageLabel",
"actionScript": "actionScript",
"clickSorting": "clickSorting",
"jumpMapping": "jumpMapping",
"mappingform": "mappingform",
"formatType": "formatType",
"decimalsNum": "decimalsNum",
"thouSign": "thouSign",
"decimalsCurr": "decimalsCurr",
"currType": "currType",
"color": "color",
"fontSize": "fontSize",
"groundColor": "groundColor",
"showIcon": "showIcon",
"iconMapping": "iconMapping",
"visible": "visible",
"visible4ExpExcel": "visible4ExpExcel",
"visible4Print": "visible4Print",
"visible4PagePrint": "visible4PagePrint",
"showType": "showType",
"displayType": "displayType",
"displayLength": "displayLength",
"showTitle": "showTitle"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| moduleId | query | string | 否 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 视图列名称 | |
| » parentView | body | string | 是 | 所属视图id | |
| » valueScript | body | string | 是 | 值脚本 | |
| » hiddenScript | body | string | 是 | 隐藏脚本 | |
| » type | body | string | 是 | 类型(COLUMN_TYPE_FIELD) | |
| » fieldName | body | string | 是 | 关联表单的字段名称 | |
| » fieldId | body | string | 是 | 关联表单的字段id | |
| » flowReturnCss | body | string | 是 | 需要回退时增加样式 | |
| » imageName | body | string | 是 | 回退的时候在前面的images | |
| » fontColor | body | string | 是 | 显示的字体 | |
| » orderNo | body | string | 是 | 排序号 | |
| » sum | body | string | 是 | 当前页小计 | |
| » total | body | string | 是 | 跨页总计 | |
| » isOrderByField | body | string | 是 | 默认排序 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » actionScript | body | string | 是 | 操作执行脚本 | |
| » clickSorting | body | string | 是 | 单击列头排序 | |
| » jumpMapping | body | string | 是 | 操作列跳转类型的映射配置 | |
| » mappingform | body | string | 是 | 跳转类型的目标表单ID | |
| » formatType | body | string | 是 | 列的格式的类型 | |
| » decimalsNum | body | string | 是 | 数值的小数位数 | |
| » thouSign | body | string | 是 | 千位分隔符 | |
| » decimalsCurr | body | string | 是 | 货币类型的小数位数 | |
| » currType | body | string | 是 | 货币类型 | |
| » color | body | string | 是 | 字体颜色 | |
| » fontSize | body | string | 是 | 字体大小 | |
| » groundColor | body | string | 是 | 底色 | |
| » showIcon | body | string | 是 | 以图标显示 | |
| » iconMapping | body | string | 是 | 以图标显示的映射关系 | |
| » visible | body | string | 是 | 视图列表时可见 | |
| » visible4ExpExcel | body | string | 是 | 导出Excel时可见 | |
| » visible4Print | body | string | 是 | 自定义打印时可见 | |
| » visible4PagePrint | body | string | 是 | 网页打印时可见 | |
| » showType | body | string | 是 | 字段值显示类型 | |
| » displayType | body | string | 是 | 显示方式 | |
| » displayLength | body | string | 是 | 显示内容的长度 | |
| » showTitle | body | string | 是 | 是否显示title |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
POST 批量新建视图列
POST /api/designtime/applications/{applicationId}/modules/views/{viewId}/columns/batch
Body 请求参数
"[\r\n {\r\n \"name\": \"name\",\r\n \"parentView\": \"parentView\",\r\n \"valueScript\": \"valueScript\",\r\n \"hiddenScript\": \"hiddenScript\",\r\n \"type\": \"type\",\r\n \"formid\": \"formid\",\r\n \"fieldName\": \"fieldName\",\r\n \"fieldId\": \"fieldId\"\r\n \"flowReturnCss\": \"flowReturnCss\",\r\n \"imageName\": \"imageName\",\r\n \"fontColor\": \"fontColor\",\r\n \"orderNo\": \"orderNo\",\r\n \"sum\": \"sum\",\r\n \"total\": \"total\",\r\n \"isOrderByField\": \"isOrderByField\",\r\n \"multiLanguageLabel\": \"multiLanguageLabel\",\r\n \"actionScript\": \"actionScript\",\r\n \"clickSorting\": \"clickSorting\",\r\n \"jumpMapping\": \"jumpMapping\",\r\n \"mappingform\": \"mappingform\",\r\n \"formatType\": \"formatType\",\r\n \"decimalsNum\": \"decimalsNum\",\r\n \"thouSign\": \"thouSign\",\r\n \"decimalsCurr\": \"decimalsCurr\",\r\n \"currType\": \"currType\",\r\n \"color\": \"color\",\r\n \"fontSize\": \"fontSize\",\r\n \"groundColor\": \"groundColor\",\r\n \"showIcon\": \"showIcon\",\r\n \"iconMapping\": \"iconMapping\",\r\n \"visible\": \"visible\",\r\n \"visible4ExpExcel\": \"visible4ExpExcel\",\r\n \"visible4Print\": \"visible4Print\",\r\n \"visible4PagePrint\": \"visible4PagePrint\",\r\n \"showType\": \"showType\",\r\n \"displayType\": \"displayType\",\r\n \"displayLength\": \"displayLength\",\r\n \"showTitle\": \"showTitle\"\r\n },...\r\n]"
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| body | body | array[object] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
"id1",
"id2"
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [string] | true | none | none |
GET 获取视图操作详情
GET /api/designtime/applications/modules/views/activitys/{activityId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| activityId | path | string | 是 | 视图操作id | |
| applicationId | query | string | 否 | 软件id | |
| moduleId | query | string | 否 | 模块id | |
| viewId | query | string | 否 | 视图id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "JVPW0nwzSEfo3FAvJuo",
"name": "删除",
"type": 3,
"readonly": false,
"editMode": 0,
"orderno": 1,
"parentView": "AQ694g2I14fsf66Bnjc",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"parentFullName": "是否可打开_false"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» type | integer | true | none | none | |
| »» readonly | boolean | true | none | none | |
| »» editMode | integer | true | none | none | |
| »» orderno | integer | true | none | none | |
| »» parentView | string | true | none | none | |
| »» jumpType | integer | true | none | none | |
| »» expSub | boolean | true | none | none | |
| »» disableFlowNode | boolean | true | none | none | |
| »» changeFlowOperator | boolean | true | none | none | |
| »» changeFlowCc | boolean | true | none | none | |
| »» dispatcherMode | integer | true | none | none | |
| »» jumpMode | integer | true | none | none | |
| »» jumpActOpenType | integer | true | none | none | |
| »» withOld | boolean | true | none | none | |
| »» actionType | integer | true | none | none | |
| »» actionSelection | integer | true | none | none | |
| »» workFlowType | integer | true | none | none | |
| »» contextMenu | boolean | true | none | none | |
| »» showInToolbar | boolean | true | none | none | |
| »» parentFullName | string | true | none | none |
GET 获取视图操作列表
GET /api/designtime/applications/modules/views/{viewId}/activitys
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| viewId | path | string | 是 | 视图id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "ufZ8U4JSGdjhnSV2KRN",
"name": "新建",
"type": 2,
"onActionForm": "5U53V3jAUgraQeUXO8B",
"readonly": false,
"editMode": 0,
"orderno": 0,
"parentView": "ct1cXUNvT8Sp69KhmnM",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"parentFullName": "是否可打开_true"
},
{
"id": "2kfCxr5UfrZWRwEeB1k",
"name": "删除",
"type": 3,
"readonly": false,
"editMode": 0,
"orderno": 1,
"parentView": "ct1cXUNvT8Sp69KhmnM",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"parentFullName": "是否可打开_true"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | true | none | 操作id | none |
| »» name | string | true | none | 操作名称 | none |
| »» type | integer | true | none | 动作类型 | none |
| »» onActionForm | string | false | none | none | |
| »» readonly | boolean | true | none | none | |
| »» editMode | integer | true | none | none | |
| »» orderno | integer | true | none | none | |
| »» parentView | string | true | none | 所属视图id | none |
| »» jumpType | integer | true | none | none | |
| »» expSub | boolean | true | none | none | |
| »» disableFlowNode | boolean | true | none | 禁止添加和删除流程节点 | none |
| »» changeFlowOperator | boolean | true | none | 仅允许修改流程节点操作人 | none |
| »» changeFlowCc | boolean | true | none | 仅允许修改流程抄送人 | none |
| »» dispatcherMode | integer | true | none | Dispatcher的模式 | none |
| »» jumpMode | integer | true | none | 跳转按钮模式 | none |
| »» jumpActOpenType | integer | true | none | 跳转按钮打开类型 | none |
| »» withOld | boolean | true | none | 是否带旧数据 | none |
| »» actionType | integer | true | none | none | |
| »» actionSelection | integer | true | none | none | |
| »» workFlowType | integer | true | none | none | |
| »» contextMenu | boolean | true | none | none | |
| »» showInToolbar | boolean | true | none | none | |
| »» parentFullName | string | true | none | none |
PUT 操作列表排序修改
PUT /api/designtime/applications/activity/order
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| oId | query | string | 否 | 选中操作按钮id | |
| nId | query | string | 否 | 互换操作按钮id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "修改成功"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
POST 新建视图操作
POST /api/designtime/applications/{applicationId}/modules/views/{viewId}/activitys
Body 请求参数
{
"name": "111",
"type": 2,
"onActionForm": "__kTZBUJsWDBI74HN854m",
"readonly": false,
"editMode": 0,
"orderno": 0,
"parentView": "__cqRvavJq5fVBnzx4oFw",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"processPreview": false,
"parentFullName": "name"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| moduleId | query | string | 否 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 操作名称 | |
| » parentView | body | string | 是 | 所属视图id | |
| » type | body | string | 是 | 动作类型 | |
| » beforeActionScript | body | string | 是 | 动作执行前脚本 | |
| » afterActionScript | body | string | 是 | 动作执行后脚本 | |
| » hiddenScript | body | string | 是 | 隐藏脚本 | |
| » readonlyScript | body | string | 是 | 只读脚本 | |
| » editMode | body | string | 是 | 编辑方式 | |
| » orderNo | body | string | 是 | 排序号 | |
| » jumpType | body | string | 是 | 跳转类型 | |
| » expSub | body | string | 是 | 是否导入子表数据 | |
| » disableFlowNode | body | string | 是 | 禁止添加和删除流程节点 | |
| » changeFlowOperator | body | string | 是 | 仅允许修改流程节点操作人 | |
| » changeFlowCc | body | string | 是 | 仅允许修改流程抄送人 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » dispatcherMode | body | string | 是 | Dispatcher的模式 | |
| » dispatcherUrl | body | string | 是 | Dispatcher的Url | |
| » dispatcherParams | body | string | 是 | Dispatcher的参数 | |
| » jumpMode | body | string | 是 | 跳转按钮模式 | |
| » jumpActOpenType | body | string | 是 | 跳转按钮打开类型 | |
| » withOld | body | string | 是 | 是否带旧数据 | |
| » actionType | body | string | 是 | none | |
| » actionSelection | body | string | 是 | none | |
| » workFlowType | body | string | 是 | 流程类型 | |
| » contextMenu | body | string | 是 | 右键菜单操作 | |
| » showInToolbar | body | string | 是 | 在工具栏中显示 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
PUT 更新视图列
PUT /api/designtime/applications/{applicationId}/modules/views/{viewId}/columns/{columnId}
Body 请求参数
"{\r\n \"name\": \"name\",\r\n \"parentView\": \"parentView\",\r\n \"valueScript\": \"valueScript\",\r\n \"hiddenScript\": \"hiddenScript\",\r\n \"type\": \"type\",\r\n \"formid\": \"formid\",\r\n \"fieldName\": \"fieldName\",\r\n \"fieldId\": \"fieldId\"\r\n \"flowReturnCss\": \"flowReturnCss\",\r\n \"imageName\": \"imageName\",\r\n \"fontColor\": \"fontColor\",\r\n \"orderNo\": \"orderNo\",\r\n \"sum\": \"sum\",\r\n \"total\": \"total\",\r\n \"isOrderByField\": \"isOrderByField\",\r\n \"multiLanguageLabel\": \"multiLanguageLabel\",\r\n \"actionScript\": \"actionScript\",\r\n \"clickSorting\": \"clickSorting\",\r\n \"jumpMapping\": \"jumpMapping\",\r\n \"mappingform\": \"mappingform\",\r\n \"formatType\": \"formatType\",\r\n \"decimalsNum\": \"decimalsNum\",\r\n \"thouSign\": \"thouSign\",\r\n \"decimalsCurr\": \"decimalsCurr\",\r\n \"currType\": \"currType\",\r\n \"color\": \"color\",\r\n \"fontSize\": \"fontSize\",\r\n \"groundColor\": \"groundColor\",\r\n \"showIcon\": \"showIcon\",\r\n \"iconMapping\": \"iconMapping\",\r\n \"visible\": \"visible\",\r\n \"visible4ExpExcel\": \"visible4ExpExcel\",\r\n \"visible4Print\": \"visible4Print\",\r\n \"visible4PagePrint\": \"visible4PagePrint\",\r\n \"showType\": \"showType\",\r\n \"displayType\": \"displayType\",\r\n \"displayLength\": \"displayLength\",\r\n \"showTitle\": \"showTitle\"\r\n}"
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| columnId | path | string | 是 | 视图列id | |
| moduleId | query | string | 否 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 视图列名称 | |
| » parentView | body | string | 是 | 所属视图id | |
| » valueScript | body | string | 是 | none | |
| » hiddenScript | body | string | 是 | none | |
| » type | body | string | 是 | none | |
| » formid | body | string | 是 | 关联表单id | |
| » fieldName | body | string | 是 | 关联表单字段姓名 | |
| » fieldId | body | string | 是 | 关联表单的字段id | |
| » flowReturnCss | body | string | 是 | 需要回退时增加样式 | |
| » imageName | body | string | 是 | none | |
| » fontColor | body | string | 是 | none | |
| » orderNo | body | string | 是 | none | |
| » sum | body | string | 是 | none | |
| » total | body | string | 是 | none | |
| » isOrderByField | body | string | 是 | none | |
| » multiLanguageLabel | body | string | 是 | none | |
| » actionScript | body | string | 是 | none | |
| » clickSorting | body | string | 是 | none | |
| » jumpMapping | body | string | 是 | none | |
| » mappingform | body | string | 是 | none | |
| » formatType | body | string | 是 | none | |
| » decimalsNum | body | string | 是 | none | |
| » thouSign | body | string | 是 | none | |
| » decimalsCurr | body | string | 是 | none | |
| » currType | body | string | 是 | none | |
| » color | body | string | 是 | none | |
| » fontSize | body | string | 是 | none | |
| » groundColor | body | string | 是 | none | |
| » showIcon | body | string | 是 | none | |
| » iconMapping | body | string | 是 | none | |
| » visible | body | string | 是 | none | |
| » visible4ExpExcel | body | string | 是 | none | |
| » visible4Print | body | string | 是 | none | |
| » visible4PagePrint | body | string | 是 | none | |
| » showType | body | string | 是 | none | |
| » displayType | body | string | 是 | none | |
| » displayLength | body | string | 是 | none | |
| » showTitle | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
PUT 更新视图操作
PUT /api/designtime/applications/{applicationId}/modules/views/{viewId}/activitys/{activityId}
Body 请求参数
{
"name": "测试22",
"type": 2,
"onActionForm": "__kTZBUJsWDBI74HN854m",
"readonly": false,
"editMode": 0,
"orderno": 0,
"parentView": "__cqRvavJq5fVBnzx4oFw",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"processPreview": false,
"parentFullName": "name"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| activityId | path | string | 是 | 视图操作id | |
| moduleId | query | string | 否 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 操作名称 | |
| » parentView | body | string | 是 | 所属视图id | |
| » type | body | string | 是 | 动作类型 | |
| » beforeActionScript | body | string | 是 | 动作执行前脚本 | |
| » afterActionScript | body | string | 是 | 动作执行后脚本 | |
| » hiddenScript | body | string | 是 | 隐藏脚本 | |
| » readonlyScript | body | string | 是 | 只读脚本 | |
| » editMode | body | string | 是 | 编辑方式 | |
| » orderNo | body | string | 是 | 排序号 | |
| » jumpType | body | string | 是 | 跳转类型 | |
| » expSub | body | string | 是 | 是否导入子表数据 | |
| » disableFlowNode | body | string | 是 | 禁止添加和删除流程节点 | |
| » changeFlowOperator | body | string | 是 | 仅允许修改流程节点操作人 | |
| » changeFlowCc | body | string | 是 | 仅允许修改流程抄送人 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » dispatcherMode | body | string | 是 | Dispatcher的模式 | |
| » dispatcherUrl | body | string | 是 | Dispatcher的Url | |
| » dispatcherParams | body | string | 是 | Dispatcher的参数 | |
| » jumpMode | body | string | 是 | 跳转按钮模式 | |
| » jumpActOpenType | body | string | 是 | 跳转按钮打开类型 | |
| » withOld | body | string | 是 | 是否带旧数据 | |
| » actionType | body | string | 是 | none | |
| » actionSelection | body | string | 是 | none | |
| » workFlowType | body | string | 是 | 流程类型 | |
| » contextMenu | body | string | 是 | 右键菜单操作 | |
| » showInToolbar | body | string | 是 | 在工具栏中显示 |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取数据来源表单字段(包含系统变量)
GET /api/designtime/applications/getFormValueStoreFields/{formId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| formId | path | string | 是 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"": "选择",
"姓名": "姓名",
"入职时间": "入职时间",
"个人照片": "个人照片",
"部门选择框": "部门选择框",
"职务": "职务",
"毕业学校": "毕业学校",
"最高学历": "最高学历",
"在校荣誉": "在校荣誉",
"备注": "备注",
"$Id": "$表单ID",
"$StateLabel": "$表单状态标签",
"$Created": "$表单创建时间",
"$AuditDate": "$表单审批日期",
"$LastModified": "$表单最后修改时间",
"$Author": "$表单作者",
"$AuditorNames": "$表单审批人名称",
"$LastFlowOperation": "$表单最后流程操作",
"$FormName": "$表单名称"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
myApps设计时/流程(Workflows)
GET 获取流程列表(可根据名字查询)
GET /api/designtime/applications/modules/{moduleId}/workflows
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页长度 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"pageNo": 1,
"linesPerPage": 2,
"rowCount": 1,
"data": [
{
"id": "__ZD1wi05IDDugRzDAVYO",
"name": "财务流程"
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none |
GET 获取流程详情
GET /api/designtime/applications/modules/workflows/{flowId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| flowId | path | string | 是 | 流程id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"authorname": "authorname",
"lastmodify": "lastmodify",
"subject": "subject",
"flow": "flow"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 流程id | |
| »» name | string | true | none | 流程名称 | |
| »» authorname | string | true | none | 创建人 | |
| »» lastmodify | object | true | none | 最后更新时间 | |
| »» subject | string | true | none | 流程主题 | |
| »» flow | string | true | none | 流程源代码 |
PUT 更新流程
PUT /api/designtime/applications/modules/workflows/{flowId}
Body 请求参数
{
"name": "name",
"authorname": "authorname",
"lastmodify": "lastmodify",
"subject": "subject",
"flow": "flow",
"parentId": "parentId",
"applicationid": "applicationid"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| flowId | path | string | 是 | 流程id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 流程名称 | |
| » authorname | body | string | 是 | 创建人id | |
| » lastmodify | body | string | 是 | 最后更新时间 | |
| » subject | body | string | 是 | 流程主题 | |
| » flow | body | string | 是 | 流程源代码 | |
| » parentId | body | string | 是 | none | |
| » applicationid | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 复制流程
POST /api/designtime/applications/modules/workflows/copy
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除流程(可批量)
DELETE /api/designtime/applications/modules/workflows
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 流程编辑器子流程获取父流程表单
GET /api/designtime/applications/{applicationId}/modules/workflows/flexGetForms
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| formName | query | string | 否 | 表单名称 | |
| moduleName | query | string | 否 | 模块名称 | |
| pageNo | query | string | 否 | 页码 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
POST 新建流程
POST /api/designtime/applications/{applicationId}/modules/{moduleId}/workflows
Body 请求参数
{
"name": "name",
"subject": "subject",
"flow": "flow"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 流程名称 | |
| » subject | body | string | 是 | 流程主题 | |
| » flow | body | string | 是 | 流程源代码 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取可回退节点列表
GET /api/designtime/applications/{applicationId}/modules/{moduleId}/workflows/{flowId}/nodes
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| flowId | path | string | 是 | 流程id | |
| type | query | string | 否 | 节点id | |
| nodeId | query | string | 否 | 类型 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET 获取流程参数列表
GET /api/designtime/applications/workflows/{flowId}/parameters
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| flowId | path | string | 是 | 流程id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "__2a49Gp4lSIarUgkygX2",
"name": "订单数量",
"description": "存储流程订单数量",
"orderno": 2,
"type": "number"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | false | none | none | |
| »» id | string | false | none | 流程参数id | |
| »» name | string | false | none | 流程参数名称 | |
| »» description | string | false | none | 流程参数说明 | |
| »» orderno | integer | false | none | 流程参数序号 | |
| »» type | string | false | none | 流程参数类型(文本:text,大文本:longtext,数字:number,日期:date) |
GET 根据当前节点获取其他节点
GET /api/designtime/applications/modules/workflows/{flowId}/node/{nodeId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| flowId | path | string | 是 | 流程id | |
| nodeId | path | string | 是 | 节点id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET 流程编辑器获取所有流程
GET /api/designtime/applications/{applicationId}/modules/workflows/flexGetBillDefiVOs
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| flowName | query | string | 否 | 流程名称 | |
| moduleName | query | string | 否 | 模块名称 | |
| pageNo | query | string | 否 | 页码 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
POST 批量保存流程参数
POST /api/designtime/applications/{applicationId}/workflows/{flowId}/parameters/batch
Body 请求参数
"[\n {//新建\n \"id\": \"\",\n \"name\": \"订单数量1\",\n \"type\": \"text\",\n \"description\": \"存储流程订单数量1\",\n \"orderno\": 0\n },\n {//更新\n \"id\": \"__AWFlab3ljx4B08bOSQF\",\n \"name\": \"订单数量3\",\n \"type\": \"date\",\n \"description\": \"存储流程订单数量2\",\n \"orderno\": 1\n }\n]\n"
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| flowId | path | string | 是 | 流程id | |
| body | body | array[object] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "__RR6Sj0Ak5kNi3sDr5p6",
"name": "订单数量1",
"description": "存储流程订单数量1",
"orderno": 0,
"type": "text"
},
{
"id": "__AWFlab3ljx4B08bOSQF",
"name": "订单数量3",
"description": "存储流程订单数量2",
"orderno": 1,
"type": "date"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | true | none | 流程参数ID | |
| »» name | string | true | none | 流程参数名称 | |
| »» description | string | true | none | 说明 | |
| »» orderno | integer | true | none | 序号 | |
| »» type | string | true | none | 类型(文本:text,大文本:longtext,数字:number,日期:date) |
myApps设计时/统计图(Charts)
GET 获取统计图列表(可根据名字或者备注查询)
GET /api/designtime/applications/modules/{moduleId}/charts
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id | |
| searchword | query | string | 否 | 查询名称或者备注 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageCount": 1,
"pageNo": 1,
"rowCount": 1,
"data": [
{
"id": "__wVsmajCTcp6zkzZOI1j",
"name": "单元测试666",
"note": "备注"
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageCount | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» note | string | false | none | none |
GET 获取统计图详情
GET /api/designtime/applications/charts/{chartId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| chartId | path | string | 是 | 统计图id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"type": "type",
"note": "note",
"scripttext": "scripttext"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 统计图id | |
| »» name | string | false | none | 统计图名称 | |
| »» scripttext | string | true | none | 脚本文本 |
DELETE 删除统计图(可批量)
DELETE /api/designtime/applications/charts
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新统计图
PUT /api/designtime/applications/charts
Body 请求参数
{
"applicationid": "sOZu9kthmxyP8qQfq0e",
"parentId": "__jdnS7aKT9LklWZGoZgD",
"name": "单元测试666",
"scripttext": "123456789",
"viewId": "",
"note": "备注",
"id": "id"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » applicationid | body | string | 是 | none | |
| » parentId | body | string | 是 | none | |
| » name | body | string | 是 | 统计图名称 | |
| » scripttext | body | string | 是 | 脚本文本 | |
| » viewId | body | string | 是 | none | |
| » note | body | string | 是 | 备注 | |
| » id | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 新建统计图
POST /api/designtime/applications/{applicationId}/modules/{moduleId}/charts
Body 请求参数
{
"name": "name",
"type": "type",
"note": "note",
"viewId": "viewId",
"scripttext": "scripttext"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 统计图名称 | |
| » type | body | string | 是 | 类型 | |
| » note | body | string | 是 | 备注 | |
| » viewId | body | string | 是 | none | |
| » scripttext | body | string | 是 | 脚本文本 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
myApps设计时/报表(Reports)
GET 获取报表详情
GET /api/designtime/applications/reports/{reportId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| reportId | path | string | 是 | 报表id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"description": "description",
"scriptTemplate": "scriptTemplate",
"xmlTemplate": "xmlTemplate",
"dataSourceType": "dataSourceType",
"dataSourceSearchForm": "dataSourceSearchForm",
"dataSourceSqlScript": "dataSourceSqlScript",
"dataSourceCustomScript": "dataSourceCustomScript",
"jrxmlFilePath": "jrxmlFilePath",
"dataSourceName": "dataSourceName",
"isDefaultStyle": 0,
"viewId": "viewId",
"reportExampleName": "reportExampleName",
"procedureScript": "procedureScript",
"templateType": "templateType"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 报表id | |
| »» name | string | true | none | 报表名称 | |
| »» description | string | true | none | 描述 | |
| »» scriptTemplate | string | true | none | 模板脚本 | |
| »» xmlTemplate | string | true | none | 模板xml | |
| »» dataSourceType | string | true | none | 数据源类型 | |
| »» dataSourceSearchForm | string | true | none | 数据源查询表单 | |
| »» dataSourceSqlScript | string | true | none | 数据源sql脚本 | |
| »» dataSourceCustomScript | string | true | none | 自定义数据源脚本 | |
| »» jrxmlFilePath | string | true | none | jrxml文件路径地址 | |
| »» dataSourceName | string | true | none | 数据源名称 | |
| »» isDefaultStyle | string | true | none | 默认样例 | |
| »» viewId | string | true | none | 关联视图id | |
| »» reportExampleName | string | true | none | 样例名称 | |
| »» procedureScript | string | true | none | 存储过程数据源脚本 | |
| »» templateType | string | true | none | 模板类型 |
GET 获取报表列表(可根据名字或者描述查询)
GET /api/designtime/applications/modules/{moduleId}/reports
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| moduleId | path | string | 是 | 模块id | |
| searchword | query | string | 否 | 查询名称或者描述 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 | |
| isPrint | query | string | 否 | 获取打印模板列表(参数为1) |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 8,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__jp7imGkVI5wSVEX27q7",
"uri": "/4.0功能示例.application/报表.module/报表示例.module/子报表.report/子报表.report",
"name": "子报表",
"description": "",
"scriptTemplate": "",
"xmlTemplate": "",
"dataSourceType": "DATASOURCE_TYPE_SQL",
"dataSourceSearchForm": "__evvfvKw6QFL8puXOiDK",
"dataSourceView": null,
"dataSourceSqlConnectDs": null,
"dataSourceSqlScript": "(function(){ \n var sql = \"select * from tlk_报表示例\"; \n return sql; \n \n })()",
"dataSourceCustomScript": "",
"jrxmlFilePath": "/workspace/4.0功能示例.application/报表.module/报表示例.module/子报表.report/子报表.jrxml",
"dataSourceName": "4.0功能示例",
"isDefaultStyle": "0",
"reportColumnInfos": null,
"jrxmlString": null,
"viewId": "__LzvbwJGuzjepcTM3ygs",
"domainId": null,
"reportExampleName": "",
"procedureScript": "",
"reportSql": null,
"subReportId": "",
"formId": "",
"isPrint": 0,
"templateType": "JRXML",
"drdataSource": null
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 报表id | |
| »»» uri | string | false | none | none | |
| »»» name | string | false | none | 报表名称 | |
| »»» description | string | false | none | 描述 | |
| »»» scriptTemplate | string | false | none | none | |
| »»» xmlTemplate | string | false | none | none | |
| »»» dataSourceType | string | false | none | none | |
| »»» dataSourceSearchForm | string | false | none | none | |
| »»» dataSourceView | null | false | none | none | |
| »»» dataSourceSqlConnectDs | null | false | none | none | |
| »»» dataSourceSqlScript | string | false | none | none | |
| »»» dataSourceCustomScript | string | false | none | none | |
| »»» jrxmlFilePath | string | false | none | none | |
| »»» dataSourceName | string | false | none | none | |
| »»» isDefaultStyle | string | false | none | none | |
| »»» reportColumnInfos | null | false | none | none | |
| »»» jrxmlString | null | false | none | none | |
| »»» viewId | string | false | none | none | |
| »»» domainId | null | false | none | none | |
| »»» reportExampleName | string | false | none | none | |
| »»» procedureScript | string | false | none | none | |
| »»» reportSql | null | false | none | none | |
| »»» subReportId | string | false | none | none | |
| »»» formId | string | false | none | none | |
| »»» isPrint | integer | false | none | 是否打印模板(0=否,1=是) | |
| »»» templateType | string | false | none | none | |
| »»» drdataSource | null | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建报表
POST /api/designtime/applications/{applicationId}/modules/{moduleId}/reports
Body 请求参数
{
"name": "报表名称",
"dataSourceName": "选择数据源名称",
"dataSourceType": "数据源类型",
"viewId": "视图数据源的视图",
"formId": "打印选的表单",
"dataSourceSqlScript": "sql数据源框",
"procedureScript": "存储过程数据源框",
"dataSourceCustomScript": "自定义数据源框",
"templateType": "内容页面的类型 设计或者脚本",
"jrxmlString": "报表的jrxml字符串",
"isDefaultStyle": "是否默认使用默认样例",
"jrxmlFilePath": "jrxml文件路径",
"subReportId": "子报表id",
"dataSourceSearchForm": "数据源查询表单",
"description": "备注",
"isPrint": 0
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 报表名称 | |
| » dataSourceName | body | string | 是 | none | |
| » dataSourceType | body | string | 是 | none | |
| » viewId | body | string | 是 | 关联视图id | |
| » formId | body | string | 是 | none | |
| » dataSourceSqlScript | body | string | 是 | 数据源sql脚本 | |
| » procedureScript | body | string | 是 | 存储过程数据源脚本 | |
| » dataSourceCustomScript | body | string | 是 | 自定义数据源脚本 | |
| » templateType | body | string | 是 | 模板类型 | |
| » jrxmlString | body | string | 是 | none | |
| » isDefaultStyle | body | string | 是 | 默认样例 | |
| » jrxmlFilePath | body | string | 是 | jrxml文件路径地址 | |
| » subReportId | body | string | 是 | none | |
| » dataSourceSearchForm | body | string | 是 | 数据源查询表单 | |
| » description | body | string | 是 | 描述 | |
| » isPrint | body | integer | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
PUT 更新报表
PUT /api/designtime/applications/reports
Body 请求参数
{
"applicationid": "sOZu9kthmxyP8qQfq0e",
"parentId": "__jdnS7aKT9LklWZGoZgD",
"name": "单元测试666",
"dataSourceName": "4.0功能示例",
"dataSourceType": "DATASOURCE_TYPE_SQL",
"viewId": "",
"formId": "",
"dataSourceSqlScript": "12345",
"procedureScript": "",
"dataSourceCustomScript": "",
"templateType": "JRXML",
"jrxmlString": "jrxmlstring12345",
"isDefaultStyle": "0",
"jrxmlFilePath": "路径",
"subReportId": "子报表id",
"dataSourceSearchForm": "",
"description": "备注",
"isPrint": 0,
"id": "id"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » applicationid | body | string | 是 | none | |
| » parentId | body | string | 是 | none | |
| » name | body | string | 是 | 报表名称 | none |
| » dataSourceName | body | string | 是 | 数据源名称 | none |
| » dataSourceType | body | string | 是 | 数据源类型 | none |
| » viewId | body | string | 是 | none | |
| » formId | body | string | 是 | none | |
| » dataSourceSqlScript | body | string | 是 | 数据源sql脚本 | none |
| » procedureScript | body | string | 是 | 存储过程数据源脚本 | none |
| » dataSourceCustomScript | body | string | 是 | none | |
| » templateType | body | string | 是 | none | |
| » jrxmlString | body | string | 是 | none | |
| » isDefaultStyle | body | string | 是 | none | |
| » jrxmlFilePath | body | string | 是 | none | |
| » subReportId | body | string | 是 | none | |
| » dataSourceSearchForm | body | string | 是 | none | |
| » description | body | string | 是 | none | |
| » isPrint | body | integer | 是 | none | |
| » id | body | string | 是 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除报表(可批量)
DELETE /api/designtime/applications/reports
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取jrxml字符串
GET /api/designtime/applications/reports/getJrxmlString
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| id | query | string | 否 | 报表id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "jrxmlString"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
POST 通过数据源获取返回结果集的列信息
POST /api/designtime/applications/{applicationId}/reports/getQueryColumnInfos
Body 请求参数
{
"scriptString": "scriptString"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| type | query | string | 否 | 数据源类型 | |
| reportId | query | string | 否 | 报表id | |
| dataSourceName | query | string | 否 | 数据源名称 | |
| viewId | query | string | 否 | 视图id | |
| body | body | object | 否 | none | |
| » scriptString | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"columnName": "所属公司",
"columnTypeName": "VALUE_TYPE_VARCHAR",
"columnClassName": "java.lang.String",
"columnLabel": "所属公司"
},
{
"columnName": "代收公司",
"columnTypeName": "VALUE_TYPE_VARCHAR",
"columnClassName": "java.lang.String",
"columnLabel": "代收公司"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | false | none | none | |
| »» columnName | string | true | none | none | |
| »» columnTypeName | string | true | none | none | |
| »» columnClassName | string | true | none | none | |
| »» columnLabel | string | true | none | none |
GET 获取ReportExamples的iscript脚本
GET /api/designtime/applications/reports/getExampleIscriptString
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| exampleName | query | string | 否 | 示例名称 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "iscriptString"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | |
| » errmsg | string | true | none | 状态码对应的信息文本 |
POST 接收上传图片接口
POST /api/designtime/applications/reports/uploadImageFile
Body 请求参数
string
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | string(binary) | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "realPath"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 返回报表的jasper文件路径
GET /api/designtime/applications/reports/getReportJasperPath
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| reportId | query | string | 否 | 报表id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "realPath"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | |
| » errmsg | string | true | none | 状态码对应的信息文本 | |
| » data | string | true | none | japser文件路径 |
GET 返回企业域列表
GET /api/designtime/applications/reports/getDomainList
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"name": "测试",
"id": "3CffNlgt9B9StIjIUPB",
"status": 1,
"logoUrl": "",
"systemName": "",
"users": [
{
"userid": "2TE7lzsbdyqLhndabbN",
"username": "sam_hr"
},
{
"userid": "zPsp2hk7CEwtqeMCwtj",
"username": "大间谍"
},
{
"userid": "iM16sApAfO0CdXXFnOH",
"username": "RU"
}
]
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» name | string | false | none | none | |
| »» id | string | false | none | none | |
| »» status | integer | false | none | none | |
| »» logoUrl | string | false | none | none | |
| »» systemName | string | false | none | none | |
| »» users | [object] | false | none | none | |
| »»» userid | string | true | none | none | |
| »»» username | string | true | none | none |
GET 报表预览返回html路径
GET /api/designtime/applications/reports/showjrxml/{id}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| id | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "htmlPath"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码 | |
| » errmsg | string | true | none | 状态码对应的信息文本 | |
| » data | string | false | none | html路径 |
myApps设计时/角色(Roles)
GET 获取角色列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/roles
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 第几页 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 22,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "fBUXdkAlWTdGXqOq4cI",
"name": "员工",
"roleNo": "002",
"status": 1,
"defaultRole": true,
"sortId": null,
"permission": null
},
"...."
],
"pageCount": 3
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 角色id | |
| »»» name | string | false | none | 角色名称 | |
| »»» roleNo | string | false | none | none | |
| »»» status | integer | false | none | none | |
| »»» defaultRole | boolean | false | none | none | |
| »»» sortId | null | false | none | none | |
| »»» permission | null | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建角色
POST /api/designtime/applications/{applicationId}/roles
Body 请求参数
{
"name": "name",
"roleNo": "roleNo",
"status": 1,
"defaultRole": true
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 角色名称 | |
| » roleNo | body | string | 是 | 编号 | |
| » status | body | integer | 是 | 激活状态(0 | |
| » defaultRole | body | boolean | 是 | 系统默认角色(true |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取角色详情
GET /api/designtime/applications/roles/{roleId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| roleId | path | string | 是 | 角色id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"roleNo": "roleNo",
"status": "status",
"defaultRole": "defaultRole"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 角色id | |
| »» name | string | true | none | 角色名称 | |
| »» roleNo | string | true | none | 编号 |
PUT 更新角色
PUT /api/designtime/applications/roles/{roleId}
Body 请求参数
{
"name": "name",
"roleNo": "roleNo",
"status": 1,
"defaultRole": true
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| roleId | path | string | 是 | 角色id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 角色名称 | |
| » roleNo | body | string | 是 | 编号 | |
| » status | body | integer | 是 | 激活状态(0 | |
| » defaultRole | body | boolean | 是 | 系统默认角色(true |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除角色(可批量)
DELETE /api/designtime/applications/roles
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/菜单(Menus)
GET 获取菜单列表(根据上级)
GET /api/designtime/applications/{applicationId}/menus
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| isMobile | query | string | 否 | 是否移动端(true或false) | |
| parentId | query | string | 否 | 父级id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"superior": "",
"hasChild": false,
"name": "报表示例",
"id": "__iOzzZe327RbzWp9pVGK",
"applicationId": "sOZu9kthmxyP8qQfq0e",
"uri": "/4.0功能示例.application/报表示例.menu/报表示例.menu"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» superior | string | false | none | 上级菜单id | |
| »» hasChild | boolean | false | none | none | |
| »» name | string | false | none | 菜单名称 | |
| »» id | string | false | none | 菜单id | |
| »» applicationId | string | false | none | none | |
| »» uri | string | false | none | none |
POST 新建菜单
POST /api/designtime/applications/{applicationId}/menus
Body 请求参数
{
"name": "name",
"description": "description",
"multiLanguageLabel": "multiLanguageLabel",
"type": "type",
"opentarget": "opentarget",
"ico": "ico",
"superior": "superior",
"linkName": "linkName",
"linkType": "linkType",
"moduleid": "moduleid",
"directory": "directory",
"actionContent": "actionContent",
"queryString": "queryString",
"permissionType": "permissionType",
"showType": "showType",
"isUsual": "isUsual",
"isMobile": "isMobile",
"orderno": 0,
"showtotalrow": "showtotalrow"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| isMobile | query | string | 否 | 是否为移动端 | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 菜单名称 | |
| » description | body | string | 是 | 描述 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » type | body | string | 是 | 类型 | |
| » opentarget | body | string | 是 | 打开链接方式 | |
| » ico | body | string | 是 | 图标 | |
| » superior | body | string | 是 | 上级菜单id | |
| » linkName | body | string | 是 | 菜单名称 | |
| » linkType | body | string | 是 | 链接类型 | |
| » moduleid | body | string | 是 | 模块id | |
| » directory | body | string | 是 | 目录 | |
| » actionContent | body | string | 是 | 动作内容 | |
| » queryString | body | string | 是 | 参数 | |
| » permissionType | body | string | 是 | 权限 | |
| » showType | body | string | 是 | 显示方式 | |
| » isUsual | body | string | 是 | 是否常用 | |
| » isMobile | body | string | 是 | 是否为手机菜单 | |
| » orderno | body | integer | 是 | 排序号 | |
| » showtotalrow | body | string | 是 | 是否显示记录总数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
POST 复制菜单
POST /api/designtime/applications/{applicationId}/menus/copy
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| destid | query | string | 否 | 目标上级菜单 | |
| isMobile | query | string | 否 | 是否移动端 | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取菜单详情
GET /api/designtime/applications/menus/{menuId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| menuId | path | string | 是 | 菜单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "XjlBS3EkUoFjn0uKyqz",
"name": "辅助测试",
"description": "辅助测试",
"type": "00",
"opentarget": "detail",
"ico": "{\"icon\":\"/uploads/lib/icon//p01_home.png\",\"icontype\":\"img\"}",
"allowOpenFrom": true,
"allowOpenView": true,
"linkName": "辅助测试",
"moduleid": "QupVVCsnfsHo0munijD",
"directory": "portal",
"actionContent": "CCmRfhRrW6fdHivAxlk",
"actionExcelImport": "__6XGibM8vHvaKjA1XJeS",
"queryString": "[]",
"permissionType": "public",
"showType": 0,
"isUsual": "false",
"isMobile": "false",
"orderno": 10,
"showtotalrow": "false",
"htmlTerminal": true,
"mobileTerminal": true
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 菜单id | |
| »» name | string | true | none | 菜单名称 | |
| »» description | string | true | none | 描述 | |
| »» type | string | true | none | 类型 | |
| »» opentarget | string | true | none | 打开链接方式图标 | |
| »» ico | string | true | none | 上级菜单id | |
| »» allowOpenFrom | boolean | true | none | none | |
| »» allowOpenView | boolean | true | none | none | |
| »» linkName | string | true | none | 菜单名称 | |
| »» directory | string | true | none | 目录 | |
| »» actionExcelImport | string | true | none | none | |
| »» queryString | string | true | none | 参数 | |
| »» permissionType | string | true | none | 权限 | |
| »» showType | integer | true | none | 显示方式 | |
| »» isUsual | string | true | none | 是否常用 | |
| »» isMobile | string | true | none | 是否为手机菜单 | |
| »» orderno | integer | true | none | 排序号 | |
| »» showtotalrow | string | true | none | 是否显示记录总数 | |
| »» htmlTerminal | boolean | true | none | none | |
| »» mobileTerminal | boolean | true | none | none |
DELETE 删除菜单(可批量)
DELETE /api/designtime/applications/menus
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新菜单
PUT /api/designtime/applications/{applicationId}/menus/{menuId}
Body 请求参数
{
"name": "菜单设置",
"description": "菜单设置",
"type": "00",
"opentarget": "detail",
"ico": "{\"icon\":\"/uploads/lib/icon_menu_default.png\",\"icontype\":\"img\"}",
"allowOpenFrom": true,
"allowOpenView": true,
"superior": "__juPWC9gtbnNzallhev6",
"linkName": "菜单设置",
"directory": "portal",
"actionExcelImport": "__6XGibM8vHvaKjA1XJeS",
"queryString": "[]",
"permissionType": "public",
"showType": 0,
"status": 1,
"isUsual": "false",
"isMobile": "false",
"orderno": 0,
"showtotalrow": "false",
"htmlTerminal": true,
"mobileTerminal": true
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| menuId | path | string | 是 | 菜单id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 菜单名称 | |
| » description | body | string | 是 | 描述 | |
| » multiLanguageLabel | body | string | 是 | 多语言标签 | |
| » type | body | string | 是 | 类型 | |
| » opentarget | body | string | 是 | 打开链接方式 | |
| » ico | body | string | 是 | 图标 | |
| » superior | body | string | 是 | 上级菜单id | |
| » linkName | body | string | 是 | 菜单名称 | |
| » linkType | body | string | 是 | 链接类型 | |
| » moduleid | body | string | 是 | 模块id | |
| » directory | body | string | 是 | 目录 | |
| » actionContent | body | string | 是 | 动作内容 | |
| » queryString | body | string | 是 | 参数 | |
| » permissionType | body | string | 是 | 权限 | |
| » showType | body | string | 是 | 显示方式 | |
| » isUsual | body | string | 是 | 是否常用 | |
| » isMobile | body | string | 是 | 是否为手机菜单 | |
| » orderno | body | integer | 是 | 排序号 | |
| » showtotalrow | body | string | 是 | 是否显示记录总数 |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取所有菜单
GET /api/designtime/applications/{applicationId}/menu/getAllMenus
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| currentMenuId | query | string | 否 | 当前菜单id | |
| type | query | string | 否 | 菜单类型 | |
| showType | query | string | 否 | 类型 | |
| name | query | string | 否 | 菜单名称 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "",
"value": "无"
},
{
"id": "__CAQYDSxmmOxMhrnq9b5",
"value": "接口测试"
},
{
"id": "__nIR7tcVaHuUwph5r4cc",
"value": "|---请假测试"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | true | none | none | |
| »» value | string | true | none | none |
POST 根据表单创建菜单
POST /api/designtime/applications/{applicationId}/form/{formId}/menus
Body 请求参数
{
"name": "name",
"superior": "superior"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| formId | path | string | 是 | 表单id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 菜单名称 | |
| » superior | body | string | 是 | 上级菜单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 根据视图创建菜单
POST /api/designtime/applications/{applicationId}/view/{viewId}/menus
Body 请求参数
{
"name": "name",
"superior": "superior"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| viewId | path | string | 是 | 视图id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » superior | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取图标集合
GET /api/designtime/applications/icons
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"name": "icon-workflow.png",
"size": "32 x 32",
"length": "1.26 KB",
"width": 32,
"path": "/uploads/lib/icon/icon-workflow.png",
"fileType": 1
},
{
"name": "p01_home.png",
"size": "200 x 200",
"length": "4.71 KB",
"width": 200,
"path": "/uploads/lib/icon/p01_home.png",
"fileType": 1
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | 返回码(0=成功,1=失败) | |
| » errmsg | string | true | none | 对返回码的文本描述内容 | |
| » data | [object] | true | none | none | |
| »» name | string | true | none | logo名称 | |
| »» size | string | true | none | logo尺寸 | |
| »» length | string | true | none | 文件大小 | |
| »» width | integer | true | none | none | |
| »» path | string | true | none | logo路径 | |
| »» fileType | integer | true | none | 文件类型 |
DELETE 删除自定义图标
DELETE /api/designtime/applications/icon
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| path | query | string | 否 | 自定义icon的相对路径 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "删除成功"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
myApps设计时/小工具分组(WidgetGroups)
GET 获取小工具分组列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/widgetgroups
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| pageNo | query | string | 否 | 页数 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__ayykf8u58vxeQy3Iz0R",
"name": "新建的分组",
"description": null
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» description | null | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建小工具分组
POST /api/designtime/applications/{applicationId}/widgetgroups
Body 请求参数
{
"name": "分组1"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» id | string | true | none | none |
GET 获取小工具分组详情
GET /api/designtime/applications/widgetgroups/{widgetGroupId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| widgetGroupId | path | string | 是 | 主键 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__xJrXAvDoriby36odtOF",
"name": "新建的分组改名",
"description": null
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» description | null | true | none | none |
PUT 更新小工具分组
PUT /api/designtime/applications/{applicationId}/widgetgroups/{widgetGroupId}
Body 请求参数
{
"name": "改名分组"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| widgetGroupId | path | string | 是 | 主键 | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none |
DELETE 删除小工具分组(可批量)
DELETE /api/designtime/applications/widgetgroups
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none |
myApps设计时/小工具 (Widgets)
GET 获取小工具列表
GET /api/designtime/applications/{applicationId}/widgets
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| widgetGroupId | query | string | 否 | 小工具分组id | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageCount": 1,
"pageNo": 1,
"rowCount": 3,
"data": [
{
"id": "__7yF3Ta1M06pk8NkDJ8M",
"name": "统计图",
"type": "chart",
"published": true,
"orderNo": 2
},
{
"id": "__I4G5rQJjGOPznbmK93n",
"name": "统计图跳转视图",
"type": "chart",
"published": true,
"orderNo": 3
},
{
"id": "__HqIe9aH2G8QOlDGXjht",
"name": "流程处理",
"type": "system_workflow",
"published": true,
"orderNo": 1
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageCount | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | true | none | 小工具id | |
| »»» name | string | true | none | 小工具名称 | |
| »»» type | string | true | none | 类型 | |
| »»» published | boolean | true | none | 是否发布 | |
| »»» orderNo | integer | true | none | 排序号 |
POST 新建小工具
POST /api/designtime/applications/{applicationId}/widgets
Body 请求参数
{
"name": "单元测试666",
"type": "view",
"moduleid": "__jdnS7aKT9LklWZGoZgD",
"actionContent": "__LzvbwJGuzjepcTM3ygs",
"width": "",
"height": "",
"authMode": 0,
"authRolesId": "",
"authRolesName": "",
"published": true,
"icon": "{\"icon\":\"if-lib icon-xinwenxinxi\",\"icontype\":\"font\",\"iconFontColor\":\"#000\"}",
"titleColor": "#000",
"titleBColor": "",
"iconShow": "",
"widgetType": 0,
"orderNo": "1"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 小工具名称 | |
| » type | body | string | 是 | 类型 | |
| » moduleid | body | string | 是 | 模块id | |
| » actionContent | body | string | 是 | 动作内容 | |
| » width | body | string | 是 | 宽度 | |
| » height | body | string | 是 | 高度 | |
| » authMode | body | integer | 是 | 授权方式 | |
| » authRolesId | body | string | 是 | 授权角色id | |
| » authRolesName | body | string | 是 | 授权角色名称 | |
| » published | body | boolean | 是 | 是否发布 | |
| » icon | body | string | 是 | 图标 | |
| » titleColor | body | string | 是 | 标题颜色 | |
| » titleBColor | body | string | 是 | 标题背景颜色 | |
| » iconShow | body | string | 是 | 图标形式显示 | |
| » widgetType | body | integer | 是 | 支持类型 | |
| » orderNo | body | string | 是 | 排序号 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» id | string | true | none | none |
PUT 更新小工具
PUT /api/designtime/applications/widgets
Body 请求参数
{
"name": "单元测试666",
"type": "view",
"moduleid": "__jdnS7aKT9LklWZGoZgD",
"actionContent": "__LzvbwJGuzjepcTM3ygs",
"width": "",
"height": "",
"authMode": 0,
"authRolesId": "",
"authRolesName": "",
"published": true,
"icon": "{\"icon\":\"if-lib icon-xinwenxinxi\",\"icontype\":\"font\",\"iconFontColor\":\"#000\"}",
"titleColor": "#000",
"titleBColor": "",
"iconShow": "",
"widgetType": 0,
"orderNo": "1"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| widgetId | query | string | 否 | 小工具id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 小工具名称 | |
| » type | body | string | 是 | 类型 | |
| » moduleid | body | string | 是 | 模块id | |
| » actionContent | body | string | 是 | 动作内容 | |
| » width | body | string | 是 | 宽度 | |
| » height | body | string | 是 | 高度 | |
| » authMode | body | integer | 是 | 授权方式 | |
| » authRolesId | body | string | 是 | 授权角色id | |
| » authRolesName | body | string | 是 | 授权角色名称 | |
| » published | body | boolean | 是 | 是否发布 | |
| » icon | body | string | 是 | 图标 | |
| » titleColor | body | string | 是 | 标题颜色 | |
| » titleBColor | body | string | 是 | 标题背景颜色 | |
| » iconShow | body | string | 是 | 图标形式显示 | |
| » widgetType | body | integer | 是 | 支持类型 | |
| » orderNo | body | string | 是 | 排序号 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | false | none | none | |
| »» id | string | true | none | none |
DELETE 删除小工具(可批量)
DELETE /api/designtime/applications/widgets
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | false | none | none |
GET 获取小工具详情
GET /api/designtime/applications/widgets/{widgetId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| widgetId | path | string | 是 | 小工具id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"summaryName": "",
"data": {
"id": "__C6X9jDt7nWnMHi5cR0a",
"name": "单元测试666__C6X9jDt7nWnMHi5cR0a",
"description": null,
"type": "view",
"moduleid": "__jdnS7aKT9LklWZGoZgD",
"actionContent": "__LzvbwJGuzjepcTM3ygs",
"queryString": null,
"width": null,
"height": null,
"authMode": 0,
"authRolesId": null,
"authRolesName": null,
"published": true,
"icon": "{\"icon\":\"if-lib icon-xinwenxinxi\",\"icontype\":\"font\",\"iconFontColor\":\"#000\"}",
"icontype": null,
"titleColor": "#000",
"titleBColor": null,
"iconShow": false,
"widgetType": 0,
"orderno": null
}
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» summaryName | string | true | none | none | |
| »» data | object | true | none | none | |
| »»» id | string | true | none | 小工具id | |
| »»» name | string | true | none | 小工具名称 | |
| »»» description | null | true | none | none | |
| »»» type | string | true | none | 类型 | |
| »»» moduleid | string | true | none | 模块id | |
| »»» actionContent | string | true | none | 动作内容 | |
| »»» queryString | null | true | none | none | |
| »»» width | null | true | none | 宽度 | |
| »»» height | null | true | none | 高度 | |
| »»» authMode | integer | true | none | 授权方式 | |
| »»» authRolesId | null | true | none | 授权角色id | |
| »»» authRolesName | null | true | none | 授权角色名称 | |
| »»» published | boolean | true | none | 是否发布 | |
| »»» icon | string | true | none | 图标 | |
| »»» icontype | null | true | none | 图标类型 | |
| »»» titleColor | string | true | none | 标题颜色 | |
| »»» titleBColor | null | true | none | 标题背景颜色 | |
| »»» iconShow | boolean | true | none | 图标形式显示 | |
| »»» widgetType | integer | true | none | 支持类型 | |
| »»» orderno | null | true | none | 排序号 |
myApps设计时/任务(Tasks)
POST 新建任务
POST /api/designtime/applications/{applicationId}/tasks
Body 请求参数
"{\n\t\"name\": \"name11\",\n\t\"description\": \"测试测试\",\n\t\"type\": 1,\n\t\"runningTime\": \"2022-07-21T09:40:04.000+0000\",\n\t\"interval\": 1,\n\t\"period\": 0,\n\t\"runtimes\": 0,\n\t\"terminateScript\": \"\",\n\t\"taskScript\": \"测试测试\",\n\t\"modifyTime\": \"2022-07-21T09:35:50.000+0000\",\n\t\"creator\": \"Admin\",\n\t\"creatorid\": \"Ai6hllhNjS2ull9TKGb\",\n\t\"totalRuntimes\": 0,\n\t\"state\": 0,\n\t\"startupType\": 0,\n\t\"daysOfWeek\": [],\n\t\"dayOfMonth\": 1,\n\t\"repeatTimes\": 0,\n\t\"frequency\": 0,\n\t\"executedCount\": 0,\n\t\n}"
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| rDate | query | string | 否 | 运行日期 | |
| rTime | query | string | 否 | 运行时间 | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 任务名称 | none |
| » creatorid | body | string | 是 | 创建人id | none |
| » creator | body | string | 是 | 创建人 | none |
| » type | body | integer | 是 | 类型 | none |
| » startupType | body | integer | 是 | none | |
| » period | body | integer | 是 | 周期 | none |
| » description | body | string | 是 | 描述 | none |
| » terminateScript | body | string | 是 | none | |
| » taskScript | body | string | 是 | 任务脚本 | none |
| » id | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取任务列表(可根据名字或者描述查询)
GET /api/designtime/applications/{applicationId}/tasks
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| searchword | query | string | 否 | 查询名称或者描述 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__TclUNSaEQzATXeAS2op",
"name": "单元测试__TclUNSaEQzATXeAS2op",
"type": 1,
"description": "description",
"runningTime": "2020-04-27T09:27:07.000+0000",
"period": 0,
"runtimes": 0,
"terminateScript": "terminateScript",
"taskScript": "taskScript",
"modifyTime": "2020-05-07T08:23:25.093+0000",
"creator": "Admin",
"creatorid": "Ai6hllhNjS2ull9TKGb",
"totalRuntimes": 0,
"state": 0,
"startupType": 0,
"daysOfWeek": [],
"dayOfMonth": 1,
"repeatTimes": 0,
"frequency": 0,
"executedCount": 0,
"modifyTiemStr": "2020-05-07"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 任务id | |
| »»» name | string | false | none | 任务名称 | |
| »»» type | integer | false | none | none | |
| »»» description | string | false | none | none | |
| »»» runningTime | string | false | none | none | |
| »»» period | integer | false | none | 周期 | |
| »»» runtimes | integer | false | none | none | |
| »»» terminateScript | string | false | none | none | |
| »»» taskScript | string | false | none | none | |
| »»» modifyTime | string | false | none | 最后更新时间 | |
| »»» creator | string | false | none | 创建人 | |
| »»» creatorid | string | false | none | 创建人 | |
| »»» totalRuntimes | integer | false | none | none | |
| »»» state | integer | false | none | 启动状态 | |
| »»» startupType | integer | false | none | 启动类型 | |
| »»» daysOfWeek | [string] | false | none | none | |
| »»» dayOfMonth | integer | false | none | none | |
| »»» repeatTimes | integer | false | none | none | |
| »»» frequency | integer | false | none | none | |
| »»» executedCount | integer | false | none | 执行计数 | |
| »»» modifyTiemStr | string | false | none | none | |
| »» pageCount | integer | true | none | none |
DELETE 删除任务(可批量)
DELETE /api/designtime/applications/{applicationId}/tasks
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新任务
PUT /api/designtime/applications/tasks
Body 请求参数
{
"name": "测试",
"type": 1,
"description": "",
"runningTime": "",
"period": "",
"runtimes": "",
"terminateScript": "",
"taskScript": "",
"modifyTime": "",
"creator": "",
"creatorid": 0,
"totalRuntimes": "",
"state": "",
"startupType": 0,
"daysOfWeek": "",
"dayOfMonth": "",
"repeatTimes": "",
"frequency": "",
"executedCount": ""
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | query | string | 否 | 软件id | |
| taskId | query | string | 否 | 任务id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 任务名称 | none |
| » type | body | integer | 是 | 类型 | none |
| » description | body | string | 是 | 描述 | none |
| » runningTime | body | string | 是 | 运行时间 | none |
| » period | body | string | 是 | 周期 | none |
| » runtimes | body | integer | 是 | 运行次数 | none |
| » terminateScript | body | string | 是 | 终止脚本 | none |
| » taskScript | body | string | 是 | 任务脚本 | none |
| » modifyTime | body | string | 是 | 最后更新时间 | none |
| » creator | body | string | 是 | 创建人 | none |
| » creatorid | body | integer | 是 | 创建id | none |
| » totalRuntimes | body | string | 是 | 总运行次数 | none |
| » state | body | string | 是 | 启动状态 | none |
| » startupType | body | integer | 是 | 启动类型 | none |
| » daysOfWeek | body | string | 是 | 星期数 | none |
| » dayOfMonth | body | string | 是 | 每月运行日期 | none |
| » repeatTimes | body | string | 是 | 运行次数 | none |
| » frequency | body | string | 是 | 重复率 | none |
| » executedCount | body | string | 是 | 执行计数 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string",
"data": {
"id": "string"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取任务详情
GET /api/designtime/applications/tasks/{taskId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| taskId | path | string | 是 | 任务id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__TCAw86jn60Vwtna5TaI",
"name": "单元测试__TCAw86jn60Vwtna5TaI",
"type": 1,
"description": "description",
"runningTime": "2020-04-27T09:27:07.000+0000",
"period": 0,
"runtimes": 0,
"terminateScript": "terminateScript",
"taskScript": "taskScript",
"modifyTime": "2020-04-28T06:36:44.000+0000",
"creator": "Admin",
"creatorid": "",
"totalRuntimes": 0,
"state": 0,
"startupType": 0,
"daysOfWeek": [],
"dayOfMonth": 1,
"repeatTimes": 0,
"frequency": 0,
"executedCount": 0,
"modifyTiemStr": "2020-04-28"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 任务id | |
| »» name | string | true | none | 任务名称 | |
| »» type | integer | true | none | 类型 | |
| »» description | string | true | none | 描述 | |
| »» runningTime | string | true | none | 运行时间 | |
| »» period | integer | true | none | 周期 | |
| »» runtimes | integer | true | none | 运行次数 | |
| »» terminateScript | string | true | none | 终止脚本 | |
| »» taskScript | string | true | none | 任务脚本 | |
| »» modifyTime | string | true | none | 最后更新时间 | |
| »» creator | string | true | none | 创建人 | |
| »» creatorid | string | true | none | 创建人id | |
| »» totalRuntimes | integer | true | none | 总运行次数 | |
| »» state | integer | true | none | 启动状态 | |
| »» startupType | integer | true | none | 启动类型 | |
| »» daysOfWeek | [string] | true | none | 星期数 | |
| »» dayOfMonth | integer | true | none | 每月运行日期 | |
| »» repeatTimes | integer | true | none | 运行次数 | |
| »» frequency | integer | true | none | 重复率 | |
| »» executedCount | integer | true | none | 执行计数 | |
| »» modifyTiemStr | string | true | none | none |
PUT 开始任务
PUT /api/designtime/applications/task/start
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| rDate | query | string | 否 | 运行日期 | |
| rTime | query | string | 否 | 运行时间 | |
| id | query | string | 否 | 任务id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"runState": 1,
"msg": "定时任务已经启动"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» runState | integer | true | none | none | |
| »» msg | string | true | none | none |
PUT 停止任务
PUT /api/designtime/applications/task/stop
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| id | query | string | 否 | 任务id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"runState": 1,
"msg": "定时任务已经停止"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» runState | integer | true | none | none | |
| »» msg | string | true | none | none |
myApps设计时/状态标签(StateLabels)
DELETE 删除状态标签(可批量)
DELETE /api/designtime/applications/statelabels
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新状态标签
PUT /api/designtime/applications/statelabels
Body 请求参数
{
"name": "name",
"id": "id",
"parentId": "parentId",
"applicationid": "applicationid",
"description": "description",
"value": "value",
"orderNo": "orderNo"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » id | body | string | 是 | none | |
| » parentId | body | string | 是 | none | |
| » applicationid | body | string | 是 | none | |
| » description | body | string | 是 | none | |
| » value | body | string | 是 | none | |
| » orderNo | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取状态标签详情
GET /api/designtime/applications/statelabels/{stateLabelId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| stateLabelId | path | string | 是 | 状态标签id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "3vx33GoJUElQdo0VuWA",
"name": "人事",
"description": "",
"value": "人事",
"orderNo": "1"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 状态标签id | |
| »» name | string | true | none | 状态标签名称 | |
| »» description | string | true | none | 描述 | |
| »» value | string | true | none | 值 | |
| »» orderNo | string | true | none | 排序号 |
GET 获取状态标签列表(可根据名字或者描述查询)
GET /api/designtime/applications/{applicationId}/statelabels
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| searchword | query | string | 否 | 查询名称或者描述 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageCount": 1,
"pageNo": 1,
"rowCount": 1,
"data": [
{
"id": "3vx33GoJUElQdo0VuWA",
"name": "人事",
"description": "",
"value": "人事",
"orderNo": "1"
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageCount | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | false | none | 状态标签id | |
| »»» name | string | false | none | 状态标签名称 | |
| »»» description | string | false | none | 描述 | |
| »»» value | string | false | none | 值 | |
| »»» orderNo | string | false | none | 排序号 |
POST 新建状态标签
POST /api/designtime/applications/{applicationId}/statelabels
Body 请求参数
{
"name": "name",
"parentId": "parentId",
"applicationid": "applicationid",
"description": "description",
"value": "value",
"orderNo": "orderNo"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 状态标签名称 | |
| » parentId | body | string | 是 | none | |
| » applicationid | body | string | 是 | none | |
| » description | body | string | 是 | 描述 | |
| » value | body | string | 是 | 值 | |
| » orderNo | body | string | 是 | 排序号 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
myApps设计时/开发者(Developers)
GET 获取未加入软件的开发者列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/superusers/unjoin
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| name | query | string | 否 | 查询名字 | |
| pageNo | query | string | 否 | 当前页数 | |
| linesPerPage | query | string | 否 | 每页行数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "Ai6hllhNjS2ull9TKGb",
"name": "Admin",
"domains": null,
"applications": [
{
"id": "sOZu9kthmxyP8qQfq0e",
"name": "4.0功能示例",
"type": 0,
"description": "适用于4.0+版本的功能测试",
"activated": true
}
],
"loginno": "admin",
"loginpwd": "3e2708abc7e6158d446248d0d89cf6519ca9fec29b4e2384248e8554d394f1b4",
"email": null,
"status": 1,
"pwdErrorTimes": 0,
"superAdmin": true,
"developer": true,
"secret": "11ea-26da-744a17bc-bd03-5fe935119e1e"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 开发者id | |
| »»» name | string | false | none | 开发者名称 | |
| »»» domains | null | false | none | none | |
| »»» applications | [object] | false | none | none | |
| »»»» id | string | false | none | none | |
| »»»» name | string | false | none | none | |
| »»»» type | integer | false | none | none | |
| »»»» description | string | false | none | none | |
| »»»» activated | boolean | false | none | none | |
| »»» loginno | string | false | none | none | |
| »»» loginpwd | string | false | none | none | |
| null | false | none | none | ||
| »»» status | integer | false | none | none | |
| »»» pwdErrorTimes | integer | false | none | none | |
| »»» superAdmin | boolean | false | none | none | |
| »»» developer | boolean | false | none | none | |
| »»» secret | string | false | none | none | |
| »» pageCount | integer | true | none | none |
GET 获取已加入软件的开发者列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/superusers/join
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| name | query | string | 否 | 查询名字 | |
| pageNo | query | string | 否 | 当前页数 | |
| linesPerPage | query | string | 否 | 每页行数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "Ai6hllhNjS2ull9TKGb",
"name": "Admin",
"domains": null,
"applications": [
{
"id": "sOZu9kthmxyP8qQfq0e",
"name": "4.0功能示例",
"type": 0,
"description": "适用于4.0+版本的功能测试",
"activated": true
}
],
"loginno": "admin",
"loginpwd": "3e2708abc7e6158d446248d0d89cf6519ca9fec29b4e2384248e8554d394f1b4",
"email": null,
"status": 1,
"pwdErrorTimes": 0,
"superAdmin": true,
"developer": true,
"secret": "11ea-26da-744a17bc-bd03-5fe935119e1e"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 开发者id | |
| »»» name | string | false | none | 开发者名称 | |
| »»» domains | null | false | none | none | |
| »»» applications | [object] | false | none | none | |
| »»»» id | string | false | none | none | |
| »»»» name | string | false | none | none | |
| »»»» type | integer | false | none | none | |
| »»»» description | string | false | none | none | |
| »»»» activated | boolean | false | none | none | |
| »»» loginno | string | false | none | 账号 | none |
| »»» loginpwd | string | false | none | none | |
| null | false | none | 邮箱 | none | |
| »»» status | integer | false | none | none | |
| »»» pwdErrorTimes | integer | false | none | none | |
| »»» superAdmin | boolean | false | none | none | |
| »»» developer | boolean | false | none | none | |
| »»» secret | string | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 添加开发者(可批量)
POST /api/designtime/applications/{applicationId}/superusers
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 移除开发者(可批量)
DELETE /api/designtime/applications/{applicationId}/superusers
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取特权用户信息
GET /api/designtime/applications/getSuperuser
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "Ai6hllhNjS2ull9TKGb",
"name": "Admin1",
"loginno": "admin",
"loginpwd": "ffcbfbb450f0345bb6fce62e19e9f739e3e63070a2ada131595f66c12a0ca969",
"email": "1799568881@qq.com"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | 用户姓名 | |
| »» loginno | string | true | none | 用户账号 | |
| »» loginpwd | string | true | none | 用户密码 | |
| string | true | none | 邮箱 |
PUT 修改特权用户信息
PUT /api/designtime/applications/superuser/{userId}
Body 请求参数
{
"name": "name",
"email": "email",
"loginno": "loginno",
"loginpwd": "loginpwd"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| userId | path | string | 是 | 用户id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 用户姓名 | |
| body | string | 是 | 邮箱 | ||
| » loginno | body | string | 是 | 用户账号 | |
| » loginpwd | body | string | 是 | 用户密码 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/excel配置(ExcelConfigs)
GET 获取excel配置详情
GET /api/designtime/applications/{applicationId}/excelconfigs/{excelConfigId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| excelConfigId | path | string | 是 | excel配置id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"xml": "xml",
"templatePath": "templatePath"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | excel配置id | |
| »» name | string | true | none | excel配置名称 | |
| »» xml | string | true | none | 源代码 | |
| »» templatePath | string | true | none | 模板文件路径地址 |
GET 获取excel配置列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/excelconfigs
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 当前页数 | |
| linesPerPage | query | string | 否 | 每页行数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 2,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__6XGibM8vHvaKjA1XJeS",
"uri": "/4.0功能示例.application/as.excelconfig/as.excelconfig",
"name": "as",
"templatePath": "/uploads/exceltemplate/到达.xls"
},
{
"id": "__lr4xpsC2GullVuyW3p4",
"uri": "/4.0功能示例.application/操作按钮表单.excelconfig",
"name": "操作按钮表单",
"templatePath": "/uploads/exceltemplate/操作按钮表单.xls"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | true | none | excel配置id | |
| »»» name | string | true | none | excel配置名称 | |
| »»» templatePath | string | true | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建excel配置
POST /api/designtime/applications/{applicationId}/excelconfigs
Body 请求参数
{
"name": "name",
"xml": "xml",
"templatePath": "templatePath"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | excel配置名称 | |
| » xml | body | string | 是 | 源代码 | |
| » templatePath | body | string | 是 | 模板文件路径地址 |
返回示例
201 Response
{
"errcode": 0,
"errmsg": "string",
"data": {
"id": "string"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
PUT 更新excel配置
PUT /api/designtime/applications/{applicationId}/excelconfigs
Body 请求参数
{
"id": "id",
"name": "name",
"xml": "xml",
"templatePath": "templatePath"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| excelConfigId | query | string | 否 | excel配置id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | excel配置名称 | |
| » id | body | string | 是 | none | |
| » xml | body | string | 是 | 源代码 | |
| » templatePath | body | string | 是 | 模板文件路径地址 |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除excel配置(可批量)
DELETE /api/designtime/applications/excelconfigs
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/数据源(DataSources)
GET 获取数据源列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/datasources
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 1,
"pageNo": 1,
"datas": [
{
"id": "rDXojBcjqZudUraN1Yc",
"name": "trunk功能示例",
"description": null,
"useType": "JDBC",
"driverClass": "com.mysql.jdbc.Driver",
"url": "jdbc:mysql://localhost:3307/obpm_testcase5?useUnicode=true&characterEncoding=utf8&useSSL=false",
"username": "root",
"password": "",
"dbType": 4,
"poolsize": "300",
"timeout": "3600",
"jndiName": null,
"providerUrl": null,
"initialContextFactory": null,
"urlPkgPrefixes": null,
"securityPrincipal": null,
"securityCredentials": null,
"readonly": false,
"readonlyUseType": "JDBC",
"readonlyDriverClass": null,
"readonlyUsername": null,
"readonlyPassword": null,
"readonlyUrl": null,
"readonlyPoolsize": null,
"readonlyTimeout": null,
"readonlyDbType": 0,
"readonlyJndiName": null,
"readonlyProviderUrl": null,
"readonlyInitialContextFactory": null,
"readonlyUrlPkgPrefixes": null,
"readonlySecurityPrincipal": null,
"readonlySecurityCredentials": null,
"dbTypeName": "MYSQL"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» description | null | false | none | none | |
| »»» useType | string | false | none | none | |
| »»» driverClass | string | false | none | none | |
| »»» url | string | false | none | none | |
| »»» username | string | false | none | none | |
| »»» password | string | false | none | none | |
| »»» dbType | integer | false | none | none | |
| »»» poolsize | string | false | none | none | |
| »»» timeout | string | false | none | none | |
| »»» jndiName | null | false | none | none | |
| »»» providerUrl | null | false | none | none | |
| »»» initialContextFactory | null | false | none | none | |
| »»» urlPkgPrefixes | null | false | none | none | |
| »»» securityPrincipal | null | false | none | none | |
| »»» securityCredentials | null | false | none | none | |
| »»» readonly | boolean | false | none | none | |
| »»» readonlyUseType | string | false | none | none | |
| »»» readonlyDriverClass | null | false | none | none | |
| »»» readonlyUsername | null | false | none | none | |
| »»» readonlyPassword | null | false | none | none | |
| »»» readonlyUrl | null | false | none | none | |
| »»» readonlyPoolsize | null | false | none | none | |
| »»» readonlyTimeout | null | false | none | none | |
| »»» readonlyDbType | integer | false | none | none | |
| »»» readonlyJndiName | null | false | none | none | |
| »»» readonlyProviderUrl | null | false | none | none | |
| »»» readonlyInitialContextFactory | null | false | none | none | |
| »»» readonlyUrlPkgPrefixes | null | false | none | none | |
| »»» readonlySecurityPrincipal | null | false | none | none | |
| »»» readonlySecurityCredentials | null | false | none | none | |
| »»» dbTypeName | string | false | none | none | |
| »» pageCount | integer | true | none | none |
DELETE 删除数据源(可批量)
DELETE /api/designtime/applications/{applicationId}/datasources
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
POST 新建数据源
POST /api/designtime/applications/{applicationId}/datasources
Body 请求参数
{
"name": "datasource123",
"useType": "JDBC",
"dbType": 4,
"driverClass": "com.mysql.jdbc.Driver",
"url": "jdbc:mysql://localhost:3306/obpm2_testcase?useUnicode=true&characterEncoding=utf8&useSSL=false",
"username": "root",
"password": "root",
"poolsize": "300",
"timeout": "3000",
"readonly": false,
"readonlyUseType": "",
"readonlyDbType": "",
"readonlyUsername": "",
"readonlyDriverClass": "",
"readonlyPassword": "",
"readonlyUrl": "",
"readonlyPoolsize": "",
"readonlyTimeout": "",
"readonlyJndiName": "",
"readonlyInitialContextFactory": "INITIAL_CONTEXT_FACTORY",
"readonlyUrlPkgPrefixes": "URL_PKG_PREFIXES",
"readonlyProviderUrl": "PROVIDER_URL",
"readonlySecurityPrincipal": "SECURITY_PRINCIPAL",
"readonlySecurityCredentials": "SECURITY_CREDENTIALS"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 数据源名称 | |
| » useType | body | string | 是 | 使用类型 | |
| » dbType | body | integer | 是 | 数据库类型 | |
| » driverClass | body | string | 是 | 数据驱动 | |
| » url | body | string | 是 | 地址 | |
| » username | body | string | 是 | 用户名称 | |
| » password | body | string | 是 | 密码 | |
| » poolsize | body | string | 是 | 连接池大小 | |
| » timeout | body | string | 是 | 连接超时时间 | |
| » readonly | body | boolean | 是 | none | |
| » readonlyUseType | body | string | 是 | none | |
| » readonlyDbType | body | string | 是 | none | |
| » readonlyUsername | body | string | 是 | none | |
| » readonlyDriverClass | body | string | 是 | none | |
| » readonlyPassword | body | string | 是 | none | |
| » readonlyUrl | body | string | 是 | none | |
| » readonlyPoolsize | body | string | 是 | none | |
| » readonlyTimeout | body | string | 是 | none | |
| » readonlyJndiName | body | string | 是 | none | |
| » readonlyInitialContextFactory | body | string | 是 | none | |
| » readonlyUrlPkgPrefixes | body | string | 是 | none | |
| » readonlyProviderUrl | body | string | 是 | none | |
| » readonlySecurityPrincipal | body | string | 是 | none | |
| » readonlySecurityCredentials | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取元数据列表
GET /api/designtime/applications/{applicationId}/datasources/getMetadata
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| datasourceId | query | string | 否 | 数据源id | |
| subNodes | query | string | 否 | 子节点 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "rDXojBcjqZudUraN1Yc",
"data": "4.0功能示例",
"state": "closed",
"attr": {
"id": "rDXojBcjqZudUraN1Yc",
"name": "4.0功能示例",
"appication": null,
"datasourceId": "rDXojBcjqZudUraN1Yc",
"curNode": "isDts",
"rel": "db_selected",
"subNodes": "isTables"
}
},
{
"id": "__AhqIuqXvRUzJGrv5okH",
"data": "接口测试",
"state": "closed",
"attr": {
"id": "__AhqIuqXvRUzJGrv5okH",
"name": "接口测试",
"appication": null,
"datasourceId": "__AhqIuqXvRUzJGrv5okH",
"curNode": "isDts",
"rel": "db",
"subNodes": "isTables"
}
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | true | none | none | |
| »» data | string | true | none | none | |
| »» state | string | true | none | none | |
| »» attr | object | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» appication | null | true | none | none | |
| »»» datasourceId | string | true | none | none | |
| »»» curNode | string | true | none | none | |
| »»» rel | string | true | none | none | |
| »»» subNodes | string | true | none | none |
GET 获取表字段信息
GET /api/designtime/applications/{applicationId}/datasources/getTable
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| datasourceId | query | string | 否 | 数据源id | |
| formId | query | string | 否 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"datasource": {
"id": "rDXojBcjqZudUraN1Yc",
"name": "trunk功能示例",
"description": null,
"useType": "JDBC",
"driverClass": "com.mysql.jdbc.Driver",
"url": "jdbc:mysql://localhost:3307/obpm_testcase5?useUnicode=true&characterEncoding=utf8&useSSL=false",
"username": "root",
"password": "",
"dbType": 4,
"poolsize": "300",
"timeout": "3600",
"jndiName": null,
"providerUrl": null,
"initialContextFactory": null,
"urlPkgPrefixes": null,
"securityPrincipal": null,
"securityCredentials": null,
"readonly": false,
"readonlyUseType": "JDBC",
"readonlyDriverClass": null,
"readonlyUsername": null,
"readonlyPassword": null,
"readonlyUrl": null,
"readonlyPoolsize": null,
"readonlyTimeout": null,
"readonlyDbType": 0,
"readonlyJndiName": null,
"readonlyProviderUrl": null,
"readonlyInitialContextFactory": null,
"readonlyUrlPkgPrefixes": null,
"readonlySecurityPrincipal": null,
"readonlySecurityCredentials": null,
"dbTypeName": "MYSQL"
},
"form": {
"id": "__evvfvKw6QFL8puXOiDK",
"name": "报表示例",
"templatecontext": "<p> </p>\n<table width=\"100%\" border=\"1\" cellpadding=\"1\" cellspacing=\"1\" style=\"border: 1px solid rgb(180, 204, 238);\">\n <tbody>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">所属公司:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__b39VC4C9dlhjmsJhrxA\" text=\"text\" name=\"所属公司\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">代收/代付公司:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__Pa6embGTxCTiIwTaLaz\" text=\"text\" name=\"代收公司\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"> </td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">类型:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__6VRuRnImFGQyHpEsxLB\" text=\"text\" name=\"类型\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">金额:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__jrKi8a9fIT50ZoWSPuJ\" text=\"text\" name=\"金额\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"> </td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">代收:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__cRfGd9nYxGMhipMxUaT\" text=\"text\" name=\"代收\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">代付<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__n4yC9HhUbbzihRguJQh\" text=\"text\" name=\"代付\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"> </td>\n </tr>\n <tr>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">合计:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__d36p2gj86z4vlAYhJcL\" text=\"text\" name=\"合计\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\">总合计:<input classname=\"cn.myapps.runtime.dynaform.form.ejb.InputField\" id=\"__D9pJJYssHjiSlkvro0X\" text=\"text\" name=\"总合计\" texttype=\"text\" fieldtype=\"VALUE_TYPE_VARCHAR\" fieldkeyevent=\"Tabkey\" readonlyshowvalonly=\"true\" discript=\"\" validaterule=\"\" valuescript=\"\" hiddenscript=\"\" hiddenvalue=\"\" hiddenprintscript=\"\" printhiddenvalue=\"\" readonlyscript=\"\" refreshonchanged=\"false\" isdefaultvalue=\"false\" calculateonrefresh=\"false\" mobile=\"true\" numberpattern=\"\" processdescription=\"[];[]\" filtercondition=\"\" validatelibs=\"\" editmode=\"01\" refreshmode=\"0\" refreshfields=\"\" /></td>\n <td style=\"border: 1px solid rgb(180, 204, 238);\"> </td>\n </tr>\n </tbody>\n</table>\n<p> </p>",
"type": 1,
"showLog": false,
"openComment": false,
"recordlogForever": false,
"showType": "old",
"showWaterMark": false,
"activities": [
{
"id": "__os2OpoFynecPfMhXy5P",
"name": "保存返回",
"type": 11,
"colorType": "default",
"readonly": false,
"startFlowScript": "\t\t\t\t\t\t\t",
"editMode": 0,
"flowShowType": "表单中显示流程操作",
"orderno": 1,
"parentForm": "__evvfvKw6QFL8puXOiDK",
"impmappingconfigid": "4HhdfiaNeUM8utScH1j",
"jumpType": 0,
"expSub": false,
"disableFlowNode": true,
"changeFlowOperator": true,
"changeFlowCc": true,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": true,
"showInToolbar": true,
"transpond": "选择",
"targetList": "11e6-53d0-13d83c16-81f5-679a826556ce|"
},
{
"id": "__fjbNUyqPR0IsJaKMY73",
"name": "打印",
"type": 14,
"colorType": "default",
"readonly": false,
"editMode": 0,
"orderno": 2,
"parentForm": "__evvfvKw6QFL8puXOiDK",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"targetList": "|"
},
{
"id": "__3PejQj4gL95iicf4HEz",
"name": "打印模板",
"type": 30,
"onActionPrint": "__mXw1keqArTCt2UrAoie",
"colorType": "default",
"readonly": false,
"startFlowScript": "\t\t\t\t\t\t\t",
"editMode": 0,
"orderno": 2,
"parentForm": "__evvfvKw6QFL8puXOiDK",
"jumpType": 0,
"expSub": false,
"disableFlowNode": false,
"changeFlowOperator": false,
"changeFlowCc": false,
"dispatcherMode": 0,
"jumpMode": 0,
"jumpActOpenType": 0,
"withOld": false,
"actionType": 0,
"actionSelection": 0,
"workFlowType": 0,
"contextMenu": false,
"showInToolbar": true,
"transpond": "选择",
"targetList": "4mlBSmLGlzULUWJe8Nu|"
}
],
"version": 1,
"mappingStr": "{\"formName\":\"报表示例\",\"tableName\":\"\",\"columnMappings\":[]}",
"checkout": false,
"orderno": 0,
"permissionType": "public",
"layoutType": "horizontal",
"typeName": "NORMALFORM",
"allFieldNames": [
"所属公司",
"代收公司",
"类型",
"金额",
"代收",
"代付",
"合计",
"总合计"
],
"inited": true
},
"table": null,
"type": null,
"description": null,
"columnMetadatas": [],
"_table": "TLK_报表示例",
"_columnMetadatas": {
"rowCount": 0,
"linesPerPage": 0,
"pageNo": 0,
"datas": [
{
"column": "ITEM_所属公司",
"field": "所属公司",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_代收公司",
"field": "代收公司",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_类型",
"field": "类型",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_金额",
"field": "金额",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_代收",
"field": "代收",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_代付",
"field": "代付",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_合计",
"field": "合计",
"fieldType": "字符串",
"type": "文本框",
"des": ""
},
{
"column": "ITEM_总合计",
"field": "总合计",
"fieldType": "字符串",
"type": "文本框",
"des": ""
}
],
"pageCount": 0
}
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» datasource | object | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» description | null | true | none | none | |
| »»» useType | string | true | none | none | |
| »»» driverClass | string | true | none | none | |
| »»» url | string | true | none | none | |
| »»» username | string | true | none | none | |
| »»» password | string | true | none | none | |
| »»» dbType | integer | true | none | none | |
| »»» poolsize | string | true | none | none | |
| »»» timeout | string | true | none | none | |
| »»» jndiName | null | true | none | none | |
| »»» providerUrl | null | true | none | none | |
| »»» initialContextFactory | null | true | none | none | |
| »»» urlPkgPrefixes | null | true | none | none | |
| »»» securityPrincipal | null | true | none | none | |
| »»» securityCredentials | null | true | none | none | |
| »»» readonly | boolean | true | none | none | |
| »»» readonlyUseType | string | true | none | none | |
| »»» readonlyDriverClass | null | true | none | none | |
| »»» readonlyUsername | null | true | none | none | |
| »»» readonlyPassword | null | true | none | none | |
| »»» readonlyUrl | null | true | none | none | |
| »»» readonlyPoolsize | null | true | none | none | |
| »»» readonlyTimeout | null | true | none | none | |
| »»» readonlyDbType | integer | true | none | none | |
| »»» readonlyJndiName | null | true | none | none | |
| »»» readonlyProviderUrl | null | true | none | none | |
| »»» readonlyInitialContextFactory | null | true | none | none | |
| »»» readonlyUrlPkgPrefixes | null | true | none | none | |
| »»» readonlySecurityPrincipal | null | true | none | none | |
| »»» readonlySecurityCredentials | null | true | none | none | |
| »»» dbTypeName | string | true | none | none | |
| »» form | object | true | none | none | |
| »»» id | string | true | none | none | |
| »»» name | string | true | none | none | |
| »»» templatecontext | string | true | none | none | |
| »»» type | integer | true | none | none | |
| »»» showLog | boolean | true | none | none | |
| »»» openComment | boolean | true | none | none | |
| »»» recordlogForever | boolean | true | none | none | |
| »»» showType | string | true | none | none | |
| »»» showWaterMark | boolean | true | none | none | |
| »»» activities | [object] | true | none | none | |
| »»»» id | string | true | none | none | |
| »»»» name | string | true | none | none | |
| »»»» type | integer | true | none | none | |
| »»»» colorType | string | true | none | none | |
| »»»» readonly | boolean | true | none | none | |
| »»»» editMode | integer | true | none | none | |
| »»»» flowShowType | string | false | none | none | |
| »»»» orderno | integer | true | none | none | |
| »»»» parentForm | string | true | none | none | |
| »»»» impmappingconfigid | string | false | none | none | |
| »»»» jumpType | integer | true | none | none | |
| »»»» expSub | boolean | true | none | none | |
| »»»» disableFlowNode | boolean | true | none | none | |
| »»»» changeFlowOperator | boolean | true | none | none | |
| »»»» changeFlowCc | boolean | true | none | none | |
| »»»» dispatcherMode | integer | true | none | none | |
| »»»» jumpMode | integer | true | none | none | |
| »»»» jumpActOpenType | integer | true | none | none | |
| »»»» withOld | boolean | true | none | none | |
| »»»» actionType | integer | true | none | none | |
| »»»» actionSelection | integer | true | none | none | |
| »»»» workFlowType | integer | true | none | none | |
| »»»» contextMenu | boolean | true | none | none | |
| »»»» showInToolbar | boolean | true | none | none | |
| »»»» targetList | string | true | none | none | |
| »»»» onActionPrint | string | false | none | none | |
| »»» version | integer | true | none | none | |
| »»» mappingStr | string | true | none | none | |
| »»» checkout | boolean | true | none | none | |
| »»» orderno | integer | true | none | none | |
| »»» permissionType | string | true | none | none | |
| »»» layoutType | string | true | none | none | |
| »»» typeName | string | true | none | none | |
| »»» allFieldNames | [string] | true | none | none | |
| »»» inited | boolean | true | none | none | |
| »» table | null | true | none | none | |
| »» type | null | true | none | none | |
| »» description | null | true | none | none | |
| »» columnMetadatas | [string] | true | none | none | |
| »» _table | string | true | none | none | |
| »» _columnMetadatas | object | true | none | none | |
| »»» rowCount | integer | true | none | none | |
| »»» linesPerPage | integer | true | none | none | |
| »»» pageNo | integer | true | none | none | |
| »»» datas | [object] | true | none | none | |
| »»»» column | string | true | none | none | |
| »»»» field | string | true | none | none | |
| »»»» fieldType | string | true | none | none | |
| »»»» type | string | true | none | none | |
| »»»» des | string | true | none | none | |
| »»» pageCount | integer | true | none | none |
GET 获取元数据索引列表
GET /api/designtime/applications/{applicationId}/datasources/getIndex
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| datasourceId | query | string | 否 | 数据源id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"name": "auth_finddocument",
"columns": [
{
"name": "ID",
"dataType": 12,
"primaryKey": true,
"nullable": false,
"columnSize": 200
},
{
"name": "DOC_ID",
"dataType": 12,
"primaryKey": false,
"nullable": true,
"columnSize": 200
},
{
"name": "VALUE",
"dataType": 12,
"primaryKey": false,
"nullable": true,
"columnSize": 200
}
],
"indexs": [
{
"name": "PRIMARY",
"tableName": "auth_finddocument",
"columnName": "ID",
"unique": false,
"type": 3,
"sort": "A"
},
{
"name": "index_doc_id_auth_finddocument",
"tableName": "auth_finddocument",
"columnName": "DOC_ID",
"unique": true,
"type": 3,
"sort": "A"
}
],
"foreignKeys": [],
"indexTotal": 2,
"suggestMsg": "<font color='green'>已经优化</font>",
"indexColumnNames": "ID,DOC_ID"
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» name | string | false | none | none | |
| »» columns | [object] | false | none | none | |
| »»» name | string | true | none | none | |
| »»» dataType | integer | true | none | none | |
| »»» primaryKey | boolean | true | none | none | |
| »»» nullable | boolean | true | none | none | |
| »»» columnSize | integer | true | none | none | |
| »» indexs | [object] | false | none | none | |
| »»» name | string | true | none | none | |
| »»» tableName | string | true | none | none | |
| »»» columnName | string | true | none | none | |
| »»» unique | boolean | true | none | none | |
| »»» type | integer | true | none | none | |
| »»» sort | string | true | none | none | |
| »» foreignKeys | [string] | false | none | none | |
| »» indexTotal | integer | false | none | none | |
| »» suggestMsg | string | false | none | none | |
| »» indexColumnNames | string | false | none | none |
GET 同步表单字段
GET /api/designtime/applications/{applicationId}/datasources/synFormTable
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| datasourceId | query | string | 否 | 数据源id | |
| formId | query | string | 否 | 表单id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "同步完成"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 优化索引
GET /api/designtime/applications/{applicationId}/datasources/optimization
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "优化完成"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 获取数据源详情
GET /api/designtime/applications/{applicationId}/datasources/{dataSourceId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| dataSourceId | path | string | 是 | 数据源id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__7NipDH7Ai7b96SVpewP",
"name": "修改datasource123",
"useType": "JDBC",
"driverClass": "com.mysql.jdbc.Driver",
"url": "jdbc:mysql://localhost:3306/obpm2_testcase?useUnicode=true&characterEncoding=utf8&useSSL=false",
"username": "root",
"password": "root",
"dbType": 4,
"poolsize": "300",
"timeout": "3000",
"jndiName": null,
"providerUrl": null,
"initialContextFactory": null,
"urlPkgPrefixes": null,
"securityPrincipal": null,
"securityCredentials": null,
"dbTypeName": "MYSQL"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 数据源id | |
| »» name | string | true | none | 数据源名称 | |
| »» useType | string | true | none | 使用类型 | |
| »» driverClass | string | true | none | 数据驱动 | |
| »» url | string | true | none | 地址 | |
| »» username | string | true | none | 用户名称 | |
| »» password | string | true | none | 密码 | |
| »» dbType | integer | true | none | 数据库类型 | |
| »» poolsize | string | true | none | 连接池大小 | |
| »» timeout | string | true | none | 连接超时时间 | |
| »» jndiName | null | true | none | none | |
| »» providerUrl | null | true | none | none | |
| »» initialContextFactory | null | true | none | none | |
| »» urlPkgPrefixes | null | true | none | none | |
| »» securityPrincipal | null | true | none | none | |
| »» securityCredentials | null | true | none | none | |
| »» dbTypeName | string | true | none | none |
PUT 更新数据源
PUT /api/designtime/applications/{applicationId}/datasources/{dataSourceId}
Body 请求参数
{
"name": "datasource123",
"useType": "JDBC",
"dbType": 4,
"driverClass": "com.mysql.jdbc.Driver",
"url": "jdbc:mysql://localhost:3306/obpm2_testcase?useUnicode=true&characterEncoding=utf8&useSSL=false",
"username": "root",
"password": "root",
"poolsize": "300",
"timeout": "3000",
"readonly": false,
"readonlyUseType": "",
"readonlyDbType": "",
"readonlyUsername": "",
"readonlyDriverClass": "",
"readonlyPassword": "",
"readonlyUrl": "",
"readonlyPoolsize": "",
"readonlyTimeout": "",
"readonlyJndiName": "",
"readonlyInitialContextFactory": "INITIAL_CONTEXT_FACTORY",
"readonlyUrlPkgPrefixes": "URL_PKG_PREFIXES",
"readonlyProviderUrl": "PROVIDER_URL",
"readonlySecurityPrincipal": "SECURITY_PRINCIPAL",
"readonlySecurityCredentials": "SECURITY_CREDENTIALS"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| dataSourceId | path | string | 是 | 数据源id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 数据源名称 | |
| » useType | body | string | 是 | 使用类型 | |
| » dbType | body | integer | 是 | 数据库类型 | |
| » driverClass | body | string | 是 | 数据驱动 | |
| » url | body | string | 是 | 地址 | |
| » username | body | string | 是 | 用户名称 | |
| » password | body | string | 是 | 密码 | |
| » poolsize | body | string | 是 | 连接池大小 | |
| » timeout | body | string | 是 | 连接超时时间 | |
| » readonly | body | boolean | 是 | none | |
| » readonlyUseType | body | string | 是 | none | |
| » readonlyDbType | body | string | 是 | none | |
| » readonlyUsername | body | string | 是 | none | |
| » readonlyDriverClass | body | string | 是 | none | |
| » readonlyPassword | body | string | 是 | none | |
| » readonlyUrl | body | string | 是 | none | |
| » readonlyPoolsize | body | string | 是 | none | |
| » readonlyTimeout | body | string | 是 | none | |
| » readonlyJndiName | body | string | 是 | none | |
| » readonlyInitialContextFactory | body | string | 是 | none | |
| » readonlyUrlPkgPrefixes | body | string | 是 | none | |
| » readonlyProviderUrl | body | string | 是 | none | |
| » readonlySecurityPrincipal | body | string | 是 | none | |
| » readonlySecurityCredentials | body | string | 是 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string",
"data": {
"id": "string"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
POST 测试数据源
POST /api/designtime/applications/{applicationId}/testdatasources
Body 请求参数
{
"username": "username",
"password": "password",
"driverClass": "driverClass",
"url": "url"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » username | body | string | 是 | 用户名称 | |
| » password | body | string | 是 | 密码 | |
| » driverClass | body | string | 是 | 数据驱动 | |
| » url | body | string | 是 | 地址 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/函数库(Macros)
GET 获取函数库列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/macros
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__LMPNOEdhFExRaOYSp4s",
"name": "单元测试666",
"content": "12345",
"version": 0
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | 函数库id | |
| »»» name | string | false | none | 函数库名称 | |
| »»» content | string | false | none | none | |
| »»» version | integer | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建函数库
POST /api/designtime/applications/{applicationId}/macros
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 函数库名称 | |
| » content | body | string | 是 | 内容 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
DELETE 删除函数库(可批量)
DELETE /api/designtime/applications/{applicationId}/macros
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取函数库详情
GET /api/designtime/applications/{applicationId}/macros/{macroId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| macroId | path | string | 是 | 函数库id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"content": "content"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» content | string | true | none | none |
PUT 更新函数库
PUT /api/designtime/applications/{applicationId}/macros/{macroId}
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| macroId | path | string | 是 | 函数库id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 函数库名称 | |
| » content | body | string | 是 | 内容 |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/样式库(Styles)
POST 新建样式库
POST /api/designtime/applications/{applicationId}/styles
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 样式库名称 | |
| » content | body | string | 是 | 内容 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取样式库列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/styles
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 2,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "IYjUHIBjrlGocjzzuxu",
"name": "视图样式",
"content": ".listDataThTd{\nwhite-space: nowrap;\nbackground-color: #DC143C;\n}",
"version": 0,
"lastmodifytime": "2019-09-11T09:10:45.902+0000"
},
{
"id": "HNaKnPtT0bKlXoTGqkx",
"name": "输入框字体-红",
"content": ".form-control{\n color: red;\n}",
"version": 0,
"lastmodifytime": "2019-08-20T12:59:07.095+0000"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | true | none | 样式库id | none |
| »»» name | string | true | none | 样式库名称 | none |
| »»» content | string | true | none | none | |
| »»» version | integer | true | none | none | |
| »»» lastmodifytime | string | true | none | none | |
| »» pageCount | integer | true | none | none |
DELETE 删除样式库(可批量)
DELETE /api/designtime/applications/{applicationId}/styles
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取样式库详情
GET /api/designtime/applications/{applicationId}/styles/{styleId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| styleId | path | string | 是 | 样式库id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"content": "content"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | 样式库id | |
| »» name | string | true | none | 样式库名称 | |
| »» content | string | true | none | 内容 |
PUT 更新样式库
PUT /api/designtime/applications/{applicationId}/styles/{styleId}
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| styleId | path | string | 是 | 样式库id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 样式库名称 | |
| » content | body | string | 是 | 内容 |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/校验库(Validates)
GET 获取校验库列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/validates
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 查询名称 | |
| pageNo | query | string | 否 | none | |
| linesPerPage | query | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__7QMu8RivfLn2Y4O4TDL",
"name": "单元测试666",
"content": "12345",
"version": 0,
"lastmodifytime": null
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» content | string | false | none | none | |
| »»» version | integer | false | none | none | |
| »»» lastmodifytime | null | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建校验库
POST /api/designtime/applications/{applicationId}/validates
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 校验库名称 | none |
| » content | body | string | 是 | 内容 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
DELETE 删除校验库(可批量)
DELETE /api/designtime/applications/{applicationId}/validates
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取校验库详情
GET /api/designtime/applications/{applicationId}/validates/{validId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| validId | path | string | 是 | 校验库id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"content": "content"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» content | string | true | none | none |
PUT 更新校验库
PUT /api/designtime/applications/{applicationId}/validates/{validId}
Body 请求参数
{
"name": "name",
"content": "content"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| validId | path | string | 是 | 校验库id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 校验库名称 | none |
| » content | body | string | 是 | 内容 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/多语言(Mulitlangs)
GET 获取多语言列表(可根据标签查询)
GET /api/designtime/applications/{applicationId}/mulitlangs
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| pageNo | query | string | 否 | 页码 | |
| linesPerPage | query | string | 否 | 页条数 | |
| label | query | string | 否 | 查询标签 | |
| text | query | string | 否 | 文本 | |
| type | query | string | 否 | 类型 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"linesPerPage": 10,
"pageCount": 1,
"data": [
{
"id": "5fj9rctxLyQlJGLBovj",
"name": "Area Selection",
"type": 1,
"label": "地区选择",
"text": "Area Selection"
},
{
"id": "d3sCqfvz4A3OM6DRJOZ",
"name": "地区选择",
"type": 2,
"label": "地区选择",
"text": "地区选择"
},
{
"id": "tZTirflaktsq4CM8MES",
"name": "地區選擇",
"type": 3,
"label": "地区选择",
"text": "地區選擇"
}
],
"pageNo": 1,
"rowCount": 3
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageCount | integer | true | none | none | |
| »» data | [object] | true | none | none | |
| »»» id | string | true | none | 多语言id | |
| »»» name | string | true | none | none | |
| »»» type | integer | true | none | 类型 | |
| »»» label | string | true | none | 标签 | |
| »»» text | string | true | none | 文本 | |
| »» pageNo | integer | true | none | none | |
| »» rowCount | integer | true | none | none |
POST 新建多语言
POST /api/designtime/applications/{applicationId}/mulitlangs
Body 请求参数
{
"type": 3,
"label": "label",
"text": "text"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » type | body | integer | 是 | none | |
| » label | body | string | 是 | none | |
| » text | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
DELETE 删除多语言(可批量)
DELETE /api/designtime/applications/mulitlangs
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新多语言
PUT /api/designtime/applications/mulitlangs
Body 请求参数
{
"id": "id",
"parentId": "parentId",
"applicationid": "applicationid",
"type": 2,
"label": "label",
"text": "text"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » id | body | string | 是 | none | |
| » parentId | body | string | 是 | 上级id | |
| » applicationid | body | string | 是 | 软件id | |
| » type | body | integer | 是 | none | |
| » label | body | string | 是 | none | |
| » text | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
GET 获取多语言详情
GET /api/designtime/applications/mulitlangs/{mulitlangId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| mulitlangId | path | string | 是 | 多语言id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "5fj9rctxLyQlJGLBovj",
"name": "Area Selection",
"type": 1,
"label": "地区选择",
"text": "Area Selection"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» type | integer | true | none | none | |
| »» label | string | true | none | none | |
| »» text | string | true | none | none |
GET 重新加载语言属性
GET /api/designtime/applications/reloadLanguage
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/文件上传
POST 上传文件
POST /api/designtime/applications/uploads
Body 请求参数
string
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | string(binary) | 否 | none |
返回示例
成功
{
"data": [
{
"fileName": "import_user_sample.xlsx",
"filePath": "\\uploads\\2019\\8fd094db-b2d8-4114-ae00-ef94f004c38d.xlsx"
}
],
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » data | [object] | true | none | none | |
| »» fileName | string | false | none | none | |
| »» filePath | string | false | none | none | |
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/脚本编辑器模块
POST 脚本预编译
POST /api/designtime/applications/iscript/compile
Body 请求参数
{
"iscriptString": "iscriptString"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | object | 否 | none | |
| » iscriptString | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "SUCCESS!"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 脚本帮助接口
GET /api/designtime/applications/iscript/getIscriptHelp
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "html"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
myApps设计时/视图链接模块(Links)-已废弃
GET 获取链接详情
GET /api/designtime/applications/links/{linkId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| linkId | path | string | 是 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
GET 获取链接列表
GET /api/designtime/applications/{applicationId}/links
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none | |
| name | query | string | 否 | none | |
| pageNo | query | string | 否 | none | |
| linesPerPage | query | string | 否 | none | |
| type | query | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
POST 新建链接
POST /api/designtime/applications/{applicationId}/links
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
DELETE 删除链接(可批量)
DELETE /api/designtime/applications/links
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
PUT 更新链接
PUT /api/designtime/applications/links
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
myApps设计时/权限配置
POST 批量更新授权配置
POST /api/designtime/applications/{applicationId}/permissions
Body 请求参数
{
"roles": [
"id1",
"id2"
],
"resources": [
{
"id": "id",
"checked": false
},
{
"id2": "id2",
"checked": false
}
],
"views": [
{
"id": "id1",
"activities": [
{
"viewId": "viewId",
"checked": false
},
{
"id1": "id1",
"checked": false
},
{
"id2": "id2",
"checked": false
}
]
},
{
"id": "id1",
"activities": [
{
"viewId": "viewId",
"checked": false
},
{
"id1": "id1",
"checked": false
},
{
"id2": "id2",
"checked": false
}
]
}
],
"forms": [
{
"id": "id1",
"activities": [
{
"formId": "formId",
"checked": false
},
{
"id1": "id1",
"checked": false
},
{
"id2": "id2",
"checked": false
}
]
},
{
"id": "id1",
"activities": [
{
"formId": "formId",
"checked": false
},
{
"id1": "id1",
"checked": false
},
{
"id2": "id2",
"checked": false
}
]
}
]
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » roles | body | [string] | 是 | none | |
| » resources | body | [object] | 是 | 菜单id集合 | |
| »» id | body | string | 否 | none | |
| »» checked | body | boolean | 是 | none | |
| »» id2 | body | string | 否 | none | |
| » views | body | [object] | 是 | 视图对象集合 | |
| »» id | body | string | 是 | none | |
| »» activities | body | [object] | 是 | none | |
| »»» viewId | body | string | 是 | none | |
| »»» checked | body | boolean | 是 | none | |
| »»» id1 | body | string | 是 | none | |
| »»» id2 | body | string | 是 | none | |
| » forms | body | [object] | 是 | none | |
| »» id | body | string | 是 | none | |
| »» activities | body | [object] | 是 | 按钮id集合(打开的复选框是该表单或者视图的id) | |
| »»» formId | body | string | 是 | none | |
| »»» checked | body | boolean | 是 | none | |
| »»» id1 | body | string | 是 | none | |
| »»» id2 | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "保存成功"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | string | true | none | none |
GET 查询pc菜单配置资源列表(根据上级)
GET /api/designtime/applications/{applicationId}/permissions/pc
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| parentId | query | string | 否 | 上级id | |
| roleId | query | string | 否 | 角色id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "__ryzSjcrmaKPwyuhTff3",
"parentId": "__UIULaYjPTHL3iD9hgwf",
"name": "pc菜单",
"permissionType": "private",
"checked": false,
"hasChild": true
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | false | none | none | |
| »» parentId | string | false | none | none | |
| »» name | string | false | none | none | |
| »» permissionType | string | false | none | none | |
| »» checked | boolean | false | none | none | |
| »» hasChild | boolean | false | none | none |
GET 查询mobile菜单配置资源列表(根据上级)
GET /api/designtime/applications/{applicationId}/permissions/mobile
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| parentId | query | string | 否 | 上级id | |
| roleId | query | string | 否 | 角色id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"id": "__ryzSjcrmaKPwyuhTff3",
"parentId": "__UIULaYjPTHL3iD9hgwf",
"name": "mobile菜单",
"permissionType": "private",
"checked": false,
"hasChild": true
}
]
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | [object] | true | none | none | |
| »» id | string | false | none | none | |
| »» parentId | string | false | none | none | |
| »» name | string | false | none | none | |
| »» permissionType | string | false | none | none | |
| »» checked | boolean | false | none | none | |
| »» hasChild | boolean | false | none | none |
GET 查询所属模块的表单或视图配置资源列表
GET /api/designtime/applications/{applicationId}/modules/{moduleId}/permissions
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| moduleId | path | string | 是 | 模块id | |
| roleId | query | string | 否 | 角色id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"forms": [
{
"id": "__b4fL3h642C0rwag7gCr",
"name": "简单表单",
"permissionType": "private",
"activities": [
{
"id": "__i4VzpphJmShgDtVmNTt",
"name": "保存",
"checked": true
},
{
"id": "__lngHijzzyKLno6ygnv2",
"name": "返回",
"checked": true
},
{
"id": "__b4fL3h642C0rwag7gCr",
"name": "打开",
"checked": true
}
]
}
],
"views": [
{
"id": "__zNzDsBiB52n6EyL23C3",
"name": "简单表单",
"permissionType": "public",
"activities": [
{
"id": "__KfyHewefMqinj9xFeKt",
"name": "新建",
"checked": true
},
{
"id": "__Ppp3tdmenaljrXpND57",
"name": "删除",
"checked": true
},
{
"id": "__zNzDsBiB52n6EyL23C3",
"name": "打开",
"checked": true
}
]
}
]
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» forms | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» permissionType | string | false | none | none | |
| »»» activities | [object] | false | none | none | |
| »»»» id | string | true | none | none | |
| »»»» name | string | true | none | none | |
| »»»» checked | boolean | true | none | none | |
| »» views | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» permissionType | string | false | none | none | |
| »»» activities | [object] | false | none | none | |
| »»»» id | string | true | none | none | |
| »»»» name | string | true | none | none | |
| »»»» checked | boolean | true | none | none |
myApps设计时/Eip(Eips)
GET 获取eip列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/eips
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| pageNo | query | string | 否 | none | |
| linesPerPage | query | string | 否 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__UFRPx5256ckmTiK20Op",
"uri": "/4.0功能示例.application/test2.eipconfig",
"name": "test2",
"description": "1123",
"xml": "aaaaaa"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» uri | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» description | string | false | none | none | |
| »»» xml | string | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建eip
POST /api/designtime/applications/{applicationId}/eips
Body 请求参数
{
"name": "name",
"xml": "xml",
"description": "description"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » xml | body | string | 是 | none | |
| » description | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取eip详情
GET /api/designtime/applications/{applicationId}/eips/{eipId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| eipId | path | string | 是 | id |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id",
"name": "name",
"xml": "xml",
"description": "description"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | xml字符串 | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» xml | string | true | none | none | |
| »» description | string | true | none | none |
PUT 更新eip
PUT /api/designtime/applications/{applicationId}/eips/{eipId}
Body 请求参数
{
"name": "name",
"xml": "xml",
"description": "description"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| eipId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none | |
| » xml | body | string | 是 | none | |
| » description | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除eip(可批量)
DELETE /api/designtime/applications/eips
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/Api中心(Apis)
GET 获取api列表
GET /api/designtime/applications/{applicationId}/apis
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| apiGroupId | query | string | 否 | api分组id | |
| requestType | query | string | 否 | 请求类型 | |
| status | query | string | 否 | 状态 | |
| pageNo | query | string | 否 | 页数 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__ZKvjRFLYzO7290vLgUF",
"uri": "/trunk功能示例.application/获取用户.api",
"fileUrl": "file:///D:/spy/trunk2018/obpm-demo/workspace/trunk功能示例.application/获取用户.api",
"name": "获取用户",
"status": "test",
"apiGroup": "yBQuYnX8AS9vYx217dB",
"encode": "UTF-8",
"requestType": "get",
"requestUrl": "/api/users",
"tags": "Accept-Encoding;Accept",
"responseType": "json",
"responseScript": " //给表单有选项脚本的控件创建选项@nbsp;@nbsp;(选项脚本) (function(){ var@nbsp;opts@nbsp;=@nbsp;$TOOLS.createOptions();@nbsp;//创建指定类对象 opts.add(@quot;A@quot;,@quot;a@quot;); opts.add(@quot;B@quot;,@quot;b@quot;); opts.add(@quot;C@quot;,@quot;c@quot;); return@nbsp;opts; })())"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | id | |
| »»» uri | string | false | none | none | |
| »»» fileUrl | string | false | none | none | |
| »»» name | string | false | none | 名称 | |
| »»» status | string | false | none | 状态 | |
| »»» apiGroup | string | false | none | 分组 | |
| »»» encode | string | false | none | 编码格式 | |
| »»» requestType | string | false | none | 请求类型 | |
| »»» requestUrl | string | false | none | 请求路径 | |
| »»» tags | string | false | none | 标签 | |
| »»» responseType | string | false | none | 响应数据类型 | |
| »»» responseScript | string | false | none | 返回结果脚本 | |
| »» pageCount | integer | true | none | none |
POST 新建api
POST /api/designtime/applications/{applicationId}/apis
Body 请求参数
{
"name": "获取用户",
"status": "publish",
"apiGroup": "yBQuYnX8AS9vYx217dB",
"encode": "UTF-8",
"requestScheme": "http",
"requestType": "get",
"requestUrl": "/api/users",
"tags": "Accept-Encoding;Accept",
"responseType": "json",
"responseScript": " //给表单有选项脚本的控件创建选项@nbsp;@nbsp;(选项脚本) (function(){ var@nbsp;opts@nbsp;=@nbsp;$TOOLS.createOptions();@nbsp;//创建指定类对象 opts.add(@quot;A@quot;,@quot;a@quot;); opts.add(@quot;B@quot;,@quot;b@quot;); opts.add(@quot;C@quot;,@quot;c@quot;); return@nbsp;opts; })())"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » status | body | string | 是 | 状态 | |
| » apiGroup | body | string | 是 | 分组 | |
| » encode | body | string | 是 | 编码格式 | |
| » requestScheme | body | string | 是 | 请求协议 | |
| » requestType | body | string | 是 | 请求类型 | |
| » requestUrl | body | string | 是 | 请求路径 | |
| » tags | body | string | 是 | 标签 | |
| » responseType | body | string | 是 | 响应数据类型 | |
| » responseScript | body | string | 是 | 返回结果脚本 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取api详情
GET /api/designtime/applications/apis/{apiId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| apiId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__pJRiHEHgZdZhsKKvW8b",
"uri": "/trunk功能示例.application/获取用户.api",
"fileUrl": "file:///D:/spy/trunk2018/obpm-demo/workspace/trunk功能示例.application/获取用户.api",
"name": "获取用户",
"status": "publish",
"apiGroup": "yBQuYnX8AS9vYx217dB",
"encode": "UTF-8",
"requestScheme": "http",
"requestType": "get",
"requestUrl": "/api/users",
"tags": "Accept-Encoding;Accept",
"responseType": "json",
"responseScript": " //给表单有选项脚本的控件创建选项@nbsp;@nbsp;(选项脚本) (function(){ var@nbsp;opts@nbsp;=@nbsp;$TOOLS.createOptions();@nbsp;//创建指定类对象 opts.add(@quot;A@quot;,@quot;a@quot;); opts.add(@quot;B@quot;,@quot;b@quot;); opts.add(@quot;C@quot;,@quot;c@quot;); return@nbsp;opts; })())"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | id | |
| »» name | string | true | none | 名称 | |
| »» status | string | true | none | 状态 | |
| »» apiGroup | string | true | none | 分组 | |
| »» encode | string | true | none | 编码格式 | |
| »» requestType | string | true | none | 请求类型 | |
| »» requestUrl | string | true | none | 请求路径 | |
| »» tags | string | true | none | 标签 | |
| »» responseType | string | true | none | 响应数据类型 | |
| »» responseScript | string | true | none | 返回结果脚本 |
PUT 更新api
PUT /api/designtime/applications/{applicationId}/apis/{apiId}
Body 请求参数
{
"name": "获取用户",
"status": "publish",
"apiGroup": "yBQuYnX8AS9vYx217dB",
"encode": "UTF-8",
"requestScheme": "http",
"requestType": "get",
"requestUrl": "/api/users",
"tags": "Accept-Encoding;Accept",
"responseType": "json",
"responseScript": " //给表单有选项脚本的控件创建选项@nbsp;@nbsp;(选项脚本) (function(){ var@nbsp;opts@nbsp;=@nbsp;$TOOLS.createOptions();@nbsp;//创建指定类对象 opts.add(@quot;A@quot;,@quot;a@quot;); opts.add(@quot;B@quot;,@quot;b@quot;); opts.add(@quot;C@quot;,@quot;c@quot;); return@nbsp;opts; })())"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| apiId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » status | body | string | 是 | 状态 | |
| » apiGroup | body | string | 是 | 分组 | |
| » encode | body | string | 是 | 编码格式 | |
| » requestScheme | body | string | 是 | 请求协议 | |
| » requestType | body | string | 是 | 请求类型 | |
| » requestUrl | body | string | 是 | 请求路径 | |
| » tags | body | string | 是 | 标签 | |
| » responseType | body | string | 是 | 响应数据类型 | |
| » responseScript | body | string | 是 | 返回结果脚本 |
返回示例
201 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除api(可批量)
DELETE /api/designtime/applications/apis
Body 请求参数
[
"string"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/Api分组(ApiGroups)
GET 获取api分组列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/apigroups
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| pageNo | query | string | 否 | 页数 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__ZKvjRFLYzO7290vLgUF",
"uri": "/trunk功能示例.application/获取用户分组.apigroup",
"fileUrl": "file:///D:/spy/trunk2018/obpm-demo/workspace/trunk功能示例.application/获取用户分组.apigroup",
"name": "获取用户分组"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» uri | string | false | none | none | |
| »»» fileUrl | string | false | none | none | |
| »»» name | string | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建api分组
POST /api/designtime/applications/{applicationId}/apigroups
Body 请求参数
{
"name": "获取用户分组"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取api分组详情
GET /api/designtime/applications/apigroups/{apiGroupId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| apiGroupId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__pJRiHEHgZdZhsKKvW8b",
"uri": "/trunk功能示例.application/获取用户.api",
"fileUrl": "file:///D:/spy/trunk2018/obpm-demo/workspace/trunk功能示例.application/获取用户.api",
"name": "获取用户"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none |
DELETE 删除api分组(可批量)
DELETE /api/designtime/applications/apigroups
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
PUT 更新api分组
PUT /api/designtime/applications/{applicationId}/apigroups/{apiGroupId}
Body 请求参数
{
"name": "获取用户分组"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| apiGroupId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | none |
返回示例
201 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/页面(Pages)
GET 获取页面列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/pages
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| pageNo | query | string | 否 | 页数 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__lp9TS4aoH8an3avOtnE",
"uri": "/心理测评服务1.application/哈哈哈.page/哈哈哈.page",
"name": "哈哈哈",
"description": null,
"templateContext": "<input type='text'>"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» uri | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» description | null | false | none | none | |
| »»» templateContext | string | false | none | none | |
| »» pageCount | integer | true | none | none |
POST 新建页面
POST /api/designtime/applications/{applicationId}/pages
Body 请求参数
{
"name": "哈哈12222哈",
"templateContext": "<input type='text'>"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » templateContext | body | string | 是 | 模板数据 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none |
GET 获取页面详情
GET /api/designtime/applications/pages/{pageId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| pageId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__lp9TS4aoH8an3avOtnE",
"uri": "/心理测评服务1.application/哈哈哈.page/哈哈哈.page",
"name": "哈哈哈",
"description": null,
"templateContext": "<input type='text'>"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | none | |
| »» description | null | true | none | none | |
| »» templateContext | string | true | none | none |
PUT 更新页面
PUT /api/designtime/applications/{applicationId}/pages/{pageId}
Body 请求参数
{
"name": "哈哈12222哈",
"templateContext": "<input type='text'>"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| pageId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » templateContext | body | string | 是 | 模板数据 |
返回示例
201 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
DELETE 删除页面(可批量)
DELETE /api/designtime/applications/pages
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none |
myApps设计时/外部接口(ExtInterfaces)
GET 获取外部接口详情
GET /api/designtime/applications/extinterfaces/{exId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| exId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "__GhwILyYRkKpStAX07od",
"name": "新建的外部接口2",
"description": null,
"type": "restful",
"requestType": "get",
"requestScheme": "http",
"requestUrl": "/skcks/api/shshjd/xxx",
"requestParams": "[{\"name\":\"name\",\"type\":\"string\",\"comment\":\"姓名\",\"example\":\"小三\"}]",
"encode": "UTF-8",
"exampleCode": null,
"wsdl": null,
"jarPath": null
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | false | none | none | |
| »» id | string | true | none | none | |
| »» name | string | true | none | 名称 | |
| »» description | null | true | none | none | |
| »» type | string | true | none | 类型(restful,webservice,jar) | |
| »» requestType | string | true | none | 请求类型 | |
| »» requestScheme | string | true | none | 请求协议 | |
| »» requestUrl | string | true | none | 请求路径 | |
| »» requestParams | string | true | none | 请求参数 | |
| »» encode | string | true | none | 编码 | |
| »» exampleCode | null | true | none | 代码示例 | |
| »» wsdl | null | true | none | 报文 | |
| »» jarPath | null | true | none | jar路径 |
GET 获取外部接口列表(可根据名字查询)
GET /api/designtime/applications/{applicationId}/extinterfaces
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| name | query | string | 否 | 名称 | |
| pageNo | query | string | 否 | 页数 | |
| linesPerPage | query | string | 否 | 每页显示条数 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "__GhwILyYRkKpStAX07od",
"name": "新建的外部接口2",
"description": null,
"type": "restful",
"requestType": "get",
"requestScheme": "http",
"requestUrl": "/skcks/api/shshjd/xxx",
"requestParams": "[{\"name\":\"name\",\"type\":\"string\",\"comment\":\"姓名\",\"example\":\"小三\"}]",
"encode": "UTF-8",
"exampleCode": null,
"wsdl": null,
"jarPath": null
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | 名称 | |
| »»» description | null | false | none | none | |
| »»» type | string | false | none | 类型(restful,webservice,jar) | |
| »»» requestType | string | false | none | 请求类型 | |
| »»» requestScheme | string | false | none | 请求协议 | |
| »»» requestUrl | string | false | none | 请求路径 | |
| »»» requestParams | string | false | none | 请求参数 | |
| »»» encode | string | false | none | 编码 | |
| »»» exampleCode | null | false | none | 代码示例 | |
| »»» wsdl | null | false | none | 报文 | |
| »»» jarPath | null | false | none | jar路径 | |
| »» pageCount | integer | true | none | none |
POST 新建外部接口
POST /api/designtime/applications/{applicationId}/extinterfaces
Body 请求参数
{
"name": "新建的外部接口2",
"type": "restful",
"requestType": "get",
"requestScheme": "http",
"requestUrl": "/skcks/api/shshjd/xxx",
"requestParams": "[{\"name\":\"name\",\"type\":\"string\",\"comment\":\"姓名\",\"example\":\"小三\"}]",
"encode": "UTF-8",
"wsdl": "<das><asdas>",
"jarPath": "/uploads/dasjdaksd/sxasa.jar"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » type | body | string | 是 | 类型 | |
| » requestType | body | string | 是 | 请求类型 | |
| » requestScheme | body | string | 是 | 请求协议 | |
| » requestUrl | body | string | 是 | 请求路径 | |
| » requestParams | body | string | 是 | 请求参数 | |
| » encode | body | string | 是 | 编码 | |
| » wsdl | body | string | 是 | 报文 | |
| » jarPath | body | string | 是 | jar路径 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"id": "id"
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | false | none | none | |
| » data | object | false | none | none | |
| »» id | string | true | none | none |
DELETE 删除外部接口(可批量)
DELETE /api/designtime/applications/extinterfaces
Body 请求参数
[
"id1",
"id2"
]
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| body | body | array[string] | 否 | none |
返回示例
200 Response
{
"errcode": 0,
"errmsg": "string"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | false | none | none | |
| » errmsg | string | false | none | none |
GET 获取代码示例
GET /api/designtime/applications/extinterfaces/{exId}/examplecode
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| exId | path | string | 是 | none |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": "sample code"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | false | none | none | |
| » data | string | false | none | none |
PUT 更新外部接口
PUT /api/designtime/applications/{applicationId}/extinterfaces/{extId}
Body 请求参数
{
"name": "新建的外部接口2",
"type": "restful",
"requestType": "get",
"requestScheme": "http",
"requestUrl": "/skcks/api/shshjd/xxx",
"requestParams": "[{\"name\":\"name\",\"type\":\"string\",\"comment\":\"姓名\",\"example\":\"小三\"}]",
"encode": "UTF-8",
"wsdl": "<das><asdas>",
"jarPath": "/uploads/dasjdaksd/sxasa.jar"
}
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| applicationId | path | string | 是 | 软件id | |
| extId | path | string | 是 | none | |
| body | body | object | 否 | none | |
| » name | body | string | 是 | 名称 | |
| » type | body | string | 是 | 类型 | |
| » requestType | body | string | 是 | 请求类型 | |
| » requestScheme | body | string | 是 | 请求协议 | |
| » requestUrl | body | string | 是 | 请求路径 | |
| » requestParams | body | string | 是 | 请求参数 | |
| » encode | body | string | 是 | 编码 | |
| » wsdl | body | string | 是 | 报文 | |
| » jarPath | body | string | 是 | jar路径 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok"
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 201 | Created | 成功 | Inline |
返回数据结构
状态码 201
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | false | none | none |
myApps设计时/公共(Helps)
GET 获取系统信息列表(可根据名称查询)-废弃
GET /api/designtime/systeminfo
请求参数
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| accessToken | cookie | string | 否 | none | |
| adminToken | cookie | string | 否 | none | |
| name | query | string | 否 | 查询名称 | |
| type | query | string | 否 | 类型 |
返回示例
成功
{
"errcode": 0,
"errmsg": "ok",
"data": {
"rowCount": 1,
"linesPerPage": 10,
"pageNo": 1,
"datas": [
{
"id": "4739dbd4-202c-405f-8f54-997f7124856f",
"name": "WeiOA365 2.0_UPGRADE",
"version_name": "WeiOA365 2.0_UPGRADE",
"version_number": "WeiOA365 2.0_UPGRADE",
"upgrade_date": "2018-05-30T06:32:45.527+0000",
"type": 3,
"remark": "数据迁移成功"
}
],
"pageCount": 1
}
}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
返回数据结构
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » errcode | integer | true | none | none | |
| » errmsg | string | true | none | none | |
| » data | object | true | none | none | |
| »» rowCount | integer | true | none | none | |
| »» linesPerPage | integer | true | none | none | |
| »» pageNo | integer | true | none | none | |
| »» datas | [object] | true | none | none | |
| »»» id | string | false | none | none | |
| »»» name | string | false | none | none | |
| »»» version_name | string | false | none | none | |
| »»» version_number | string | false | none | none | |
| »»» upgrade_date | string | false | none | none | |
| »»» type | integer | false | none | none | |
| »»» remark | string | false | none | none | |
| »» pageCount | integer | true | none | none |