作者:钟剑华  历史版本:1  更新时间:2024-06-15 15:03

流程定义列表(分页)

简述:

  • 根据传入参数查询,并返回流程定义列表

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
request APIRequest[1] 动态查询请求对象

请求参数示例:

{
    "parameters": [],
    "requestPage": {
        "pageNo": 1,
        "limit": 20
    },
    "sorts": []
}

返回示例:

{
  "state": 200,
  "request": null,
  "message": "流程定义列表查询成功!",
  "cause": "",
  "variables": {},
  "data": {
    "dataResult": [{
      "pk": "",
      "name": "开发单表",
      "ip": null,
      "createBy": "654622686055497728",
      "createTime": "2020-02-21 11:09:38",
      "updateBy": "654622686055497728",
      "updateTime": "2020-02-21 11:25:26",
      "tenantId": null,
      "dataStatus": null,
      "dbtype": null,
      "defId": "680370541093191680",
      "parentDefId": null,
      "parentNodeId": null,
      "srcDefId": null,
      "defKey": "Process_0f8oaab",
      "desc": "",
      "typeId": null,
      "status": "deploy",
      "testStatus": "test",
      "bpmnDefId": "Process_0f8oaab:1:680370541651034112",
      "bpmnDeployId": "680370541353238528",
      "version": 1,
      "boCode": "kfdb",
      "boVersion": 1,
      "mainDefId": "680370541093191680",
      "isMain": "Y",
      "reason": null,
      "bpmDefineXmlPo": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": null,
        "defXml": null,
        "bpmnXml": null
      },
      "primaryBpmnXml": null,
      "designer": "web设计器",
      "typeName": null,
      "authorizeRight": {
        "authType": "manage",
        "defKey": null,
        "managementEdit": "Y",
        "managementDel": "Y",
        "managementStart": "Y",
        "managementSet": "Y",
        "managementInternational": "Y",
        "managementClean": "Y",
        "managementGuideEdit": "Y",
        "instanceDel": "N",
        "instanceLog": "N",
        "rightContent": "{\"m_edit\":\"Y\",\"m_del\":\"Y\",\"m_start\":\"Y\",\"m_set\":\"Y\",\"m_international\":\"Y\",\"m_clean\":\"Y\",\"m_guideEdit\":\"Y\"}",
        "rightJsonObj": {
          "m_edit": "Y",
          "m_del": "Y",
          "m_start": "Y",
          "m_set": "Y",
          "m_international": "Y",
          "m_clean": "Y",
          "m_guideEdit": "Y"
        }
      },
      "reminders": null,
      "trigerFlows": null,
      "auths": null,
      "sn": 0,
      "favorites": false,
      "hasGuide": false,
      "id": "680370541093191680",
      "main": false,
      "bpmnXml": null,
      "defXml": null
    }],
    "pageResult": {
      "limit": 20,
      "page": 1,
      "totalCount": 136,
      "totalPages": 7
    }
  }
}

返回参数说明:

名称 类型 备注
dataResult List< BpmDefinePo > 流程定义列表数据
pageResult Object 分页数据

根据id获取对象信息

简述:

  • 根据id获取对象信息

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defId String 主键id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/get?defId=626866373389189120

返回示例:

