O2OA工作流API简介

一、简介

1. O2OA API文档入口: http://ip:port/x_program_center/jest/list.html
2. 工作流API文档路径：/x_processplatform_assemble_surface/jest/index.html
3. 组织管理认证API文档路径：/x_organization_assemble_authentication/jest/index.html

二、接口设计特点

• 接口采用http restful 风格，同一个接口的不同请求类型可能表示不同的功能。

• 两种参数：
  1.url路径参数
  2.body参数： 将 Map<String,Object>类型的json传入http body即可

• 认证方式
  1.rul参数方式： url?x-token=xxx
  2.http header: authorization=xxx

• 响应格式：json

三、常用工作流API介绍

1. 登录O2OA

• API名称：login
• 接口地址：/x_organization_assemble_authentication/jaxrs/authentication
• 描述：通过用户名密码登录o2oa获取token，用于其他接口认证
  

2. 开启流程

• API名称：create
• 接口地址：/x_processplatform_assemble_surface/jaxrs/work/process/{processFlag}?v=6.1
• 描述：开启一个流程，并获取流程实例id
• 入参：
  url参数processFlag：流程图的标识
  latest ：false
  identity： o2oa人员身份
  data:自定义业务数据
  title：自定义流程实例标题
  workStatus2：自定义流程实例状态
• 响应：
  流程实例id：data[0].work
• 说明：
  1.开启流程后流程将从开始节点向下流转
  2.如果第一个人工节点未配置审批人，o2oa将按默认机制查询处理人，一般是流程的创建人。
  

3.获取流程实例

• API名称：V2GetWorkOrWorkCompleted
• 接口地址：/x_processplatform_assemble_surface/jaxrs/work/v2/workorworkcompleted/{workOrWorkCompleted}?v=6.1
• 描述：
  workOrWorkCompleted 为流程实例id,即发起流程时接口响应的work字段值
  该接口可获取到当前岗位节点名称，当前任务处理人，当前有哪些任务，历史审批记录等

4.对指定的work添加局部data数据

• API名称：createWithWork
• 接口地址：/x_processplatform_assemble_surface/jaxrs/data/work/{id}?v=6.1
• 描述：给指定的流程实例添加业务数据
  url参数：id为流程实例id,即发起流程时接口响应的work字段值
  body参数：接受Map<String,Object>类型的json格式参数

5.重置待办

• API名称：reset
• 接口地址：/x_processplatform_assemble_surface/jaxrs/task/{id}/reset
• 描述：可用于给非固定审批节点设置处理人，当流程流转到人工节点后通过该接口替换审批人员
  url参数：id为 当前taskId
  body参数：identityList审批人在o2oa平台的身份标识

6.获取身份

• API名称：listMajorWithPerson
• 接口地址：/x_organization_assemble_express/jaxrs/identity/list/major/person
• 描述：通过业务系统人员标识获取o2oa系统对应身份

7.工作调度

• API名称：V2Reroute
• 接口地址：/x_processplatform_assemble_surface/jaxrs/work/v2/{id}/reroute
• 描述：将流程调度到指定节点
  id:流程实例id
  activity：流程节点标识
  manualForceTaskIdentityList：审批人身份
  mergeWork：false
  activityType:manual
  

8.尝试流转

• API名称：processing
• 接口地址：/x_processplatform_assemble_surface/jaxrs/work/{id}/processing
• 描述：可用于将卡在非人工节点的流程尝试流转，如果某个选择节点条件不成立流程停留在选择节点，可以调用添加局部数据接口使得选择节点条件成立，然后调用尝试流转接口让流程继续。
  

9.执行当前节点

• API名称：processing
• 接口地址：/x_processplatform_assemble_surface/jaxrs/task/{id}/processing?v=6.1
• 描述：将当前节点按指定路由流转
  id:taskId
  routeName:路由名称

10.流程实例分页查询

10.1 按条件对当前用户待办分页查询

• API名称：listMyFilterPaging
• 接口地址：/x_processplatform_assemble_surface/jaxrs/task/list/my/filter/{page}/size/{pageSize}?v=6.1
• 描述：按条件对当前用户待办分页查询
  

10.2 按条件对当前用户所有任务(含待办和已办)分页查询

• API名称：listAllMyFilterPaging
• 接口地址：/x_processplatform_assemble_surface/jaxrs/task/listall/my/filter/{page}/size/{pageSize}?v=6.1
• 描述：按条件对当前用户所有任务(含待办和已办)分页查询