流程大师接口文档

最新推荐文章于 2022-02-11 13:02:02 发布
最新推荐文章于 2022-02-11 13:02:02 发布
阅读量237 收藏
点赞数
文章标签： runtime 人工智能 前端 ViewUI
原文链接：https://segmentfault.com/a/1190000008159503
版权

接口文档

约定

URI：http://172.16.1.40:8080
HTTP头：Content-Type: application/json
响应说明：基于Response Code来判断接口成功与否，200-299代表成功，300以上代表失败，400以上代表客户端异常，500以上代表服务端异常

API规范： 基于access_token机制

请求的URL后面都必须带上参数access_token, 不需要授权的接口除外，access_token在用户认证成功后返回（不走浏览器session机制）

防篡改机制：MD5+key

添加到header里面，key为hash

认证

管理后台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": ""
}
管理后台扫码登陆

步骤：

  1. 生成二维码

  2. 定时轮询查看状态

生成二维码

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": ""
    }]
}

  1. 根据ID获取流程详情

  2. 待办、已办列表（分页），搜索

  3. 发起流程，保存，提交

  4. 流程评论、通过、否决、退回、删除、再次发起、催办、撤回、知会、@

  5. 代理设置，取消

  6. 选人组件，组织，人员，搜索

  7. 我的发起，审批中、已完成、草稿，搜索

PC端

  1. 高级搜索