{
      "pk": "",
      "name": "开发单表",
      "ip": null,
      "createBy": "654622686055497728",
      "createTime": "2020-02-21 11:09:38",
      "updateBy": "654622686055497728",
      "updateTime": "2020-02-21 11:25:26",
      "tenantId": null,
      "dataStatus": null,
      "dbtype": null,
      "defId": "680370541093191680",
      "parentDefId": null,
      "parentNodeId": null,
      "srcDefId": null,
      "defKey": "Process_0f8oaab",
      "desc": "",
      "typeId": null,
      "status": "deploy",
      "testStatus": "test",
      "bpmnDefId": "Process_0f8oaab:1:680370541651034112",
      "bpmnDeployId": "680370541353238528",
      "version": 1,
      "boCode": "kfdb",
      "boVersion": 1,
      "mainDefId": "680370541093191680",
      "isMain": "Y",
      "reason": null,
      "bpmDefineXmlPo": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": null,
        "defXml": null,
        "bpmnXml": null
      },
      "primaryBpmnXml": null,
      "designer": "web设计器",
      "typeName": null,
      "authorizeRight": {
        "authType": "manage",
        "defKey": null,
        "managementEdit": "Y",
        "managementDel": "Y",
        "managementStart": "Y",
        "managementSet": "Y",
        "managementInternational": "Y",
        "managementClean": "Y",
        "managementGuideEdit": "Y",
        "instanceDel": "N",
        "instanceLog": "N",
        "rightContent": "{\"m_edit\":\"Y\",\"m_del\":\"Y\",\"m_start\":\"Y\",\"m_set\":\"Y\",\"m_international\":\"Y\",\"m_clean\":\"Y\",\"m_guideEdit\":\"Y\"}",
        "rightJsonObj": {
          "m_edit": "Y",
          "m_del": "Y",
          "m_start": "Y",
          "m_set": "Y",
          "m_international": "Y",
          "m_clean": "Y",
          "m_guideEdit": "Y"
        }
      },
      "reminders": null,
      "trigerFlows": null,
      "auths": null,
      "sn": 0,
      "favorites": false,
      "hasGuide": false,
      "id": "680370541093191680",
      "main": false,
      "bpmnXml": null,
      "defXml": null
    }

返回参数说明:

名称 类型 备注
data BpmDefinePo 流程定义对象

根据流程定义key查询信息

简述:

  • 根据流程定义key查询信息

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defKey String 流程定义key
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/getByDefKey?defKey=Process_0f8oaab

返回示例:

{
      "pk": "",
      "name": "开发单表",
      "ip": null,
      "createBy": "654622686055497728",
      "createTime": "2020-02-21 11:09:38",
      "updateBy": "654622686055497728",
      "updateTime": "2020-02-21 11:25:26",
      "tenantId": null,
      "dataStatus": null,
      "dbtype": null,
      "defId": "680370541093191680",
      "parentDefId": null,
      "parentNodeId": null,
      "srcDefId": null,
      "defKey": "Process_0f8oaab",
      "desc": "",
      "typeId": null,
      "status": "deploy",
      "testStatus": "test",
      "bpmnDefId": "Process_0f8oaab:1:680370541651034112",
      "bpmnDeployId": "680370541353238528",
      "version": 1,
      "boCode": "kfdb",
      "boVersion": 1,
      "mainDefId": "680370541093191680",
      "isMain": "Y",
      "reason": null,
      "bpmDefineXmlPo": {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": null,
        "defXml": null,
        "bpmnXml": null
      },
      "primaryBpmnXml": null,
      "designer": "web设计器",
      "typeName": null,
      "authorizeRight": {
        "authType": "manage",
        "defKey": null,
        "managementEdit": "Y",
        "managementDel": "Y",
        "managementStart": "Y",
        "managementSet": "Y",
        "managementInternational": "Y",
        "managementClean": "Y",
        "managementGuideEdit": "Y",
        "instanceDel": "N",
        "instanceLog": "N",
        "rightContent": "{\"m_edit\":\"Y\",\"m_del\":\"Y\",\"m_start\":\"Y\",\"m_set\":\"Y\",\"m_international\":\"Y\",\"m_clean\":\"Y\",\"m_guideEdit\":\"Y\"}",
        "rightJsonObj": {
          "m_edit": "Y",
          "m_del": "Y",
          "m_start": "Y",
          "m_set": "Y",
          "m_international": "Y",
          "m_clean": "Y",
          "m_guideEdit": "Y"
        }
      },
      "reminders": null,
      "trigerFlows": null,
      "auths": null,
      "sn": 0,
      "favorites": false,
      "hasGuide": false,
      "id": "680370541093191680",
      "main": false,
      "bpmnXml": null,
      "defXml": null
    }

返回参数说明:

名称 类型 备注
data BpmDefinePo 流程定义对象

保存

简述:

  • 保存【流程定义】信息

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:

暂无

  • Body:
