Add README.md

kanban-console/README.md

@@ -0,0 +1,1010 @@
+# 声明及约束
+## 服务器地址
+  http://10.10.100.191:8082/kanban
+
+## <span id="通用属性数据字典">通用属性数据字典</span>
+主表均具有以下形式的基本属性，**如果没有特别说明，请求时不需要传入这些属性**
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>**code**</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>**数据的唯一标识**</td>
+        <td>4EC324CA714</td>
+    </tr>
+    <tr>
+        <td>createTime</td>
+        <td>Date</td>
+        <td>✘</td>
+        <td>数据的创建时间，以时间戳形式返回给前台</td>
+        <td>1504342588583</td>
+    </tr>
+    <tr>
+        <td>lastModified</td>
+        <td>Date</td>
+        <td>✘</td>
+        <td>数据的最后修改时间，以时间戳形式返回给前台</td>
+        <td>1504532851197</td>
+    </tr>
+    <tr>
+        <td>version</td>
+        <td>Number</td>
+        <td>✘</td>
+        <td>数据的版本，每次修改版本加1</td>
+        <td>3</td>
+    </tr>
+</table>
+
+## 关于code
+  如无特殊说明，**调用save接口，保存（新增）数据时，不必指定code字段；调用update接口，更新数据时，必须指定code字段**
+
+## 请求方式
+  如无特殊说明，均以** POST **方式请求
+
+## 请求出错
+  前台访问各个接口时，如果后台处理正确，会返回给前台各个接口指定的返回值。如果后台出现任何错误，如参数不合法、不允许的操作等，均会以下列的形式返回
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>success</td>
+        <td>固定为false，表示请求出错</td>
+        <td>false</td>
+    </tr>
+    <tr>
+        <td>message</td>
+        <td>错误提示</td>
+        <td>UserController.save: 参数为空：json(String)</td>
+    </tr>
+    <tr>
+        <td>detailedMessage</td>
+        <td>异常的栈轨迹</td>
+        <td>java.lang.IllegalArgumentException: UserController.save: 参数为空：json(String)
+	com.uas.kanban.aop.ArgumentsCheckAspect.before(ArgumentsCheckAspect.java:56)...</td>
+    </tr>
+</table>
+
+## <span id="通用接口">通用接口</span>
+  如无特殊说明，每个功能模块均有下列接口，如 /datasource/save、/datasource/update
+
+### 保存
+- 路径
+`
+/save
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>json</td>
+        <td>JSON</td>
+        <td>json 中的字段请参照相应功能模块的数据字典</td>
+    </tr>
+</table>
+
+- 返回值
+  json 类型，具体字段请参照相应功能模块的数据字典
+  示例（数据源）：
+  ``` json
+  {
+    "code": "4FA456C7A11",
+    "createTime": 1504578722937,
+    "driverClassName": "oracle.jdbc.driver.OracleDriver",
+    "lastModified": 1504578722937,
+    "password": "password*123",
+    "url": "jdbc:oracle:thin:@192.168.253.6:1521:orcl",
+    "username": "UAS",
+    "version": 1
+  }
+  ```
+
+### 更新
+- 路径
+`
+/update
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>json</td>
+        <td>JSON</td>
+        <td>json 中的字段请参照相应功能模块的数据字典</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Number</td>
+        <td>更新的数据条数</td>
+    </tr>
+</table>
+
+### 删除
+- 路径
+`
+/delete/{code}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>想要删除的数据的 code ，将路径中的 {code} 替换为实际值</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Number</td>
+        <td>更新的数据条数</td>
+    </tr>
+</table>
+
+### 分页获取所有数据
+- 路径
+`
+/get
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>page</td>
+        <td>大于1的整数</td>
+        <td>页码，可为空，默认为1</td>
+    </tr>
+    <tr>
+        <td>size</td>
+        <td>大于1的整数</td>
+        <td>页面大小，可为空，默认为20</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>page</td>
+        <td>Number</td>
+        <td>当前页码</td>
+    </tr>
+    <tr>
+        <td>size</td>
+        <td>Number</td>
+        <td>页面大小，默认为20</td>
+    </tr>
+    <tr>
+        <td>totalPage</td>
+        <td>Number</td>
+        <td>总页数</td>
+    </tr>
+    <tr>
+        <td>totalElement</td>
+        <td>Number</td>
+        <td>数据总条数</td>
+    </tr>
+    <tr>
+        <td>first</td>
+        <td>Boolean</td>
+        <td>是否为第一页</td>
+    </tr>
+    <tr>
+        <td>last</td>
+        <td>Boolean</td>
+        <td>是否为最后一页</td>
+    </tr>
+    <tr>
+        <td>content</td>
+        <td>JSONArray</td>
+        <td>数据，具体字段请参照相应功能模块的数据字典</td>
+    </tr>
+</table>
+
+  示例（数据源）：
+  ``` json
+  {
+  "content": [{
+      "code": "4EC3C69D011",
+      "createTime": 1504343251407,
+      "driverClassName": "oracle.jdbc.driver.OracleDriver",
+      "lastModified": 1505057228224,
+      "name": "UAS标准版",
+      "password": "select!#%*(",
+      "url": "jdbc:oracle:thin:@192.168.253.6:1521:orcl",
+      "username": "UAS",
+      "version": 4
+    }, {
+      "code": "506BCA86611",
+      "createTime": 1504787863652,
+      "driverClassName": "oracle.jdbc.driver.OracleDriver",
+      "lastModified": 1505095261811,
+      "name": "深圳市优软科技有限公司",
+      "password": "select123456",
+      "url": "jdbc:oracle:thin:@218.17.158.219:1523:orcl",
+      "username": "USOFTSYS",
+      "version": 4
+    }, {
+      "code": "56743A5D711",
+      "createTime": 1506407323094,
+      "driverClassName": "oracle.jdbc.driver.OracleDriver",
+      "lastModified": 1506407323094,
+      "name": "万利达科技MES",
+      "password": "select!#%*(",
+      "url": "jdbc:oracle:thin:@117.25.180.218:1521:orcl",
+      "username": "MES",
+      "version": 1
+    }],
+  "first": true,
+  "last": false,
+  "page": 1,
+  "size": 3,
+  "totalElement": 7,
+  "totalPage": 3
+  }
+  ```
+
+### 获取单条数据
+- 路径
+`
+/get/{code}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>数据的 code ，将路径中的 {code} 替换为实际值</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>JSON</td>
+        <td>单条数据</td>
+    </tr>
+</table>
+
+# 用户
+## 数据字典
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>名称</td>
+        <td>admin</td>
+    </tr>
+    <tr>
+        <td>password</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>密码</td>
+        <td>password*123</td>
+    </tr>
+    <tr>
+        <td>role</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>角色，有两个值：1. Admin 管理员；2. Default 普通用户。默认为 Default</td>
+        <td>Default</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+## 登陆
+- 路径
+`
+/user/login
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>名称</td>
+    </tr>
+    <tr>
+        <td>password</td>
+        <td>String</td>
+        <td>密码</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>登陆是否成功</td>
+    </tr>
+</table>
+
+## 注销登陆
+- 路径
+`
+/user/logout
+`
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>注销登陆是否成功</td>
+    </tr>
+</table>
+
+## 重置密码
+- 路径
+`
+/user/resetPwd
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>password</td>
+        <td>String</td>
+        <td>旧密码</td>
+    </tr>
+    <tr>
+        <td>newPassword</td>
+        <td>String</td>
+        <td>新密码</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>重置密码是否成功</td>
+    </tr>
+</table>
+
+# 数据源
+## 数据字典
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>driverClassName</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>数据库驱动名</td>
+        <td>oracle.jdbc.driver.OracleDriver</td>
+    </tr>
+    <tr>
+        <td>url</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>数据库地址</td>
+        <td>jdbc:oracle:thin:@192.168.253.6:1521:orcl</td>
+    </tr>
+    <tr>
+        <td>username</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>用户名</td>
+        <td>UAS</td>
+    </tr>
+    <tr>
+        <td>password</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>密码</td>
+        <td>password*123</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+# 面板
+## 数据字典
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>名称</td>
+        <td>产线面板</td>
+    </tr>
+    <tr>
+        <td>display</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>展示方式，有两个值：1. AutoSwitch 自动切换；2. SplitScreen 分屏展示。默认为 AutoSwitch</td>
+        <td>AutoSwitch</td>
+    </tr>
+    <tr>
+        <td>iconCls</td>
+        <td>String</td>
+        <td>✔</td>
+        <td>图标样式</td>
+        <td>grid-shortcut</td>
+    </tr>
+    <tr>
+        <td>dataSourceCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>数据源 code</td>
+        <td>4EC3C69D011</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+## 分配面板
+- 路径
+`
+/panel/assignPanel
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>userCode</td>
+        <td>String</td>
+        <td>用户 code</td>
+    </tr>
+    <tr>
+        <td>panelCodes</td>
+        <td>String[]</td>
+        <td>面板 code</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>Boolean</td>
+        <td>分配是否成功</td>
+    </tr>
+</table>
+
+# 参数
+## <span id="参数数据字典">数据字典</span>
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>名称</td>
+        <td>线别</td>
+    </tr>
+    <tr>
+        <td>type</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>类型，有四个值：1. String 字符串；2. Number 数值；3. Date 日期，以时间戳的形式传入；4. SQL SQL取数。</td>
+        <td>SQL</td>
+    </tr>
+    <tr>
+        <td>inputMode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>输入方式，有两个值：1. DropDownBox 下拉框；2. Manual 手输</td>
+        <td>DropDownBox</td>
+    </tr>
+    <tr>
+        <td>optionalValues</td>
+        <td>List<T>，T 取决于 type</td>
+        <td>✔</td>
+        <td>可选择的值，用于输入方式为 DropDownBox 时，此时不可为空</td>
+        <td>["ASX","AHA"]</td>
+    </tr>
+    <tr>
+        <td>defaultOptionalValueIndex</td>
+        <td>Integer</td>
+        <td>✔</td>
+        <td>默认值的序号，用于输入方式为 DropDownBox 时，此时不可为空，默认为 1</td>
+        <td>1</td>
+    </tr>
+    <tr>
+        <td>value</td>
+        <td>取决于 type</td>
+        <td>✔</td>
+        <td>参数的值，应用面板时需要填写参数，此时不可为空</td>
+        <td>ASX</td>
+    </tr>
+    <tr>
+        <td>panelCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>面板 code</td>
+        <td>5DE18FCEF14</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+## 获取指定面板的参数
+- 路径
+`
+/parameter/get/byPanel/{panelCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>面板 code，将路径中的 {panelCode} 替换为实际值</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>JSONArray</td>
+        <td>数据，具体字段请参照[数据字典](#参数数据字典)</td>
+    </tr>
+</table>
+
+# 看板
+## <span id="看板数据字典">数据字典</span>
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>名称</td>
+        <td>产线看板</td>
+    </tr>
+    <tr>
+        <td>title</td>
+        <td>String</td>
+        <td>✔</td>
+        <td>标题</td>
+        <td>&lt;table width="100%" border="0" cellpadding="0" cellspacing="1" style="font-weight: bold; background: #2f2e2c;border-collapse: collapse;color: white; text-align: center;"&gt;
+  &lt;tr&gt;
+    &lt;td width="20%" rowspan="2" style="border:1px solid white"&gt;&lt;img style="width: auto;height: 40%; max-width: 100%; max-height: 100%;" src="static/images/log.png" alt=""/&gt;&lt;/td&gt;
+    &lt;td width="10%" rowspan="1" style="border:1px solid white;color:red"&gt;{线别}&lt;/td&gt;
+  &lt;/tr&gt;
+&lt;/table&gt;</td>
+    </tr>
+    <tr>
+        <td>description</td>
+        <td>String</td>
+        <td>✔</td>
+        <td>描述</td>
+        <td>-</td>
+    </tr>
+    <tr>
+        <td>content</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>内容</td>
+        <td>&lt;content&gt;...&lt;/content&gt;</td>
+    </tr>
+    <tr>
+        <td>enabled</td>
+        <td>Boolean</td>
+        <td>✘</td>
+        <td>是否启用，默认为 true</td>
+        <td>true</td>
+    </tr>
+    <tr>
+        <td>panelCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>面板 code</td>
+        <td>5DE18FCEF14</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+## 获取指定面板的看板
+- 路径
+`
+/kanban/get/byPanel/{panelCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>面板 code，将路径中的 {panelCode} 替换为实际值</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>JSONArray</td>
+        <td>数据，具体字段请参照[数据字典](#看板数据字典)</td>
+    </tr>
+</table>
+
+# 面板实例
+## <span id="面板实例数据字典">数据字典</span>
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>名称</th>
+        <th>类型</th>
+        <th>可为空</th>
+        <th>描述</th>
+        <th>示例</th>
+    </tr>
+    <tr>
+        <td>4个通用属性</td>
+        <td colspan="4">大部分表均含有该部分属性，请参照[通用属性数据字典](#通用属性数据字典)</td>
+    </tr>
+    <tr>
+        <td>name</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>名称</td>
+        <td>产线面板</td>
+    </tr>
+    <tr>
+        <td>iconCls</td>
+        <td>String</td>
+        <td>✔</td>
+        <td>图标样式</td>
+        <td>grid-shortcut</td>
+    </tr>
+    <tr>
+        <td>switchFrequency</td>
+        <td>Number</td>
+        <td>✔</td>
+        <td>切换频率（秒），面板的展示方式为 AutoSwitch ，才生效，此时默认为 10 秒</td>
+        <td>10</td>
+    </tr>
+    <tr>
+        <td>refreshFrequency</td>
+        <td>Number</td>
+        <td>✘</td>
+        <td>刷新频率（秒），默认为 5 秒</td>
+        <td>5</td>
+    </tr>
+    <tr>
+        <td>parameters</td>
+        <td>JSONArray</td>
+        <td>✔</td>
+        <td>参数，具体字段请参照[数据字典](#参数数据字典)</td>
+        <td>
+          [{
+            "createTime": 1508399982885,
+            "lastModified": 1508399982885,
+            "optionalValues": [
+              "值1",
+              "值2"
+            ],
+            "defaultOptionalValueIndex": 1,
+            "name": "参数1",
+            "code": "5DE09392515",
+            "inputMode": "DropDownBox",
+            "type": "String",
+            "panelCode": "5DE01A51E11",
+            "version": 1
+          }, {
+            "createTime": 1508400015990,
+            "lastModified": 1508400015990,
+            "optionalValues": [
+              "值1",
+              "值2"
+            ],
+            "defaultOptionalValueIndex": 1,
+            "name": "参数2",
+            "code": "5DE09BA761A",
+            "inputMode": "DropDownBox",
+            "type": "String",
+            "panelCode": "5DE01A51E11",
+            "version": 1
+          }]
+        </td>
+    </tr>
+    <tr>
+        <td>panelCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>面板 code</td>
+        <td>5DE18FCEF14</td>
+    </tr>
+    <tr>
+        <td>userCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>用户 code</td>
+        <td>5DE18FCEF14</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)，面板实例没有 /save 接口
+
+## 分配面板
+- 路径
+`
+/panelInstance/parseData/{code}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>code</td>
+        <td>String</td>
+        <td>面板实例 code</td>
+    </tr>
+    <tr>
+        <td>kanbanCode</td>
+        <td>String</td>
+        <td>看板 code，可为空，为空时解析第一个看板数据</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>JSON</td>
+        <td>前台展示所需要的格式</td>
+    </tr>
+</table>
+
+## 获取指定面板的实例
+- 路径
+`
+/panelInstance/get/byPanel/{panelCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>面板 code，将路径中的 {panelCode} 替换为实际值</td>
+    </tr>
+</table>
+
+- 返回值
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>JSONArray</td>
+        <td>数据，具体字段请参照[数据字典](#面板实例数据字典)</td>
+    </tr>
+</table>
+
+## 保存到桌面
+- 路径
+`
+/panelInstance/save/toDesktop
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>json</td>
+        <td>JSON</td>
+        <td>json 中的字段请参照[数据字典](#面板实例数据字典)，与原实例结构相同，包括原实例的 code</td>
+    </tr>
+</table>
+
+- 返回值
+  json 类型，具体字段请参照[数据字典](#面板实例数据字典)
+  示例：
+  ``` json
+  {
+        "autoGenerated": true,
+        "code": "5DE1412AC11",
+        "createTime": 1508400693931,
+        "iconCls": "grid-shortcut",
+        "lastModified": 1508400693931,
+        "name": "name2",
+        "panelCode": "5DE01A51E11",
+        "parameters": [
+          {
+            "createTime": 1508399982885,
+            "lastModified": 1508399982885,
+            "optionalValues": [
+              "值1",
+              "值2"
+            ],
+            "defaultOptionalValueIndex": 1,
+            "name": "参数1",
+            "code": "5DE09392515",
+            "inputMode": "DropDownBox",
+            "type": "String",
+            "panelCode": "5DE01A51E11",
+            "version": 1
+          }, {
+            "createTime": 1508400015990,
+            "lastModified": 1508400015990,
+            "optionalValues": [
+              "值1",
+              "值2"
+            ],
+            "defaultOptionalValueIndex": 1,
+            "name": "参数2",
+            "code": "5DE09BA761A",
+            "inputMode": "DropDownBox",
+            "type": "String",
+            "panelCode": "5DE01A51E11",
+            "version": 1
+          }
+        ],
+        "refreshFrequency": 5,
+        "switchFrequency": 10,
+        "userCode": "52AC4B91C12",
+        "version": 1
+  }
+  ```