流程大師接口文檔
接口文檔
約定
URI：http://172.16.1.40:8080
HTTP頭：Content-Type: application/json
響應說明：基於Response Code來判斷接口成功與否，200-299表明成功，300以上表明失敗，400以上表明客戶端異常，500以上表明服務端異常 css
API規範： 基於access_token機制前端
請求的URL後面都必須帶上參數access_token, 不須要受權的接口除外，access_token在用戶認證成功後返回（不走瀏覽器session機制）json
防篡改機制：MD5+key瀏覽器
添加到header裏面，key爲hashsession
認證
管理後臺PC客戶端跳轉登錄
URI：/token
HTTP方法：POST
請求實體：架構
{
"userId": "8e4eca6bb62a4caea183ce66a2768682",
"name": "張三",
"avatar": "xxxxx",
"orgId": "108f826f-4a36-4742-a124-6ade824c85ed",
"ticket": "bebd9c2dc5c943249b7ddc211f7d02d3",
"domainId": "atwork"
}
響應實體：app
{
"access_token": "1ad88f34090b46498e96c21ba858e7dd",
"organizations": [{
"name": "恆拓高科",
"avatar": "",
"orgId": ""
}],
"avatar": "",
"name": ""
}
管理後臺掃碼登錄
步驟：dom
生成二維碼url
定時輪詢查看狀態設計
生成二維碼
URI：
HTTP方法：GET
請求實體：
{
"qrcode": "圖片base64"
}
定時輪詢查看狀態
管理後臺帳號密碼登錄
URI：
HTTP方法：POST
請求實體：
{
"username": "15912345678",
"password": "xxxxx"
}
響應實體：
移動端，PC端登錄
URI：/token
HTTP方法：POST
請求實體：
{
"userId": "8e4eca6bb62a4caea183ce66a2768682",
"name": "張三",
"avatar": "xxxxx",
"orgId": "108f826f-4a36-4742-a124-6ade824c85ed",
"ticket": "bebd9c2dc5c943249b7ddc211f7d02d3",
"domainId": "atwork"
}
響應實體：
{
"access_token": "1ad88f34090b46498e96c21ba858e7dd",
"organizations": [{
"name": "恆拓高科",
"avatar": "",
"orgId": ""
}],
"avatar": "",
"name": ""
}
管理後臺
流程分類
流程分類添加
URI：/repository/process-categories/
HTTP方法：POST
請求實體：
{
"name": "分類1",
"parentId": "xxxxx"
}
響應實體：
{}
流程分類編輯
URI：/repository/process-categories/:id
HTTP方法：PUT
請求實體：
{
"name": "分類1"
}
響應實體：
流程分類刪除
URI：/repository/process-categories/:id
HTTP方法：DELETE
響應實體：
流程分類樹
URI：/repository/process-categories/
HTTP方法：GET
響應實體：
{
"data": [{
"id": "",
"name": "",
"children": [{
}]
}]
}
流程列表
URI：/repository/process-definitions
HTTP方法：GET
參數說明：
category: 流程分類，不傳時默認查詢全部 suspended: 是否掛起，默認false startableByUser: 篩選某個用戶有權限發起的流程
響應實體：
{
"data": [{
"id": "xxxx",
"key": "",
"name": "請假流程",
"icon": "",
"suspended": false, // 是否掛起
"creator": "建立者",
"instanceCount": 88,
"lastUpdated": "毫秒數" // 最後更新時間
}]
}
流程複製
流程移動
URI：/repository/process-definitions/:id
HTTP方法：PUT
請求實體：
{
"category": "categoryId"
}
響應實體：
{
}
流程做廢
URI：/repository/process-definitions/:id
HTTP方法：DELETE
流程啓用
URI：/repository/process-definitions/:id
HTTP方法：PUT
請求實體：
{
"action" : "activate"
}
流程停用
URI：/repository/process-definitions/:id
HTTP方法：PUT
請求實體：
{
"action" : "suspend"
}
流程建立-標準流程
URI：/repository/process-definitions/
HTTP方法：POST
請求實體：
{
"name": "請假流程",
"category": "categoryId",
"description": "description",
"icon": "mediaId"
}
響應實體：
{
}
流程建立-自由流程
URI：/repository/free-process-definitions/
HTTP方法：POST
請求實體：
{
"name": "請假流程",
"category": "categoryId",
"description": "description",
"icon": "mediaId"
}
響應實體：
{}
獲取流程詳情
URI：/repository/process-definitions/:id
HTTP方法：GET
響應實體：
{
"id": "xxxx",
"name": "請假流程",
"suspended": false, // 是否掛起
"creator": "建立者",
"instanceCount": 88,
"lastUpdated": "毫秒數" // 最後更新時間
}
流程表單保存
URI：/repository/process-forms/
HTTP方法：POST
請求實體：
{
"components": [], // 組件
"css": {},
"description": "description"
}
響應實體：
{}
流程設計
URI：/repository/deployements
HTTP方法：POST
請求實體：
{
}
響應實體：
{}
流程設置
URI：/process-settings/:id
HTTP方法：PUT
請求實體：
{
"suspended": false,
"sn": "'abc' + date + sn(6)",
"starterScope": {
"orgs": ["xxx"],
"users": ["xxx"]
},
"category": "",
"icon": ""
}
響應實體：
{}
流程數據
流程數據查詢
URI：/repository/process-datas/:key
HTTP方法：GET
參數說明：
按提交日期篩選：createdFrom=2017-01-01, createdTo=2017-01-30 按部門篩選: orgId 按選項篩選: field_:id=value, field_:id=[] 分頁: start=0, limit=20
響應實體：
{
"data": [{
"id: "",
"sn": "",
"starter": "",
"starterOrg": "",
"starterJob": "",
"created": "",
"status": "",
"finished": "",
"field": [{
id: value
}],
"handingInfo": [{
"approver": "",
"handleTime": "",
"content": ""
}]
節點1意見、節點1結果、節點1簽名、節點1時間……節點N意見、節點N結果、節點N簽名、節點N時間
}]
}
流程數據刪除
URI：/data/process-instances/:id
HTTP方法：DELETE
流程數據導出
URI：/data/process-exports/:id
HTTP方法：GET
通信錄管理
獲取組織架構樹
URI：/orginisation/orgs/:id/tree
HTTP方法：GET
響應實體：
{
"data": [{
"id": "",
"name": "",
"children": [{}],
"initiated": false
}]
}
獲取某個組織下的僱員
URI：/orginisation/orgs/:id/members
HTTP方法：GET
參數說明： recursive=true 是否包含子部分紅員 keyword=用戶名或者姓名 start=0 limit=20
響應實體：
{
"data": [{
"userId": "",
"name": "",
"job": "",
"avatar": ""
}]
}
角色定義
角色新增
URI：/orginisation/roles?zoneId=:orgId
HTTP方法：POST
請求實體：
{
"name": "",
"description": ""
}
響應實體：
{
}
角色修改
URI：/orginisation/roles/:id
HTTP方法：PUT
請求實體：
{
"name": "",
"description": ""
}
響應實體：
{
}
角色刪除
URI：/orginisation/roles/:id
HTTP方法：DELETE
獲取全部角色
URI：/orginisation/roles?zoneId=:orgId
HTTP方法：GET
響應實體：
{
"data": [{
"id": "",
"name": "",
"description": "",
"inherited": false
}]
}
說明：
機構負責人和分管領導是每一個組織默認都有的角色，org-leader和org-superior
開啓關閉獲取上級定義的角色
URI：/orginisation/role-settings/
HTTP方法：PUT
請求實體：
{
"inherit": true
}
響應實體：
{
}
角色分配
獲取角色分配列表
URI：/orginisation/role-assignments?orgId=:orgId
HTTP方法：GET
響應實體：
{
"data": [{
"role": {
"id": "",
"name": "",
},
"user": {
"id": "",
"name": "",
}
}]
}
角色分配新增修改刪除
URI：/orginisation/role-assignments?orgId=:orgId
HTTP方法：PUT
請求實體：
[{
"role": {
"id": "",
"name": "",
},
"user": {
"id": "",
"name": "",
}
}]
響應實體：
{
}
分管設置
獲取列表
URI：/orginisation/zones/:id
HTTP方法：GET
響應實體：
{
"data": [{
"orgId": "",
"admins": [{
"id": "",
"name": ""
}]
}]
}
分管設置新增或修改
URI：/orginisation/zones/
HTTP方法：POST/PUT
請求實體：
{
"orgId": "",
"admins": ["", ""]
}
響應實體：
{
}
媒體文件
上傳文件
URI：/files/
HTTP方法：POST
HTTP請求頭：Content-Type: multipart/form-data
請求實體：
{
"file": ""
}
響應實體：
{
"mediaId": "",
"name": "",
"size": ""
}
上傳圖片
下載
URI：/files/:id
HTTP方法：GET
響應實體：
{
"url": ""
}
切換管理區
前端實現
修改管理員密碼
移動端
獲取待辦數、知會數
URI：
HTTP方法：GET
響應實體：
{
}
身份切換
前端實現
獲取當前組織下的流程列表
URI：/repository/process-definitions/
HTTP方法：GET
請求參數：
startableByUser, 用戶ID zoomId, 組織ID
響應實體：
{
"data": [{
"id": "xxxx",
"key": "",
"name": "請假流程",
"icon": ""
}]
}
根據ID獲取流程詳情
URI：/repository/process-definitions/:id
HTTP方法：GET
響應實體：
{
"components": [],
"type": "",
"name": "",
"id": "",
"version": "",
"key": "",
"comments": [],
"approveInfo": []
}
發起流程
URI：/runtime/process-instances
HTTP方法：POST
請求實體:
{
"processDefinitionId": "key:version:xx",
"components": [],
"starter": "",
"orgId": ""
}
響應實體：
{
}
保存流程
URI：/runtime/process-instances-draft
HTTP方法：POST
請求實體:
{
"processDefinitionId": "key:version:xx",
"components": [],
"starter": "",
"orgId": ""
}
響應實體：
{
}
流程評論
URI：/runtime/process-comments?instanceId=?
HTTP方法：POST
請求實體:
{
"content": "",
"notify": [""],
"image": []
"attachment": []
}
響應實體：
{
}
流程贊成
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action" : "agree",
"mediaId": "",
"content": ""
}
響應實體：
{
}
流程贊成或者終結(自由流)
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action" : "agree",
"mediaId": "",
"content": "",
"nextApprovers": [""],
"finish": true
}
響應實體：
{
}
流程拒絕
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action" : "refuse",
"content": ""
}
響應實體：
{
}
流程退回
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action" : "fallback",
"to": "previous/starter",
"content": ""
}
響應實體：
{
}
流程撤回
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action": "withdraw"
}
響應實體：
{
}
流程催辦
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action": "prompt"
}
響應實體：
{
}
流程知會
URI：/runtime/tasks/:id
HTTP方法：POST
請求實體:
{
"action": "notify"
}
響應實體：
{
}
個人待辦列表(包括已辦)
URI：/runtime/tasks/
HTTP方法：GET
請求參數：
candidateUser候選人 keyword start=0 limit=20 owner=userId
響應實體：
{
"data": [{
"name": "",
"creater": "",
"sn": "",
"taskId": "",
"createTime": ""
}]
}
用戶代理
URI：/organistion/delegations
HTTP方法：POST
請求實體:
{
"userId": "",
"orgId": "",
"roleId": "",
"delegateTo": [],
"startTime": "",
"endTime": ""
}
響應實體：
{
}
用戶代理取消
URI：/organistion/delegations/:id
HTTP方法：DELETE
用戶代理查詢
URI：/organistion/delegations?userId=:userId
HTTP方法：GET
響應實體：
{
"data": [{
"id": "",
"orgName": "",
"roleName": "",
"delegaters": [{
"id": "",
"name": "",
"startTime": "",
"endTime": ""
}]
}]
}
個人發起(審批中)
URI：/runtime/process-instances/
HTTP方法：GET
請求參數：
starter keyword start=0 limit=20
響應實體：
{
"data": [{
"name": "",
"creater": "",
"sn": "",
"taskId": "",
"createTime": ""
}]
}
個人發起(已完成)
URI：/history/historic-process-instances/
HTTP方法：GET
請求參數：
starter keyword start=0 limit=20
響應實體：
{
"data": [{
"name": "",
"creater": "",
"sn": "",
"taskId": "",
"createTime": ""
}]
}
根據ID獲取流程詳情
待辦、已辦列表（分頁），搜索
發起流程，保存，提交
流程評論、經過、否決、退回、刪除、再次發起、催辦、撤回、知會、@
代理設置，取消
選人組件，組織，人員，搜索
個人發起，審批中、已完成、草稿，搜索
PC端
高級搜索
- 1. 接口&接口文檔
- 2. laravel接口 接口文檔
- 3. 【Android】接口文檔
- 4. swagger接口文檔
- 5. 接口文檔-swagger2UI
- 6. opentsdb接口文檔
- 7. swagger2 接口文檔,整個微服務接口文檔
- 8. API接口文檔編寫--易文檔
- 9. 接口測試--接口文檔規範
- 10. 接口測試（十）--接口文檔
- 更多相關文章...
- • WSDL 文檔 - WSDL 教程
- • XSL-FO 文檔 - XSL-FO 教程
- • 算法總結-滑動窗口
- • JDK13 GA發佈：5大特性解讀
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. python的安裝和Hello，World編寫
- 2. 重磅解讀：K8s Cluster Autoscaler模塊及對應華爲雲插件Deep Dive
- 3. 鴻蒙學習筆記2（永不斷更）
- 4. static關鍵字 和構造代碼塊
- 5. JVM筆記
- 6. 無法啓動 C/C++ 語言服務器。IntelliSense 功能將被禁用。錯誤: Missing binary at c:\Users\MSI-NB\.vscode\extensions\ms-vsc
- 7. 【Hive】Hive返回碼狀態含義
- 8. Java樹形結構遞歸（以時間換空間）和非遞歸（以空間換時間）
- 9. 數據預處理---缺失值
- 10. 都要2021年了，現代C++有什麼值得我們學習的？
- 1. 接口&接口文檔
- 2. laravel接口 接口文檔
- 3. 【Android】接口文檔
- 4. swagger接口文檔
- 5. 接口文檔-swagger2UI
- 6. opentsdb接口文檔
- 7. swagger2 接口文檔,整個微服務接口文檔
- 8. API接口文檔編寫--易文檔
- 9. 接口測試--接口文檔規範
- 10. 接口測試（十）--接口文檔