名称 类型 是否必须 默认值 备注 其他信息
defId String 流程定义ID
parentDefId String 父流程定义ID
parentNodeId String 父流程定义节点ID
srcDefId String 源流程定义ID
name String 流程名称
defKey String 流程业务主键
desc String 流程描述
typeId String 所属分类ID
status String 流程状态。草稿、发布、禁用
testStatus String 测试状态
bpmnDefId String BPMN - 流程定义ID
bpmnDeployId String BPMN - 流程发布ID
version Integer 版本 - 当前版本号
boCode String 业务对象编码
boVersion Integer 业务对象版本
mainDefId String 版本 - 主版本流程ID
isMain String 版本 - 是否主版本
reason String 版本 - 变更理由
createBy String 创建人ID
createTime java.util.Date 创建时间
updateBy String 更新人ID
updateTime java.util.Date 更新时间
bpmDefineXmlPo BpmDefineXmlPo 流程定义大数据

BpmDefineXmlPo结构如下:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| :—–: | :—–: | :—–: | :—–: | :—– | :—– |
| defId | String | 否 | | 流程定义ID |
| defXml | String | 否 | | 流程定义XML |
| bpmnXml | String | 否 | | 流程定义BPMN格式XML |

请求参数示例:

{
  "deploy": true,
  "newDeploy": false,
  "typeId": "",
  "defId": "",
  "defXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<definitions xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" xmlns:bpmndi=\"http://www.omg.org/spec/BPMN/20100524/DI\" xmlns:dc=\"http://www.omg.org/spec/DD/20100524/DC\" xmlns:di=\"http://www.omg.org/spec/DD/20100524/DI\" id=\"Definitions_0u9flh9\" targetNamespace=\"http://bpmn.io/schema/bpmn\" xsi:schemaLocation=\"http://www.omg.org/spec/BPMN/20100524/MODEL BPMN20.xsd\"><process id=\"Process_0pd2hdg\" name=\"测试保存\" isExecutable=\"false\"><startEvent id=\"StartEvent_125iyi0\" name=\"开始\"><outgoing>Flow_01620rj</outgoing></startEvent><userTask id=\"Activity_0i1o9bo\" name=\"发起\"><incoming>Flow_01620rj</incoming><outgoing>Flow_0e39d4u</outgoing></userTask><sequenceFlow id=\"Flow_01620rj\" sourceRef=\"StartEvent_125iyi0\" targetRef=\"Activity_0i1o9bo\" /><userTask id=\"Activity_0goylkr\" name=\"审批\"><incoming>Flow_0e39d4u</incoming><outgoing>Flow_0koht4p</outgoing></userTask><sequenceFlow id=\"Flow_0e39d4u\" sourceRef=\"Activity_0i1o9bo\" targetRef=\"Activity_0goylkr\" /><endEvent id=\"Event_175o0yr\"><incoming>Flow_0koht4p</incoming></endEvent><sequenceFlow id=\"Flow_0koht4p\" sourceRef=\"Activity_0goylkr\" targetRef=\"Event_175o0yr\" /></process><bpmndi:BPMNDiagram id=\"BPMNDiagram_1wzjuq3\"><bpmndi:BPMNPlane id=\"BPMNPlane_11wo882\" bpmnElement=\"Process_0pd2hdg\"><bpmndi:BPMNShape id=\"_BPMNShape_StartEvent_125iyi0\" bpmnElement=\"StartEvent_125iyi0\"><dc:Bounds x=\"180\" y=\"240\" width=\"36\" height=\"36\" /></bpmndi:BPMNShape><bpmndi:BPMNShape id=\"Activity_0i1o9bo_di\" bpmnElement=\"Activity_0i1o9bo\"><dc:Bounds x=\"270\" y=\"218\" width=\"100\" height=\"80\" /></bpmndi:BPMNShape><bpmndi:BPMNEdge id=\"Flow_01620rj_di\" bpmnElement=\"Flow_01620rj\"><di:waypoint x=\"216\" y=\"258\" /><di:waypoint x=\"270\" y=\"258\" /></bpmndi:BPMNEdge><bpmndi:BPMNShape id=\"Activity_0goylkr_di\" bpmnElement=\"Activity_0goylkr\"><dc:Bounds x=\"430\" y=\"218\" width=\"100\" height=\"80\" /></bpmndi:BPMNShape><bpmndi:BPMNEdge id=\"Flow_0e39d4u_di\" bpmnElement=\"Flow_0e39d4u\"><di:waypoint x=\"370\" y=\"258\" /><di:waypoint x=\"430\" y=\"258\" /></bpmndi:BPMNEdge><bpmndi:BPMNShape id=\"Event_175o0yr_di\" bpmnElement=\"Event_175o0yr\"><dc:Bounds x=\"592\" y=\"240\" width=\"36\" height=\"36\" /></bpmndi:BPMNShape><bpmndi:BPMNEdge id=\"Flow_0koht4p_di\" bpmnElement=\"Flow_0koht4p\"><di:waypoint x=\"530\" y=\"258\" /><di:waypoint x=\"592\" y=\"258\" /></bpmndi:BPMNEdge></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></definitions>"
}

