Skip to content

代办设置

代办设置列表

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/person/page.wf

请求参数:

json
{
  "accessToken": "",
  "page": "1",
  "limit": "10",
  "sort": "flowName",
  "search": ""
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
page页码,如果为空表示查询全部数据
limit每页显示的数据条数,如果为空默认查询10条
sort非必须,字段前如果加上减号,如 sort=-flowName 则为按照 flowName 倒序排列
search简单查询流程名称和流程类型字段,默认为空时查询所有数据

返回结果示例:

json
{
  "code": 0,
  "data": [
    {
      "agentUserId": "HZ28821856ef63420156ef6342a20003",
      "agentUserName": "用户02",
      "beginDate": "2022-05-24 00:00:00",
      "endDate": "2022-05-31 23:59:59",
      "flowId": "test3",
      "flowName": "新流程test3",
      "id": "HZ28858f80b703d30180b7069c4c000b",
      "status": "是",
      "typeName": "www",
      "version": "2"
    },
    {
      "agentUserId": "",
      "agentUserName": "",
      "beginDate": "",
      "endDate": "",
      "flowId": "test2",
      "flowName": "新流程test2",
      "id": "",
      "status": "否",
      "typeName": "",
      "version": "1"
    }
  ],
  "message": "",
  "recordsTotal": "3",
  "success": true
}

结果参数说明:

参数类型描述
agentUserIdString代办人用户id
agentUserNameString代办人姓名
beginDateString开始时间,格式:yyyy-MM-dd HH:mm:ss
endDateString结束时间,格式:yyyy-MM-dd HH:mm:ss(注:结束日期大于或等于开始日期)
flowIdString流程模板id
flowNameString流程名字
idString代办表中的数据id
statusString是否已设置代办:是(已设置);否(没有设置,未设置时 id、beginDate、endDate、agentUserId、agentUserName 值为空)
typeNameString流程分类
versionString流程版本

代办设置操作

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/operate/action.wf

请求参数:

json
{
  "accessToken": "",
  "id": "test~新流程test",
  "agentId": "U_HZ28821856ef63420156ef6342a20002",
  "agentName": "用户01",
  "startDate": "2022-05-12",
  "endDate": "2022-05-31",
  "moveTodo": "1",
  "noticeType": "SMS"
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
id选中代办设置数据的标识,其值为 流程id~流程名称,如果选中多条数据进行代办设置,id 值用分号隔开
agentId代办人id
agentName代办人姓名
startDate开始日期,格式:yyyy-MM-dd
endDate结束日期,格式:yyyy-MM-dd
moveTodo是否转移已有待办:1(是);0(否),默认值为1
noticeTypeSMS(短信)、Msg(系统消息)、IM(即时消息)、Mail(邮件),默认为空,如果多选,中间用逗号隔开

返回结果示例:

json
{
  "success": true,
  "code": 0,
  "message": "设置代办成功"
}

取消设置操作

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/cancel/action.wf

请求参数:

json
{
  "accessToken": "",
  "id": "test~HZ28858f80b77e670180b793dad70010"
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
id取消代办设置业务,选中数据的标识,其值由 flowId~dataId 组成,如果选中多个数据进行取消代办设置业务,id 值用分号隔开

返回结果示例:

json
{
  "success": true,
  "code": 0,
  "message": "取消代办成功"
}

代办业务列表

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/page.wf

请求参数:

json
{
  "accessToken": "",
  "requestType": "",
  "page": "1",
  "limit": "10",
  "sort": "flowName",
  "search": ""
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
requestType业务名称:AgentTransfer 表示查询代办移交列表;AgentReceive 表示查询代办工作接收列表
page页码,如果为空表示查询全部数据
limit每页显示的数据条数,如果为空默认查询10条
sort非必须,字段前如果加上减号,如 sort=-flowName 则为按照 flowName 倒序排列
search简单查询,默认为空时查询所有数据

返回结果示例:

json
{
  "code": 0,
  "data": [
    {
      "flowId": "test",
      "flowName": "新流程test",
      "id": "HZ28858f80b77e670180b79a5c8c0023",
      "newName": "用户01",
      "newUser": "HZ28821856ef63420156ef6342a20002",
      "oldName": "",
      "oldUser": "",
      "startTime": "2022-05-12 14:21:25",
      "title": "新流程test"
    }
  ],
  "message": "",
  "recordsTotal": "3",
  "success": true
}

结果参数说明:

参数类型描述
flowIdString流程id
flowNameString流程名称
idString数据id
newNameString接收人姓名
newUserString接收人用户id
oldUserString移交人用户id
oldNameString移交人姓名
startTimeString开始时间
titleString查询结果标题

代办历史记录

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/history/page.wf

请求参数:

json
{
  "accessToken": "",
  "page": "1",
  "limit": "10",
  "sort": "flowName",
  "search": ""
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
page页码,如果为空表示查询全部数据
limit每页显示的数据条数,如果为空默认查询10条
sort排序,默认为正序,字段前如果加上减号,如 sort=-flowName 则为按照 flowName 倒序排列
search简单查询,默认为空时查询所有数据

返回结果示例:

json
{
  "code": 0,
  "data": [
    {
      "agentUserId": "HZ28821856ef63420156ef6342a20003",
      "agentUserName": "用户02",
      "beginDate": "2022-05-24 00:00:00",
      "endDate": "2022-05-31 23:59:59",
      "flowId": "test3",
      "flowName": "新流程test3",
      "id": "HZ28858f80b703d30180b7069c4c000b",
      "status": "失效"
    }
  ],
  "message": "",
  "recordsTotal": "9",
  "success": true
}

结果参数说明:

参数类型描述
agentUserIdString代办人id
agentUserNameString代办人姓名
beginDateString代办开始时间
endDateString代办结束时间
flowIdString流程id
flowNameString流程名称
idString数据id
statusString限定值:失效、有效、未开始

代办历史详情

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/dealinfo.wf

请求参数:

json
{
  "accessToken": "",
  "page": "1",
  "limit": "10",
  "sort": "flowName",
  "dataId": "HZ28811c72024d8d0172024da7b60007"
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
dataId代办数据id
page页码,如果为空表示查询全部数据
limit每页显示的数据条数,如果为空默认查询10条
sort排序,默认为正序,字段前如果加上减号,如 sort=-flowName 则为按照 flowName 倒序排列
search简单查询,默认为空时查询所有数据

返回结果示例:

json
{
  "code": 0,
  "data": [
    {
      "beginDate": "2022-05-18 00:00:00",
      "endDate": "2022-05-31 23:59:59",
      "flowId": "test",
      "flowName": "新流程test",
      "saveTime": "2022-05-18 11:18:27",
      "title": "新流程test"
    }
  ],
  "message": "",
  "recordsTotal": "1",
  "success": true
}

结果参数说明:

参数类型描述
beginDateString代办开始时间
endDateString代办结束时间
flowIdString流程id
flowNameString流程名称
saveTimeString发送时间,格式:yyyy-MM-dd HH:mm:ss
titleString流程标题

代办工作接收操作

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/handwork/receivework.wf

请求参数:

json
{
  "accessToken": "",
  "dataId": "HZ28811c72024d8d0172024da7b60007"
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
dataId代办数据id,多个id中间用分号隔开

返回结果示例:

json
{
  "success": true,
  "code": 0,
  "message": "",
  "recordsTotal": "2",
  "data": {
    "HZ2882c0550fa85001550fac06cd00b4": "false",
    "HZ2882c0550fa85001550fac06d100b6": "true"
  }
}

结果参数说明:

参数类型描述
dataMapkey 值为 dataId 接收数据id;value 是否接收成功,false 表示此流程接收失败,true 表示此流程接收成功

代办管理列表

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/manage/page.wf

请求参数:

json
{
  "accessToken": "",
  "page": "1",
  "limit": "10",
  "sort": "flowName",
  "search": ""
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
page页码,如果为空表示查询全部数据
limit每页显示的数据条数,如果为空默认查询10条
sort排序,默认为正序,字段前如果加上减号,如 sort=-flowName 则为按照 flowName 倒序排列
search简单查询流程名称、代办人姓名、被代办人姓名字段,默认为空时查询所有数据

返回结果示例:

json
{
  "code": 0,
  "data": [
    {
      "agentUserId": "HZ28821856ef63420156ef6342a20002",
      "agentUserName": "用户01",
      "beginDate": "2022-05-13 00:00:00",
      "endDate": "2022-05-31 23:59:59",
      "flowId": "test",
      "flowName": "新流程test",
      "id": "HZ28858f80bb94640180bb974fef001c",
      "status": "是",
      "typeName": "",
      "userId": "admin",
      "userName": "管理员"
    },
    {
      "agentUserId": "",
      "agentUserName": "",
      "beginDate": "",
      "endDate": "",
      "flowId": "test2",
      "flowName": "新流程test2",
      "id": "",
      "status": "否",
      "typeName": "",
      "userId": "",
      "userName": ""
    }
  ],
  "message": "",
  "recordsTotal": "3",
  "success": true
}

结果参数说明:

参数类型描述
agentUserIdString代办人用户id
agentUserNameString代办人姓名
beginDateString开始时间,格式:yyyy-MM-dd HH:mm:ss
endDateString结束时间,格式:yyyy-MM-dd HH:mm:ss
flowIdString流程id
flowNameString流程名称
idString流程设置代办后才此数据id
statusString是否已设置代办:是(已设置);否(没有设置,未设置时 id、beginDate、endDate、agentUserId、agentUserName 值为空)
typeNameString流程分类
userIdString被代办人用户id
userNameString被代办人姓名

代办管理设置操作

接口请求调用说明

  • HTTP 请求方式:POST
  • 请求地址:http://127.0.0.1:8080/demo/horizon/workflow/rest/agent/manage/action.wf

请求参数:

json
{
  "accessToken": "",
  "id": "test2~新流程test2",
  "agentId": "U_HZ28821856ef63420156ef6342a20002",
  "agentName": "用户01",
  "userId": "U_HZ28821856ef63420156ef6342a20003",
  "userName": "用户02",
  "startDate": "2022-05-13",
  "endDate": "2022-05-31",
  "moveTodo": "1",
  "noticeType": "SMS"
}
参数是否必须描述
accessToken调用接口凭证,唯一用户标识
id选中代办设置数据的标识,其值为 流程id~流程名称,如果选中多条数据进行代办设置,id 值用分号隔开
agentId代办人id
agentName代办人姓名
userId被代办人id
userName被代办人姓名
startDate开始日期,格式:yyyy-MM-dd
endDate结束日期,格式:yyyy-MM-dd
moveTodo是否转移已有待办:1(是);0(否),默认值为1
noticeTypeSMS(短信)、Msg(系统消息)、IM(即时消息)、Mail(邮件),默认为空,如果多选,中间用逗号隔开

返回结果示例:

json
{
  "success": true,
  "code": 0,
  "message": "设置代办成功"
}