作者：钟剑华历史版本：1 更新时间：2024-11-20 15:41

流程代理列表

简述：

【流程代理】列表(分页条件查询)数据

请求URL：

http://ip:port/ibps/business/v3/bpm/agent/query
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

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": null,
        "ip": null,
        "createBy": "1",
        "createTime": "2019-09-27 14:56:47",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "627156688490725376",
        "title": "cc代理姗姗",
        "delegatorId": "626422189268140032",
        "agenterId": "626357874037096448",
        "procDefKey": "",
        "isEnabled": "disabled",
        "effectiveTime": "2019-09-27",
        "expiryTime": "2019-12-28",
        "agentType": "part",
        "delegatorName": "姗姗",
        "agenterName": "ccj工具人",
        "procDefId": null,
        "procDefName": null,
        "delBeforeSave": true,
        "bpmAgentDefPoList": [],
        "bpmAgentConditionPoList": []
      },
      {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": "1",
        "createTime": "2019-09-26 19:43:10",
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "626866373389189120",
        "title": "产品代理",
        "delegatorId": "626796627947945984",
        "agenterId": "626796961529331712",
        "procDefKey": "",
        "isEnabled": "disabled",
        "effectiveTime": "2019-09-26",
        "expiryTime": "2019-12-25",
        "agentType": "part",
        "delegatorName": "产品主管",
        "agenterName": "产品助理",
        "procDefId": null,
        "procDefName": null,
        "delBeforeSave": true,
        "bpmAgentDefPoList": [],
        "bpmAgentConditionPoList": []
      }
    ],
    "pageResult": {
      "limit": 20,
      "page": 1,
      "totalCount": 2,
      "totalPages": 1
    }
  }
}

返回参数说明：

名称	类型	备注
dataResult	List< BpmAgentPo >	流程代理列表数据
pageResult	Object	分页数据

根据id获取对象信息

简述：

根据id获取对象信息

请求URL：

http://ip:port/ibps/business/v3/bpm/agent/get
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
id	String	是		主键id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/bpm/agent/get?id=626866373389189120

返回示例：

{
  "state": 200,
  "request": null,
  "message": "",
  "cause": "",
  "variables": {},
  "data": {
    "pk": "",
    "name": null,
    "ip": null,
    "createBy": "1",
    "createTime": "2019-09-26 19:43:10",
    "updateBy": null,
    "updateTime": null,
    "tenantId": null,
    "dataStatus": null,
    "dbtype": null,
    "id": "626866373389189120",
    "title": "产品代理",
    "delegatorId": "626796627947945984",
    "agenterId": "626796961529331712",
    "procDefKey": "",
    "isEnabled": "disabled",
    "effectiveTime": "2019-09-26",
    "expiryTime": "2019-12-25",
    "agentType": "part",
    "delegatorName": "产品主管",
    "agenterName": "产品助理",
    "procDefId": null,
    "procDefName": null,
    "delBeforeSave": true,
    "bpmAgentDefPoList": [
      {
        "pk": "",
        "name": null,
        "ip": null,
        "createBy": null,
        "createTime": null,
        "updateBy": null,
        "updateTime": null,
        "tenantId": null,
        "dataStatus": null,
        "dbtype": null,
        "id": "626866373615681536",
        "agentId": "626866373389189120",
        "procDefKey": "Process_1gx9hsq",
        "nodeId": "",
        "procDefName": "产品审批Bella",
        "nodeName": null
      }
    ],
    "bpmAgentConditionPoList": []
  }
}

返回参数说明：

名称	类型	备注
data	BpmAgentPo	流程代理对象

保存

简述：

保存流程代理

请求URL：

http://ip:port/ibps/business/v3/bpm/agent/save
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

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

Query：

暂无

Body：

名称	类型	是否必须	备注
id	String	否	主键id
title	String	是	标题
procDefId	String	否	流程定义id
procDefKey	String	否	流程定义key
delegatorId	String	是	委托人id
delegatorName	String	是	委托人名称
effectiveTime	String	是	生效时间
expiryTime	String	是	过期时间
agenterId	String	是	代理人id
agenterName	String	是	代理人名称
agentType	String	是	代理类型
isEnabled	String	是	是否可用
bpmAgentDefPoList	List< BpmAgentDefPo >	否	代理定义列表
bpmAgentConditionPoList	List< BpmAgentConditionPo >	否	代理条件列表

BpmAgentDefPo的属性如下：

名称	类型	是否必须	备注
id	String	否	主键id
procDefKey	String	是	流程定义标识
agentId	String	是	流程代理id
nodeId	String	否	节点Id

BpmAgentConditionPo的属性如下：

名称	类型	是否必须	备注
id	String	否	主键id
name	String	是	名称
agentId	String	是	流程代理id
agenterId	String	是	代理人id
desc	String	否	描述
condition	String	是	代理条件

请求参数示例：

{
    "title": "测试添加",
    "procDefId": "",
    "procDefKey": "",
    "delegatorId": "626353848415420416",
    "delegatorName": "zjh",
    "effectiveTime": "2019-12-11",
    "expiryTime": "2019-12-12",
    "agenterId": "626422189268140032",
    "agenterName": "姗姗",
    "agentType": "all",
    "isEnabled": "enabled",
    "bpmAgentDefPoList": [],
    "bpmAgentConditionPoList": []
}

返回示例：

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

返回参数说明：

名称	类型	备注
data	Void

删除

简述：

批量删除流程代理条件

请求URL：

http://ip:port/ibps/business/v3/bpm/agent/remove
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
ids	String	是		主键id

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/bpm/agent/remove?ids=654330650223968256

返回示例：

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

返回参数说明：

名称	类型	备注
data	Void

启动/禁用

简述：

设置流程代理启用/禁用

请求URL：

http://ip:port/ibps/business/v3/bpm/agent/setEnable
URL中的ip需要替换为自己网关ip
URL中的port需要替换为自己网关端口

请求方式：

POST

请求参数：

Headers：

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

Query：

名称	类型	是否必须	默认值	备注	其他信息
id	String	是		主键id	id
isEnabled	String	是		是否可用	enabled/disabled

Body：

暂无

请求参数示例：

http://192.168.3.230:15100/ibps/business/v3/bpm/agent/setEnable?id=652099858638831616&isEnabled=disabled

返回示例：

{
    "state": 200,
    "request": null,
    "message": "流程代理成功",
    "cause": "",
    "variables": {},
    "data": {}
}

返回参数说明：

名称	类型	备注
data	Void

备注

[1] : APIRequest为动态查询请求对象，详情请移步全局请求格式