返回示例:

{
  "state": 200,
  "request": null,
  "message": "保存流程定义成功",
  "cause": "",
  "variables": {},
  "data": null
}

返回参数说明:

名称 类型 备注
data Void

复制流程定义信息

简述:

  • 复制一条数据,用新的key保存

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
oldDefId String 主键id
newDefKey String 新主键key
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/copy?oldDefId=626866373389189120&newDefKey=test

返回示例:

{
    "state": 200,
    "request": null,
    "message": "复制流程定义成功",
    "cause": "",
    "variables": {},
    "data": {}
}

返回参数说明:

名称 类型 备注
data Void

删除

简述:

  • 批量删除【流程定义】记录

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defIds String 主键id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/remove?defIds=654357778126602240,638399136323862528

返回示例:

{
  "state": 200,
  "request": null,
  "message": "删除流程定义成功",
  "cause": "",
  "variables": {},
  "data": null
}

返回参数说明:

名称 类型 备注
data Void

清除测试状态流程的测试数据

简述:

  • 清除测试状态流程的测试数据

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defId String 主键id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/cleanData?defId=626866373389189120

返回示例:

{
    "state": 200,
    "request": null,
    "message": "清除数据成功",
    "cause": "",
    "variables": {},
    "data": {}
}

返回参数说明:

名称 类型 备注
data Void

设置分类

简述:

  • 设置分类

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defIds String 主键id
typeId String 分类主键id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/setCategory?defIds=626866373389189120&typeId=1234

返回示例:

{
    "state": 200,
    "request": null,
    "message": "设置分类成功!",
    "cause": "",
    "variables": {},
    "data": {}
}

返回参数说明:

名称 类型 备注
data Void

返回流程设计生成的

简述:

  • 返回流程设计生成的

请求URL:

请求方式:

  • GET

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defId String 主键id
type String type类型 ‘bpmn’/‘def’
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/bpmnXml?defId=626866373389189120&type=bpmn

返回示例:

返回参数说明:

名称 类型 备注
data Void

发布流程定义

简述:

  • 发布流程定义

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
defId String 主键id
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/deploy?defId=626866373389189120

返回示例:

{
    "state": 200,
    "request": null,
    "message": "发布流程定义成功!",
    "cause": "",
    "variables": {},
    "data": {}
}

返回参数说明:

名称 类型 备注
data Void

导出流程定义对象

简述:

  • 导出格式为*.zip的流程定义对象,zip文件包含多个xml文件,每一个xml文件都是一个流程定义对象

请求URL:

请求方式:

  • POST

请求参数:

  • Headers:
名称 类型 是否必须 默认值 备注 其他信息
X-Authorization-access_token String 系统令牌
  • Query:
名称 类型 是否必须 默认值 备注 其他信息
ids String[] 主键id数组
  • Body:

暂无

请求参数示例:

http://192.168.3.230:15100/ibps/business/v3/bpm/definition/export?ids=626866373389189120,626866373389189121

返回示例:

该返回为文件流,无法展示

返回参数说明:

名称 类型 备注

备注