weixin_34210740
关注
『居善地』接口测试 — 1、接口和接口文档概念
繁华似锦Fighting
01-18 311
文章目录1、接口的概念2、为什么要使用接口3、接口文档介绍4、接口文档要素5、分层的自动化测试 1、接口的概念 接口又叫API，全称application programming interface：应用程序接口（规范），也就是我们经常会听说Web接口，APP接口。 详细说明： APP是一种基于C/S架构的应用程序，如抖音、微信等。完整的体验是基于APP客户端和后台云服务端共同作用的结果。 客户端和服务端的数据传递，也就是指客户端向服务端发送请求，服务端响应客户端的过程。 这一系列的通讯都是基于web协议
审核流程系统的接口自动化测试
03-01
使用python语言，实现审核流程系统的接口自动化测试，通过用例数据控制审核步骤
项⽬开发流程
qq_15832329的博客
11-26 449
项⽬开发流程 接⼝⽂档 ⼀、什么是接⼝⽂档？ 在项⽬开发中，web项⽬的前后端分离开发，APP开发，需要由前后端⼯程师共同定义接⼝，编写接⼝ ⽂档，之后⼤家都根据这个接⼝⽂档进⾏开发，到项⽬结束前都要⼀直维护。 ⼆、为什么要写接⼝⽂档？ 1、项⽬开发过程中前后端⼯程师有⼀个统⼀的⽂件进⾏沟通交流开发 2、项⽬维护中或者项⽬⼈员更迭，⽅便后期⼈员查看、维护 三、接⼝规范是什么？ ⾸先接⼝分为四部分：⽅法、uri、请求参数、返回参数 ⽅法 url 请求参数 返回参数 数据字典 ...
通过java实现e-cology v8.0版本流程待办事宜对接阿里云短信接口（API）发送短信方法
hkfxp的专栏
12-27 616
1、阿里云建立短信模板，含传递的参数； 2、根据短信模板构造短信类Message； 3、构造短信发送工具类SmsUtils（封装阿里云短信发送请求）; 4、处理OA系统中待办事宜，读取中间表，执行发送，并取得回复状态。 ...
发送钉钉审批接口
only_oy的博客
08-03 1万+
public class dingtalkGet {     public static String doGet(String url) throws URISyntaxException {         String result = null;         HttpGet request = new HttpGet(url);         HttpClient httpClie...
Flowable学习笔记
zcy841013的专栏
09-29 1403
最近公司项目中，在质量管理模块用到多角色审核，所以了解下Flowable的使用。 摘要：创建一个工作流引擎在开始之前稍作说明:flowable是activiti的原班核心人员从activiti分离出来的一套工作流引擎(这和activiti的诞生如出一辙),其核心是超快速、稳定的BPMN2流程引擎,易于与Spring集成使用。（引用别人的） 首先去官网 了解 FLOWABLE 用户手册 第一步...
外部存储器接口(与“信号”有关的文档共44张).pptx
最新发布
11-17
此外，文档还介绍了SDRAM的刷新时序和有效页关闭（DEAC）的过程。 9.1.2 部分，讨论了SBSRAM（同步静态随机访问存储器）接口在TMS320C6000 DSP中的工作方式。SBSRAM接口可以运行在CPU时钟频率或者其一半，这取决于...
营销系统与资产系统接口讨论资产管理管理系统流程细化关键业务解决方案物流专业组(“物资”文档)共19张.pptx
11-17
该文档详尽地阐述了如何通过接口技术，实现营销系统与资产全生命周期管理系统的无缝对接，以优化物资管理流程，提升效率。 首先，资产全生命周期管理系统与营销系统的接口方案概览明确了两者互动的核心，即数据的...
自己写windows优化大师需求文档
10-25
【标题】：自己编写...同时，这份C#的需求文档和附带的Windows优化大师使用指南可以作为学习和参考的宝贵资料，帮助你理解最佳实践和常见解决方案。在开发过程中，积极讨论和交流将有助于你解决问题，提高软件质量。
赚钱大师小程序v5.2.3源码
02-22
对于"赚钱大师"这样的应用，性能优化至关重要，可能涉及到减少网络请求次数、缓存策略、代码分割等技术，以确保用户在使用过程中体验流畅。 10. **安全与隐私**： 开发者在编写源码时，应遵循微信小程序的安全...
工作流_知会设置
weixin_30782331的博客
04-28 570
流程知会 难度等级1 1.5版新增了知会功能，可以在某个节点被处理后，通知相关人员该流程的去向。设计器截图见下图： 流程知会设置分为两部分：左侧是选择节点的流向、右侧是配置当前流向的知会信息。 以本例来解释 左侧有两个项目： 1“报销申请-->主管审批” 表达的是，该节点有一个流向“报销申请”指向“主管审批”...
Flowable的REST API（一）
热门推荐
of chen的博客
07-17 1万+
Flowable的REST API（一）Flowable Modeler分配任务关联表单应用定义流程任务流动问题下一步是什么 关于flowable的一些操作和介绍。 现在，我很高兴使用Flowable Modeler来建模业务流程并创建用户任务和流程实例，但是，我还想使用Flowable的REST API与流程实例和用户任务进行交互。 Flowable Modeler 开始使用Flowable的最...
Flowable入门系列文章101 - 激活流程定义
分享牛
12-30 448
flowable入门、flowable现状、flowable开源产品、flwoable入门系列、flowable课程、flowable与activiti区别Flowable是用Java编写的轻量级业务流程引擎。 Flowable流程引擎允许您部署BPMN 2.0流程定义（用于定义流程的行业XML标准），创建流程定义的流程实例，运行查询，访问活动或历史流程实例以及相关数据等等。本节将逐步介绍各种概念和API，通过您可以在自己的开发机器上进行的实例进行实现。
Activiti Flowable Camunda 钉钉流程设计器 审批流程 流程引擎 兼容 Activiti5 Activiti6 Activiti7 快速开发平台(收费)
java的第一堂课~
02-11 6357
快速开发平台 钉钉 流程设计器 Activiti Flowable Camunda 表单设计器
Flowable入门系列文章97 - 获取流程定义
分享牛
12-26 1538
flowable入门、flowable现状、flowable开源产品、flwoable入门系列、flowable课程、flowable与activiti区别Flowable是用Java编写的轻量级业务流程引擎。 Flowable流程引擎允许您部署BPMN 2.0流程定义（用于定义流程的行业XML标准），创建流程定义的流程实例，运行查询，访问活动或历史流程实例以及相关数据等等。本节将逐步介绍各种概念和API，通过您可以在自己的开发机器上进行的实例进行实现。
flowable功能点梳理
weixin_30360497的博客
05-29 1141
1. 设置流程责任人或任务人的方式 1：在taskProcess.bpmn中直接写 assignee=“admin” <userTask id="testUser" name="用户任务测试" flowable:assignee="admin"> 2：在taskProcess.bpmn中写 assignee=“${userID}”，变量的值要是String的，使用流程变量指...
java springcloud 微服务设计方案
10-12 392
springcloud+springcloudAlibaba+flowable 流程引擎 1.代码生成器：[正反双向](单表、主表、明细表、树形表，快速开发利器) freemaker模版技术 ,0个代码不用写,生成完整的一个模块,带页面、建表sql脚本、处理类、service等完整模块2.多数据源：（支持同时连接无数个数据库，可以不同的模块连接不同数的据库）支持N个数据源3.阿里数据库连接池druid,安全权限框架shiro（菜单权限和按钮权限）, 缓存框架ehcache4.代码编辑器，在...
flowable 多人签收_业务流程 BPM、工作流引擎、Flowable、Activiti
weixin_39981360的博客
12-19 1689
特点基于 Flowable(Activiti)生来具有的稳定工作流引擎支持在线流程设计器，流程导入导出，符合 BPMN 规范，中国式工作流支持流程办理、退回、自由流、会签、并行、串行、服务任务等支持退回任务，退回到指定环节，退回到上一步，退回到发起人支持转办任务，将任务交接给他人办理，办理完成后继续下一步骤支持委托任务，将任务委托给他人，他人办理完成后再回到委托人支持智能提交，相同处理人自动跳过，...
媒讯EAS项目与CTC接口需求及设计文档
"该项目文档是关于媒讯...该文档作为接口开发的基础，不仅提供了技术上的指导，也为业务流程的整合和系统测试提供了蓝图，确保了项目实施的顺利进行。在实际工作中，应根据项目的具体需求，不断完善和更新这份文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值