sunyj 8 lat temu
rodzic
commit
b2276abbec
1 zmienionych plików z 167 dodań i 0 usunięć
  1. 167 0
      kanban-console/README.md

+ 167 - 0
kanban-console/README.md

@@ -774,6 +774,173 @@
     </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>kanbanCode</td>
+        <td>String</td>
+        <td>✘</td>
+        <td>看板 code</td>
+        <td>5DE01DE4D16</td>
+    </tr>
+    <tr>
+        <td>description</td>
+        <td>String</td>
+        <td>✔</td>
+        <td>此次备份的说明</td>
+        <td>备份测试</td>
+    </tr>
+    <tr>
+        <td>kanban</td>
+        <td>JSON</td>
+        <td>✘</td>
+        <td>看板,具体字段请参照[数据字典](#看板数据字典)</td>
+        <td>-</td>
+    </tr>
+</table>
+
+## 通用接口
+  请参照[通用接口](#通用接口)
+
+## 获取指定看板的历史记录
+- 路径
+`
+/kanbanHistory/get/byKanban/{kanbanCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>看板 code,将路径中的 {kanbanCode} 替换为实际值</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>
+
+## 删除指定看板的历史记录
+- 路径
+`
+/kanbanHistory/delete/byKanban/{kanbanCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>String</td>
+        <td>看板 code,将路径中的 {kanbanCode} 替换为实际值</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>
+
+## 备份指定的看板
+- 路径
+`
+/kanbanHistory/backup/byKanban/{kanbanCode}
+`
+
+- 参数
+<table border=0 cellpadding=5 cellspacing=0>
+    <tr style="color:#fff">
+        <th>参数名</th>
+        <th>参数类型</th>
+        <th>描述</th>
+    </tr>
+    <tr>
+        <td>kanbanCode</td>
+        <td>String</td>
+        <td>看板 code,将路径中的 {kanbanCode} 替换为实际值</td>
+    </tr>
+    <tr>
+        <td>description</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>JSON</td>
+        <td>数据,具体字段请参照[数据字典](#看板历史记录数据字典)</td>
+    </tr>
+</table>
+
+## 恢复指定的看板
+- 路径
+`
+/kanbanHistory/restore/{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>
+
 # 面板实例
 ## <span id="面板实例数据字典">数据字典</span>
 <table border=0 cellpadding=5 cellspacing=0>