事项管理后端接口文档 - itemAdmin

Version	Update Time	Status	Author	Description
1.0	2021/5/10	创建	mengjuhua,zhaobo	创建后端接口文档
2.0	2022/4/10	更新	qinman,shidaobang,dingzhaojun	更新后端接口文档

流转信息接口

根据流程实例 id 标记流程为办结状态

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/endByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id标记流程为办结状态

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/endByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程编号标记流程为办结状态

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/endByProcessSerialNumber

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号标记流程为办结状态

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/endByProcessSerialNumber

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例和办件状态查找正在办理的流转详细信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessInstanceIdAndStatus

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例和办件状态查找正在办理的流转详细信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
status	int32	false	0为待办，1位在办	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessInstanceIdAndStatus?status=0&tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "taskId": "",
      "processDefinitionKey": "",
      "startTime": "",
      "systemName": "",
      "status": 0,
      "assignee": "",
      "deptId": "",
      "deptName": "",
      "bureauId": "",
      "bureauName": "",
      "assigneeName": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "lastTime": "yyyy-MM-dd HH:mm:ss",
      "started": true,
      "ended": true,
      "deleted": true,
      "placeOnFile": true
    }
  ]
}

根据流程编号查找正在办理的流转详细信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号查找正在办理的流转详细信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "taskId": "",
      "processDefinitionKey": "",
      "startTime": "",
      "systemName": "",
      "status": 0,
      "assignee": "",
      "deptId": "",
      "deptName": "",
      "bureauId": "",
      "bureauName": "",
      "assigneeName": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "lastTime": "yyyy-MM-dd HH:mm:ss",
      "started": true,
      "ended": true,
      "deleted": true,
      "placeOnFile": true
    }
  ]
}

根据流程编号和办理人id查找办理的流转信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumberAndAssignee

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号和办理人id查找办理的流转信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
assignee	string	true	办理人id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumberAndAssignee?tenantId=&processSerialNumber=&assignee=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "itemId": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "processDefinitionKey": "",
    "startTime": "",
    "systemName": "",
    "status": 0,
    "assignee": "",
    "deptId": "",
    "deptName": "",
    "bureauId": "",
    "bureauName": "",
    "assigneeName": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "lastTime": "yyyy-MM-dd HH:mm:ss",
    "started": true,
    "ended": true,
    "deleted": true,
    "placeOnFile": true
  }
}

根据流程编号查找正在办理的流转详细信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumberAndStatus

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号查找正在办理的流转详细信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
status	int32	true	0为待办，1位在办	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/findByProcessSerialNumberAndStatus?status=0&tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "taskId": "",
      "processDefinitionKey": "",
      "startTime": "",
      "systemName": "",
      "status": 0,
      "assignee": "",
      "deptId": "",
      "deptName": "",
      "bureauId": "",
      "bureauName": "",
      "assigneeName": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "lastTime": "yyyy-MM-dd HH:mm:ss",
      "started": true,
      "ended": true,
      "deleted": true,
      "placeOnFile": true
    }
  ]
}

恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/recoveryByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/recoveryByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id删除整个流程的办件详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id删除整个流程的办件详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程编号删除整个流程的办件详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessSerialNumber

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号删除整个流程的办件详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessSerialNumber

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除指定办理人的办件详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessSerialNumberAndAssignee

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除指定办理人的办件详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
assignee	string	true	办理人id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/removeByProcessSerialNumberAndAssignee

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存或者更新流转信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或者更新流转信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	唯一标示	-
└─itemId	string	false	事项Id	-
└─processSerialNumber	string	false	流程编号	-
└─processInstanceId	string	false	流程实例	-
└─taskId	string	false	任务Id	-
└─processDefinitionKey	string	false	所属事项绑定的流程定义	-
└─startTime	string	false	流程启动时间	-
└─systemName	string	false	所属事项的系统英文名称	-
└─status	int32	false	1是在办、0是待办	-
└─assignee	string	false	办理人Id	-
└─deptId	string	false	办理部门	-
└─deptName	string	false	办理部门名称	-
└─bureauId	string	false	办理部门所在委办局	-
└─bureauName	string	false	办理部门所在委办局	-
└─assigneeName	string	false	办理人姓名	-
└─createTime	string	false	生成的时间	-
└─lastTime	string	false	最后一次的办理时间	-
└─started	boolean	false	是否启动流程	-
└─ended	boolean	false	流程是否办结	-
└─deleted	boolean	false	是否删除	-
└─placeOnFile	boolean	false	是否归档	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/saveOrUpdate?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "itemId": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "processDefinitionKey": "",
    "startTime": "",
    "systemName": "",
    "status": 0,
    "assignee": "",
    "deptId": "",
    "deptName": "",
    "bureauId": "",
    "bureauName": "",
    "assigneeName": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "lastTime": "yyyy-MM-dd HH:mm:ss",
    "started": true,
    "ended": true,
    "deleted": true,
    "placeOnFile": true
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/syncByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/actRuDetail/syncByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

关联流程接口

关联流程数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/countAssociatedFile

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 关联流程数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/countAssociatedFile?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

批量删除关联流程

URL: https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/deleteAllAssociatedFile

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 批量删除关联流程

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
delIds	string	true	关联流程实例id(,隔开)	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/deleteAllAssociatedFile

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除关联流程

URL: https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/deleteAssociatedFile

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除关联流程

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
delId	string	true	关联流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/deleteAssociatedFile

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取关联流程列表（包括未办结件）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/getAssociatedFileAllList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取关联流程列表（包括未办结件）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/getAssociatedFileAllList?tenantId=&orgUnitId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─itemName	string	事项名称	-
└─itemId	string	事项id	-
└─documentTitle	string	标题	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─taskDefinitionKey	string	当前任务key	-
└─taskAssignee	string	当前任务办理人	-
└─creatUserName	string	流程创建人	-
└─level	string	紧急程度	-
└─number	string	文件编号	-
└─itembox	string	办件状态	-
└─startTimes	string	排序时间	-
└─taskId	string	任务id	-
└─taskAssigneeId	string	办理人id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemName": "",
      "itemId": "",
      "documentTitle": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "processDefinitionId": "",
      "processDefinitionKey": "",
      "startTime": "",
      "endTime": "",
      "taskDefinitionKey": "",
      "taskAssignee": "",
      "creatUserName": "",
      "level": "",
      "number": "",
      "itembox": "",
      "startTimes": "",
      "taskId": "",
      "taskAssigneeId": ""
    }
  ]
}

保存关联流程信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/saveAssociatedFile

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存关联流程信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processSerialNumber	string	true	流程编号	-
processInstanceIds	string	true	关联的流程实例ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/associatedFile/saveAssociatedFile

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

附件接口

根据流程编号删除附件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/delByProcessSerialNumbers

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程编号删除附件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/delByProcessSerialNumbers?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除附件（物理删除，包含具体文件）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/delFile

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除附件（物理删除，包含具体文件）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
ids	string	true	附件ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/delFile

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程编号获取附件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/fileCounts

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号获取附件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/fileCounts?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据附件id获取附件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据附件id获取附件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	附件id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/findById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─processSerialNumber	string	流程编号	-
└─name	string	文件名称	-
└─fileSource	string	附件来源	-
└─fileSize	string	文件字节数	-
└─fileType	string	文件字节数	-
└─fileStoreId	string	文件仓库Id	-
└─filePath	string	文件路径	-
└─downloadUrl	string	下载url	-
└─uploadTime	string	上传时间	-
└─personName	string	上传人	-
└─personId	string	上传人员Id	-
└─positionId	string	上传岗位Id	-
└─positionName	string	上传岗位名称	-
└─deptId	string	上传人部门id	-
└─deptName	string	上传人部门名称	-
└─describes	string	文件描述	-
└─serialNumber	int32	序号	-
└─jodconverterURL	string	预览地址	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "processSerialNumber": "",
    "name": "",
    "fileSource": "",
    "fileSize": "",
    "fileType": "",
    "fileStoreId": "",
    "filePath": "",
    "downloadUrl": "",
    "uploadTime": "",
    "personName": "",
    "personId": "",
    "positionId": "",
    "positionName": "",
    "deptId": "",
    "deptName": "",
    "describes": "",
    "serialNumber": 0,
    "jodconverterURL": ""
  }
}

根据流程编号、附件来源、文件类型获取附件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号、附件来源、文件类型获取附件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
fileSource	string	false	附件来源	-
fileType	string	false	文件类型	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentCount?tenantId=&processSerialNumber=&fileSource=&fileType=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取附件分页列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取附件分页列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
fileSource	string	false	附件来源	-
page	int32	true	页码	-
rows	int32	true	行数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentList?page=0&rows=0&tenantId=&processSerialNumber=&fileSource=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─processSerialNumber	string	流程编号	-
└─name	string	文件名称	-
└─fileSource	string	附件来源	-
└─fileSize	string	文件字节数	-
└─fileType	string	文件字节数	-
└─fileStoreId	string	文件仓库Id	-
└─filePath	string	文件路径	-
└─downloadUrl	string	下载url	-
└─uploadTime	string	上传时间	-
└─personName	string	上传人	-
└─personId	string	上传人员Id	-
└─positionId	string	上传岗位Id	-
└─positionName	string	上传岗位名称	-
└─deptId	string	上传人部门id	-
└─deptName	string	上传人部门名称	-
└─describes	string	文件描述	-
└─serialNumber	int32	序号	-
└─jodconverterURL	string	预览地址	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "processInstanceId": "",
        "taskId": "",
        "processSerialNumber": "",
        "name": "",
        "fileSource": "",
        "fileSize": "",
        "fileType": "",
        "fileStoreId": "",
        "filePath": "",
        "downloadUrl": "",
        "uploadTime": "",
        "personName": "",
        "personId": "",
        "positionId": "",
        "positionName": "",
        "deptId": "",
        "deptName": "",
        "describes": "",
        "serialNumber": 0,
        "jodconverterURL": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取附件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentModelList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取附件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
fileSource	string	false	附件来源	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getAttachmentModelList?tenantId=&processSerialNumber=&fileSource=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─processSerialNumber	string	流程编号	-
└─name	string	文件名称	-
└─fileSource	string	附件来源	-
└─fileSize	string	文件字节数	-
└─fileType	string	文件字节数	-
└─fileStoreId	string	文件仓库Id	-
└─filePath	string	文件路径	-
└─downloadUrl	string	下载url	-
└─uploadTime	string	上传时间	-
└─personName	string	上传人	-
└─personId	string	上传人员Id	-
└─positionId	string	上传岗位Id	-
└─positionName	string	上传岗位名称	-
└─deptId	string	上传人部门id	-
└─deptName	string	上传人部门名称	-
└─describes	string	文件描述	-
└─serialNumber	int32	序号	-
└─jodconverterURL	string	预览地址	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "processInstanceId": "",
      "taskId": "",
      "processSerialNumber": "",
      "name": "",
      "fileSource": "",
      "fileSize": "",
      "fileType": "",
      "fileStoreId": "",
      "filePath": "",
      "downloadUrl": "",
      "uploadTime": "",
      "personName": "",
      "personId": "",
      "positionId": "",
      "positionName": "",
      "deptId": "",
      "deptName": "",
      "describes": "",
      "serialNumber": 0,
      "jodconverterURL": ""
    }
  ]
}

获取附件文件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getFile

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取附件文件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
fileId	string	true	附件id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/getFile?tenantId=&fileId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─processSerialNumber	string	流程编号	-
└─name	string	文件名称	-
└─fileSource	string	附件来源	-
└─fileSize	string	文件字节数	-
└─fileType	string	文件字节数	-
└─fileStoreId	string	文件仓库Id	-
└─filePath	string	文件路径	-
└─downloadUrl	string	下载url	-
└─uploadTime	string	上传时间	-
└─personName	string	上传人	-
└─personId	string	上传人员Id	-
└─positionId	string	上传岗位Id	-
└─positionName	string	上传岗位名称	-
└─deptId	string	上传人部门id	-
└─deptName	string	上传人部门名称	-
└─describes	string	文件描述	-
└─serialNumber	int32	序号	-
└─jodconverterURL	string	预览地址	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "processSerialNumber": "",
    "name": "",
    "fileSource": "",
    "fileSize": "",
    "fileType": "",
    "fileStoreId": "",
    "filePath": "",
    "downloadUrl": "",
    "uploadTime": "",
    "personName": "",
    "personId": "",
    "positionId": "",
    "positionName": "",
    "deptId": "",
    "deptName": "",
    "describes": "",
    "serialNumber": 0,
    "jodconverterURL": ""
  }
}

保存附件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/saveAttachment

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存附件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
attachjson	string	true	附件信息	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/saveAttachment

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存或更新附件上传信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/saveOrUpdateUploadInfo

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存或更新附件上传信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
fileName	string	true	文件名称	-
fileType	string	false	文件类型	-
fileSizeString	string	false	文件大小	-
fileSource	string	false	附件来源	-
processInstanceId	string	false	流程实例id	-
processSerialNumber	string	false	流程编号	-
taskId	string	false	任务id	-
y9FileStoreId	string	true	附件上传id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/saveOrUpdateUploadInfo

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

更新附件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/updateFile

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新附件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
fileId	string	true	文件id	-
fileSize	string	false	文件大小	-
taskId	string	false	任务id	-
y9FileStoreId	string	true	附件上传id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/updateFile

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

上传附件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/upload

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 上传附件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
fileName	string	true	文件名	-
fileSize	string	false	文件大小	-
processInstanceId	string	false	流程实例id	-
taskId	string	false	任务id	-
describes	string	false	描述	-
processSerialNumber	string	false	流程编号	-
fileSource	string	false	附件来源	-
y9FileStoreId	string	true	附件上传id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/upload

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

更新附件信息(model)

URL: https://demo.youshengyun.com/itemAdmin/services/rest/attachment/uploadModel

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 更新附件信息(model)

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─processInstanceId	string	false	流程实例id	-
└─taskId	string	false	任务id	-
└─processSerialNumber	string	false	流程编号	-
└─name	string	false	文件名称	-
└─fileSource	string	false	附件来源	-
└─fileSize	string	false	文件字节数	-
└─fileType	string	false	文件字节数	-
└─fileStoreId	string	false	文件仓库Id	-
└─filePath	string	false	文件路径	-
└─downloadUrl	string	false	下载url	-
└─uploadTime	string	false	上传时间	-
└─personName	string	false	上传人	-
└─personId	string	false	上传人员Id	-
└─positionId	string	false	上传岗位Id	-
└─positionName	string	false	上传岗位名称	-
└─deptId	string	false	上传人部门id	-
└─deptName	string	false	上传人部门名称	-
└─describes	string	false	文件描述	-
└─serialNumber	int32	false	序号	-
└─jodconverterURL	string	false	预览地址	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/attachment/uploadModel?tenantId=&orgUnitId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "processSerialNumber": "",
    "name": "",
    "fileSource": "",
    "fileSize": "",
    "fileType": "",
    "fileStoreId": "",
    "filePath": "",
    "downloadUrl": "",
    "uploadTime": "",
    "personName": "",
    "personId": "",
    "positionId": "",
    "positionName": "",
    "deptId": "",
    "deptName": "",
    "describes": "",
    "serialNumber": 0,
    "jodconverterURL": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

书签绑定接口

根据模板id和流程编号查询模板的书签对应的值

URL: https://demo.youshengyun.com/itemAdmin/services/rest/bookMarkBind/getBookMarkData

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据模板id和流程编号查询模板的书签对应的值

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
wordTemplateId	string	true	模板id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/bookMarkBind/getBookMarkData?tenantId=&wordTemplateId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

按钮操作接口

加签

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/addMultiInstanceExecution

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加签

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
activityId	string	true	活动Id	-
parentExecutionId	string	true	父执行实例id	-
taskId	string	true	任务id	-
elementUser	string	true	选择人id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/addMultiInstanceExecution

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

减签

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/deleteMultiInstanceExecution

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 减签

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
executionId	string	true	执行实例id	-
taskId	string	true	任务id	-
elementUser	string	true	选择人id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/deleteMultiInstanceExecution

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

直接发送至流程启动人

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/directSend

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 直接发送至流程启动人

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
routeToTask	string	true	任务key	-
processInstanceId	string	true	流程实例ID	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/directSend

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

最后一人拒签退回

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/refuseClaimRollback

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 最后一人拒签退回

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/refuseClaimRollback

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

重定位

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/reposition

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 重定位

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
repositionToTaskId	string	true	重定位任务key	-
userChoice	array	true	选择人id,[array of string]	-
reason	string	false	原因	-
sponsorGuid	string	false	主办人id	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/reposition --data 'tenantId=&orgUnitId=&taskId=&repositionToTaskId=&userChoice=&sponsorGuid=&reason='

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

退回操作

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollBack

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 退回操作

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
reason	string	false	原因	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollBack

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

发回给上一步的发送人

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollbackToSender

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 发回给上一步的发送人

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollbackToSender

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

退回操作，直接退回到办件登记人

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollbackToStartor

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 退回操作，直接退回到办件登记人

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
reason	string	false	原因	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/rollbackToStartor

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

特殊办结

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/specialComplete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 特殊办结

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
reason	string	false	原因	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/specialComplete

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

收回操作

URL: https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/takeback

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 收回操作

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-
reason	string	false	原因	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/buttonOperation/takeback

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

日历配置接口

获取指定年节假日配置信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/calendarConfig/findByYear

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取指定年节假日配置信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
year	string	true	年份	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/calendarConfig/findByYear?tenantId=&year=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─workingDay2Holiday	string	工作日休假日期	-
└─weekend2WorkingDay	string	周末补班日期	-
└─everyYearHoliday	string	全年节假日期，包括工作日休假，排除周末补班日期，存储多年的节假日	-
└─year	string	年份	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "workingDay2Holiday": "",
    "weekend2WorkingDay": "",
    "everyYearHoliday": "",
    "year": ""
  }
}

抄送件接口

改变抄送件意见状态

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeChaoSongState

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 改变抄送件意见状态

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	抄送件id	-
type	string	false	状态类型	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeChaoSongState

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

批量设置抄送件状态为已阅

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeStatus

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 批量设置抄送件状态为已阅

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─ -	array[string]	false	array of string	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeStatus?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据抄送ID修改状态为已阅

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeStatus2read

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据抄送ID修改状态为已阅

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
chaoSongId	string	true	抄送id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/changeStatus2read

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id统计除当前人外的抄送件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/countByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id统计除当前人外的抄送件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/countByProcessInstanceId?tenantId=&orgUnitId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程实例id统计当前人抄送件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/countByUserIdAndProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id统计当前人抄送件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/countByUserIdAndProcessInstanceId?tenantId=&orgUnitId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

批量删除抄送件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/deleteByIds

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 批量删除抄送件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─ -	array[string]	true	array of string	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/deleteByIds --data 'tenantId=&ids='

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id删除抄送件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/deleteByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id删除抄送件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/deleteByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

抄送件详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/detail

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 抄送件详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
id	string	true	抄送id	-
processInstanceId	string	true	抄送的流程实例id	-
status	int32	true	传阅的状态,0未阅,1已阅,2新件	-
openNotRead	boolean	false	是否打开不已阅	-
mobile	boolean	true	是否为移动端	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/detail?status=0&openNotRead=true&mobile=true&tenantId=&orgUnitId=&id=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─processInstanceId	string	流程实例	-
└─taskDefKey	string	任务key	-
└─taskId	string	任务Id	-
└─currentUser	string	当前岗位名称	-
└─activitiUser	string	当前人员id	-
└─itembox	string	状态	-
└─formId	string	手机端表单id	-
└─formName	string	手机端表单名称	-
└─formJson	string	手机端表单json数据	-
└─formList	array	表单列表	-
└─mapKey	string	A map key.	-
└─formIds	string	表单ids	-
└─formNames	string	表单names	-
└─showOtherFlag	string	附件，正文，沟通交流页签显示	-
└─printFormId	string	打印表单id	-
└─printFormType	string	打印表单类型	-
└─repositionMap	array	重定位选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─taskDefNameJson	string	重定位选项json数据	-
└─sendMap	array	发送按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─sendName	string	发送按钮选项名称	-
└─sendKey	string	发送按钮选项key	-
└─menuMap	array	菜单按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─menuName	string	菜单按钮选项名称	-
└─menuKey	string	菜单按钮选项key	-
└─sponsorHandle	string	是否主办办理	-
└─lastPerson4RefuseClaim	boolean	拒签时是否是最后一个人员	-
└─multiInstance	string	任务节点类型	-
└─nextNode	boolean	是否需要发送下一个节点	-
└─meeting	boolean	是否上会	-
└─startTaskDefKey	string	启动节点key	-
└─title	string	标题	-
└─startor	string	启动人id	-
└─id	string	抄送件id	-
└─status	int32	抄送件状态	-
└─customItem	boolean	是否自定义事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "itemId": "",
    "processSerialNumber": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processInstanceId": "",
    "taskDefKey": "",
    "taskId": "",
    "currentUser": "",
    "activitiUser": "",
    "itembox": "",
    "formId": "",
    "formName": "",
    "formJson": "",
    "formList": [
      {}
    ],
    "formIds": "",
    "formNames": "",
    "showOtherFlag": "",
    "printFormId": "",
    "printFormType": "",
    "repositionMap": [
      {}
    ],
    "taskDefNameJson": "",
    "sendMap": [
      {}
    ],
    "sendName": "",
    "sendKey": "",
    "menuMap": [
      {}
    ],
    "menuName": "",
    "menuKey": "",
    "sponsorHandle": "",
    "lastPerson4RefuseClaim": true,
    "multiInstance": "",
    "nextNode": true,
    "meeting": true,
    "startTaskDefKey": "",
    "title": "",
    "startor": "",
    "id": "",
    "status": 0,
    "customItem": true
  }
}

获取批阅件数量（签写过意见的阅件）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDone4OpinionCountByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取批阅件数量（签写过意见的阅件）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDone4OpinionCountByUserId?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取未阅件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDoneCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取未阅件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDoneCount?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取已阅件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDoneList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取已阅件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
documentTitle	string	false	标题	-
rows	int32	true	条数	-
page	int32	true	页码	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getDoneList?rows=0&page=0&tenantId=&orgUnitId=&documentTitle=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程实例id获取除当前人外的其他抄送件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getListByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取除当前人外的其他抄送件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-
userName	string	false	收件人	-
rows	int32	true	条数	-
page	int32	true	页码	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getListByProcessInstanceId?rows=0&page=0&tenantId=&orgUnitId=&processInstanceId=&userName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据流程实例id获取当前人的抄送件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getListBySenderIdAndProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取当前人的抄送件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
senderId	string	true	用户id	-
processInstanceId	string	true	流程实例id	-
userName	string	false	收件人	-
rows	int32	true	条数	-
page	int32	true	页码	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getListBySenderIdAndProcessInstanceId?rows=0&page=0&tenantId=&senderId=&processInstanceId=&userName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取批阅件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getOpinionChaosongByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取批阅件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
documentTitle	string	false	标题	-
rows	int32	true	条数	-
page	int32	true	页码	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getOpinionChaosongByUserId?rows=0&page=0&tenantId=&orgUnitId=&documentTitle=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据岗位id获取已阅件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getTodoCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据岗位id获取已阅件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getTodoCount?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取未阅件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getTodoList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取未阅件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
documentTitle	string	false	标题	-
rows	int32	true	条数	-
page	int32	true	页码	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/getTodoList?rows=0&page=0&tenantId=&orgUnitId=&documentTitle=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取我的抄送列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/myChaoSongList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取我的抄送列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
searchName	string	false	搜索词	-
itemId	string	false	事项id	-
userName	string	false	接收人名称	-
state	string	false	状态	-
year	string	false	年度	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/myChaoSongList?page=0&rows=0&tenantId=&orgUnitId=&searchName=&itemId=&state=&userName=&year=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

抄送保存

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/save

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 抄送保存

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	抄送的流程实例id	-
users	string	true	抄送目标orgUnitIds	-
isSendSms	string	false	是否短信提醒	-
isShuMing	string	false	是否署名	-
smsContent	string	false	短信内容	-
smsPersonId	string	false	短信提醒人id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/save

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

个人阅件综合搜索列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/searchAllByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 个人阅件综合搜索列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
searchName	string	false	搜索词	-
itemId	string	false	事项id	-
userName	string	false	发送人	-
state	string	false	状态	-
year	string	false	年份	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/searchAllByUserId?page=0&rows=0&tenantId=&orgUnitId=&itemId=&userName=&year=&searchName=&state=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取监控阅件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/searchAllList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取监控阅件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
searchName	string	false	搜索词	-
itemId	string	false	事项id	-
senderName	string	false	发送人	-
userName	string	false	接收人	-
state	string	false	状态	-
year	string	false	年份	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/searchAllList?page=0&rows=0&tenantId=&itemId=&senderName=&state=&userName=&year=&searchName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─title	string	抄送的标题	-
└─processInstanceId	string	抄送的流程实例	-
└─processDefinitionId	string	流程定义id	-
└─processSerialNumber	string	流程编号	-
└─userName	string	抄送目标人员名称	-
└─userId	string	抄送目标人员Id	-
└─userDeptName	string	抄送目标人员部门名称	-
└─userDeptId	string	抄送目标人员部门Id	-
└─senderName	string	操作人的名称	-
└─senderId	string	操作人的Id	-
└─sendDeptName	string	操作人员部门名称	-
└─sendDeptId	string	操作人员部门Id	-
└─status	int32	传阅的状态,0未阅,1已阅,2新件	-
└─createTime	string	抄送时间	-
└─readTime	string	抄送时间	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─number	string	文件编号	-
└─level	string	紧急程度	-
└─systemName	string	系统名称	-
└─banjie	boolean	是否结束	-
└─follow	boolean	是否关注	-
└─serialNumber	int32	序号	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "title": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processSerialNumber": "",
        "userName": "",
        "userId": "",
        "userDeptName": "",
        "userDeptId": "",
        "senderName": "",
        "senderId": "",
        "sendDeptName": "",
        "sendDeptId": "",
        "status": 0,
        "createTime": "",
        "readTime": "",
        "itemId": "",
        "itemName": "",
        "number": "",
        "level": "",
        "systemName": "",
        "banjie": true,
        "follow": true,
        "serialNumber": 0
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

更新抄送件标题

URL: https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/updateTitle

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新抄送件标题

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
documentTitle	string	true	标题	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/chaoSong/updateTitle

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

常用语接口

删除常用语

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/delete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除常用语

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	常用语id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/delete

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取常用语列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/listSentencesService

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取常用语列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/listSentencesService?tenantId=&userId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─userId	string	人员guid"	-
└─content	string	常用语内容	-
└─tabIndex	int32	排序号	-
└─useNumber	int32	使用次数，点击次数	-
└─tenantId	string	租户Id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "userId": "",
      "content": "",
      "tabIndex": 0,
      "useNumber": 0,
      "tenantId": ""
    }
  ]
}

根据排序号tabIndex删除常用语

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/removeCommonSentences

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据排序号tabIndex删除常用语

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
tabIndex	int32	true	排序号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/removeCommonSentences

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

清空常用语使用次数

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/removeUseNumber

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 清空常用语使用次数

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/removeUseNumber

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据id保存更新常用语

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/save

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id保存更新常用语

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
id	string	true	常用语的唯一标识	-
content	string	true	内容	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/save

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据排序号tabIndex保存更新常用语

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/saveCommonSentences

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据排序号tabIndex保存更新常用语

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
content	string	true	常用语内容	-
tabIndex	int32	true	排序号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/saveCommonSentences

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

更新常用语使用次数

URL: https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/updateUseNumber

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新常用语使用次数

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	常用语id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/commonSentences/updateUseNumber

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

定制流程接口

获取当前运行任务的下一个节点

URL: https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/getCurrentTaskNextNode

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前运行任务的下一个节点

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/getCurrentTaskNextNode?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─taskKey	string	任务key	-
└─taskName	string	任务名称	-
└─taskType	string	任务类型	-
└─currentTask	boolean	当前运行节点	-
└─itemId	string	事项id	-
└─processSerialNumber	string	流程编号	-
└─orgId	string	办理人id	-
└─tabIndex	int32	排序号	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "taskKey": "",
    "taskName": "",
    "taskType": "",
    "currentTask": true,
    "itemId": "",
    "processSerialNumber": "",
    "orgId": "",
    "tabIndex": 0
  }
}

保存流程定制信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存流程定制信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─mapKey	object	false	A map key.	-
└─any object	object	false	any object.	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/saveOrUpdate?tenantId=&itemId=&processSerialNumber= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "mapKey": {
        "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
      }
    }
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

更新当前运行节点

URL: https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/updateCurrentTask

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新当前运行节点

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/customProcessInfo/updateCurrentTask

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

数据中心接口

保存办结数据到数据中心

URL: https://demo.youshengyun.com/itemAdmin/services/rest/dataCenter/saveToDateCenter

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存办结数据到数据中心

Query-parameters:

Parameter	Type	Required	Description	Since
processInstanceId	string	true	流程实例id	-
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/dataCenter/saveToDateCenter

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

办件操作接口

新建办件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/add

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 新建办件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
mobile	boolean	true	是否手机端	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/add?mobile=true&tenantId=&orgUnitId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─processInstanceId	string	流程实例	-
└─taskDefKey	string	任务key	-
└─taskId	string	任务Id	-
└─currentUser	string	当前岗位名称	-
└─activitiUser	string	当前人员id	-
└─itembox	string	状态	-
└─formId	string	手机端表单id	-
└─formName	string	手机端表单名称	-
└─formJson	string	手机端表单json数据	-
└─formList	array	表单列表	-
└─mapKey	string	A map key.	-
└─formIds	string	表单ids	-
└─formNames	string	表单names	-
└─showOtherFlag	string	附件，正文，沟通交流页签显示	-
└─printFormId	string	打印表单id	-
└─printFormType	string	打印表单类型	-
└─repositionMap	array	重定位选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─taskDefNameJson	string	重定位选项json数据	-
└─sendMap	array	发送按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─sendName	string	发送按钮选项名称	-
└─sendKey	string	发送按钮选项key	-
└─menuMap	array	菜单按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─menuName	string	菜单按钮选项名称	-
└─menuKey	string	菜单按钮选项key	-
└─sponsorHandle	string	是否主办办理	-
└─lastPerson4RefuseClaim	boolean	拒签时是否是最后一个人员	-
└─multiInstance	string	任务节点类型	-
└─nextNode	boolean	是否需要发送下一个节点	-
└─meeting	boolean	是否上会	-
└─startTaskDefKey	string	启动节点key	-
└─title	string	标题	-
└─startor	string	启动人id	-
└─id	string	抄送件id	-
└─status	int32	抄送件状态	-
└─customItem	boolean	是否自定义事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "itemId": "",
    "processSerialNumber": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processInstanceId": "",
    "taskDefKey": "",
    "taskId": "",
    "currentUser": "",
    "activitiUser": "",
    "itembox": "",
    "formId": "",
    "formName": "",
    "formJson": "",
    "formList": [
      {}
    ],
    "formIds": "",
    "formNames": "",
    "showOtherFlag": "",
    "printFormId": "",
    "printFormType": "",
    "repositionMap": [
      {}
    ],
    "taskDefNameJson": "",
    "sendMap": [
      {}
    ],
    "sendName": "",
    "sendKey": "",
    "menuMap": [
      {}
    ],
    "menuName": "",
    "menuKey": "",
    "sponsorHandle": "",
    "lastPerson4RefuseClaim": true,
    "multiInstance": "",
    "nextNode": true,
    "meeting": true,
    "startTaskDefKey": "",
    "title": "",
    "startor": "",
    "id": "",
    "status": 0,
    "customItem": true
  }
}

办件办结

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/complete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 办件办结

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/complete

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取发送选人信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/docUserChoise

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取发送选人信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processDefinitionKey	string	true	流程定义key	-
processDefinitionId	string	true	流程定义Id	-
taskId	string	false	任务id	-
routeToTask	string	true	任务key	-
processInstanceId	string	false	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/docUserChoise?tenantId=&userId=&orgUnitId=&itemId=&processDefinitionKey=&processDefinitionId=&routeToTask=&taskId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─existPosition	boolean	是否存在岗位	-
└─existDepartment	boolean	是否存在部门	-
└─existCustomGroup	boolean	是否存在用户组	-
└─multiInstance	string	任务节点类型	-
└─processDefinitionId	string	流程定义Id	-
└─tenantId	string	租户id	-
└─itemId	string	事项id	-
└─sponsorStatus	boolean	是否具有主协办状态	-
└─routeToTask	string	任务路由	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "existPosition": true,
    "existDepartment": true,
    "existCustomGroup": true,
    "multiInstance": "",
    "processDefinitionId": "",
    "tenantId": "",
    "itemId": "",
    "sponsorStatus": true,
    "routeToTask": ""
  }
}

编辑办件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/edit

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 编辑办件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itembox	string	true	办件状态，todo（待办），doing（在办），done（办结）	-
taskId	string	false	任务id	-
processInstanceId	string	true	流程实例id	-
itemId	string	true	事项id	-
mobile	boolean	true	是否手机端	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/edit?mobile=true&tenantId=&orgUnitId=&itembox=&taskId=&processInstanceId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─processInstanceId	string	流程实例	-
└─taskDefKey	string	任务key	-
└─taskId	string	任务Id	-
└─currentUser	string	当前岗位名称	-
└─activitiUser	string	当前人员id	-
└─itembox	string	状态	-
└─formId	string	手机端表单id	-
└─formName	string	手机端表单名称	-
└─formJson	string	手机端表单json数据	-
└─formList	array	表单列表	-
└─mapKey	string	A map key.	-
└─formIds	string	表单ids	-
└─formNames	string	表单names	-
└─showOtherFlag	string	附件，正文，沟通交流页签显示	-
└─printFormId	string	打印表单id	-
└─printFormType	string	打印表单类型	-
└─repositionMap	array	重定位选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─taskDefNameJson	string	重定位选项json数据	-
└─sendMap	array	发送按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─sendName	string	发送按钮选项名称	-
└─sendKey	string	发送按钮选项key	-
└─menuMap	array	菜单按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─menuName	string	菜单按钮选项名称	-
└─menuKey	string	菜单按钮选项key	-
└─sponsorHandle	string	是否主办办理	-
└─lastPerson4RefuseClaim	boolean	拒签时是否是最后一个人员	-
└─multiInstance	string	任务节点类型	-
└─nextNode	boolean	是否需要发送下一个节点	-
└─meeting	boolean	是否上会	-
└─startTaskDefKey	string	启动节点key	-
└─title	string	标题	-
└─startor	string	启动人id	-
└─id	string	抄送件id	-
└─status	int32	抄送件状态	-
└─customItem	boolean	是否自定义事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "itemId": "",
    "processSerialNumber": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processInstanceId": "",
    "taskDefKey": "",
    "taskId": "",
    "currentUser": "",
    "activitiUser": "",
    "itembox": "",
    "formId": "",
    "formName": "",
    "formJson": "",
    "formList": [
      {}
    ],
    "formIds": "",
    "formNames": "",
    "showOtherFlag": "",
    "printFormId": "",
    "printFormType": "",
    "repositionMap": [
      {}
    ],
    "taskDefNameJson": "",
    "sendMap": [
      {}
    ],
    "sendName": "",
    "sendKey": "",
    "menuMap": [
      {}
    ],
    "menuName": "",
    "menuKey": "",
    "sponsorHandle": "",
    "lastPerson4RefuseClaim": true,
    "multiInstance": "",
    "nextNode": true,
    "meeting": true,
    "startTaskDefKey": "",
    "title": "",
    "startor": "",
    "id": "",
    "status": 0,
    "customItem": true
  }
}

解析当前任务节点配置的用户数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/parserUser

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 解析当前任务节点配置的用户数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
routeToTaskId	string	true	任务key	-
taskDefName	string	false	任务名称	-
processInstanceId	string	false	流程实例id	-
multiInstance	string	false	是否多实例	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/parserUser?tenantId=&orgUnitId=&itemId=&processDefinitionId=&routeToTaskId=&taskDefName=&processInstanceId=&multiInstance=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}

带自定义变量发送

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndForwarding

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 带自定义变量发送

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位 id	-
processInstanceId	string	false	流程实例id	-
taskId	string	false	任务id	-
sponsorHandle	string	false	是否主办人办理	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
processDefinitionKey	string	true	流程定义key	-
userChoice	string	true	选择的发送人员	-
sponsorGuid	string	false	主办人id	-
routeToTaskId	string	true	任务key	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─mapKey	object	false	A map key.	-
└─any object	object	false	any object.	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndForwarding?tenantId=&orgUnitId=&itemId=&processSerialNumber=&processDefinitionKey=&userChoice=&routeToTaskId=&processInstanceId=&taskId=&sponsorGuid=&sponsorHandle= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

指定任务节点发送

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndForwardingByTaskKey

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 指定任务节点发送

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	false	流程实例id	-
taskId	string	false	任务id	-
sponsorHandle	string	false	是否主办人办理	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
processDefinitionKey	string	true	流程定义key	-
userChoice	string	true	选择的发送人员	-
sponsorGuid	string	false	主办人id	-
routeToTaskId	string	true	任务key	-
startRouteToTaskId	string	true	启动节点key	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─mapKey	object	false	A map key.	-
└─any object	object	false	any object.	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndForwardingByTaskKey?tenantId=&orgUnitId=&itemId=&processSerialNumber=&processDefinitionKey=&userChoice=&routeToTaskId=&startRouteToTaskId=&taskId=&sponsorHandle=&sponsorGuid=&processInstanceId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

提交并发送

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndSubmitTo

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 提交并发送

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位 id	-
taskId	string	false	任务id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/document/saveAndSubmitTo --data 'tenantId=&orgUnitId=&itemId=&processSerialNumber=&taskId='

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取签收任务配置

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/signTaskConfig

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取签收任务配置

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefinitionKey	string	true	任务key	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/signTaskConfig?tenantId=&orgUnitId=&itemId=&processDefinitionId=&taskDefinitionKey=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─signTask	boolean	是否签收任务	-
└─userChoice	string	发送候选人	-
└─onePerson	boolean	是否只有一个发送候选人	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "signTask": true,
    "userChoice": "",
    "onePerson": true
  }
}

启动流程

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/startProcess

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 启动流程

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
processDefinitionKey	string	true	流程定义key	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/startProcess

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─taskDefKey	string	任务key	-
└─processDefinitionId	string	流程定义id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "taskDefKey": "",
    "processDefinitionId": ""
  }
}

启动流程（多人）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/document/startProcess1

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 启动流程（多人）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
processDefinitionKey	string	true	流程定义key	-
userIds	string	true	人员、岗位ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/document/startProcess1

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─taskDefKey	string	任务key	-
└─processDefinitionId	string	流程定义id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "taskDefKey": "",
    "processDefinitionId": ""
  }
}

WPS正文接口

根据id查询WPS正文

URL: https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id查询WPS正文

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/findById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileId	string	文件Id	-
└─volumeId	string	卷Id	-
└─tenantId	string	租户Id	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─userId	string	上传人员id	-
└─istaohong	string	是否套红、1为套红word，0为word	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─hasContent	string	是否有内容，1为是，0为否	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileId": "",
    "volumeId": "",
    "tenantId": "",
    "fileType": "",
    "fileName": "",
    "userId": "",
    "istaohong": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "hasContent": ""
  }
}

根据流程编号查询WPS正文

URL: https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/findByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号查询WPS正文

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/findByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileId	string	文件Id	-
└─volumeId	string	卷Id	-
└─tenantId	string	租户Id	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─userId	string	上传人员id	-
└─istaohong	string	是否套红、1为套红word，0为word	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─hasContent	string	是否有内容，1为是，0为否	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileId": "",
    "volumeId": "",
    "tenantId": "",
    "fileType": "",
    "fileName": "",
    "userId": "",
    "istaohong": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "hasContent": ""
  }
}

保存WPS正文

URL: https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/saveDocumentWps

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存WPS正文

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─fileId	string	false	文件Id	-
└─volumeId	string	false	卷Id	-
└─tenantId	string	false	租户Id	-
└─fileType	string	false	文件类型	-
└─fileName	string	false	包括文件名+后缀	-
└─userId	string	false	上传人员id	-
└─istaohong	string	false	是否套红、1为套红word，0为word	-
└─saveDate	string	false	保存时间	-
└─processSerialNumber	string	false	流程序号	-
└─processInstanceId	string	false	流程实例id	-
└─hasContent	string	false	是否有内容，1为是，0为否	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/saveDocumentWps?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileId": "",
    "volumeId": "",
    "tenantId": "",
    "fileType": "",
    "fileName": "",
    "userId": "",
    "istaohong": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "hasContent": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存WPS正文内容

URL: https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/saveWpsContent

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存WPS正文内容

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
hasContent	string	true	是否有内容	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/documentWps/saveWpsContent

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

草稿列表接口

根据系统名称和组织id获取草稿数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/countBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称和组织id获取草稿数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
systemName	string	true	系统id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/countBySystemName?tenantId=&orgUnitId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

彻底删除草稿

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/deleteDraft

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 彻底删除草稿

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
ids	string	true	草稿ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/deleteDraft

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据岗位id和事项id获取删除草稿数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDeleteDraftCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据岗位id和事项id获取删除草稿数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDeleteDraftCount?tenantId=&orgUnitId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程编号获取草稿详情信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号获取草稿详情信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	No comments found.	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─processInstanceId	string	实例id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号，草稿编号	-
└─docNumber	string	编号	-
└─title	string	文件标题	-
└─createrId	string	创建人Id	-
└─creater	string	创建人	-
└─urgency	string	紧急程度	-
└─draftTime	string	起草时间	-
└─serialNumber	int32	排序号	-
└─type	string	类型	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "itemId": "",
    "itemName": "",
    "processInstanceId": "",
    "processDefinitionKey": "",
    "processSerialNumber": "",
    "docNumber": "",
    "title": "",
    "createrId": "",
    "creater": "",
    "urgency": "",
    "draftTime": "yyyy-MM-dd HH:mm:ss",
    "serialNumber": 0,
    "type": ""
  }
}

根据岗位id和事项id获取草稿箱数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据岗位id和事项id获取草稿箱数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftCount?tenantId=&orgUnitId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取草稿箱列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取草稿箱列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
page	int32	true	页码	-
rows	int32	true	条数	-
title	string	false	标题	-
itemId	string	true	事项id	-
delFlag	boolean	false	是否删除	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftList?page=0&rows=0&delFlag=true&tenantId=&orgUnitId=&itemId=&title=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "mapKey": {
          "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
        }
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取系统名称对应的草稿箱列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取系统名称对应的草稿箱列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
page	int32	true	页码	-
rows	int32	true	条数	-
title	string	false	标题	-
systemName	string	true	系统名称	-
delFlag	boolean	true	是否删除	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/getDraftListBySystemName?page=0&rows=0&delFlag=true&tenantId=&orgUnitId=&systemName=&title=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	No comments found.	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─processInstanceId	string	实例id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号，草稿编号	-
└─docNumber	string	编号	-
└─title	string	文件标题	-
└─createrId	string	创建人Id	-
└─creater	string	创建人	-
└─urgency	string	紧急程度	-
└─draftTime	string	起草时间	-
└─serialNumber	int32	排序号	-
└─type	string	类型	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "itemName": "",
        "processInstanceId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "docNumber": "",
        "title": "",
        "createrId": "",
        "creater": "",
        "urgency": "",
        "draftTime": "yyyy-MM-dd HH:mm:ss",
        "serialNumber": 0,
        "type": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

编辑草稿

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/openDraft

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 编辑草稿

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
mobile	boolean	true	是否手机端	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/openDraft?mobile=true&tenantId=&orgUnitId=&itemId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─processInstanceId	string	流程实例	-
└─taskDefKey	string	任务key	-
└─taskId	string	任务Id	-
└─currentUser	string	当前岗位名称	-
└─activitiUser	string	当前人员id	-
└─itembox	string	状态	-
└─formId	string	手机端表单id	-
└─formName	string	手机端表单名称	-
└─formJson	string	手机端表单json数据	-
└─formList	array	表单列表	-
└─mapKey	string	A map key.	-
└─formIds	string	表单ids	-
└─formNames	string	表单names	-
└─showOtherFlag	string	附件，正文，沟通交流页签显示	-
└─printFormId	string	打印表单id	-
└─printFormType	string	打印表单类型	-
└─repositionMap	array	重定位选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─taskDefNameJson	string	重定位选项json数据	-
└─sendMap	array	发送按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─sendName	string	发送按钮选项名称	-
└─sendKey	string	发送按钮选项key	-
└─menuMap	array	菜单按钮选项	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-
└─menuName	string	菜单按钮选项名称	-
└─menuKey	string	菜单按钮选项key	-
└─sponsorHandle	string	是否主办办理	-
└─lastPerson4RefuseClaim	boolean	拒签时是否是最后一个人员	-
└─multiInstance	string	任务节点类型	-
└─nextNode	boolean	是否需要发送下一个节点	-
└─meeting	boolean	是否上会	-
└─startTaskDefKey	string	启动节点key	-
└─title	string	标题	-
└─startor	string	启动人id	-
└─id	string	抄送件id	-
└─status	int32	抄送件状态	-
└─customItem	boolean	是否自定义事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "itemId": "",
    "processSerialNumber": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processInstanceId": "",
    "taskDefKey": "",
    "taskId": "",
    "currentUser": "",
    "activitiUser": "",
    "itembox": "",
    "formId": "",
    "formName": "",
    "formJson": "",
    "formList": [
      {}
    ],
    "formIds": "",
    "formNames": "",
    "showOtherFlag": "",
    "printFormId": "",
    "printFormType": "",
    "repositionMap": [
      {}
    ],
    "taskDefNameJson": "",
    "sendMap": [
      {}
    ],
    "sendName": "",
    "sendKey": "",
    "menuMap": [
      {}
    ],
    "menuName": "",
    "menuKey": "",
    "sponsorHandle": "",
    "lastPerson4RefuseClaim": true,
    "multiInstance": "",
    "nextNode": true,
    "meeting": true,
    "startTaskDefKey": "",
    "title": "",
    "startor": "",
    "id": "",
    "status": 0,
    "customItem": true
  }
}

还原草稿

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/reduction

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 还原草稿

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
ids	string	true	草稿ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/reduction

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除草稿（标记删除）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/removeDraft

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除草稿（标记删除）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
ids	string	true	草稿ids	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/removeDraft

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存草稿

URL: https://demo.youshengyun.com/itemAdmin/services/rest/draft/saveDraft

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存草稿

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-
processDefinitionKey	string	true	流程定义key	-
number	string	false	编号	-
level	string	false	紧急程度	-
title	string	true	标题	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/draft/saveDraft

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

出差委托接口

删除委托

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrust/deleteEntrust

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除委托

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	委托id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/entrust/deleteEntrust

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取我委托的列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrust/getEntrustList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取我委托的列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/entrust/getEntrustList?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─ownerId	string	委托人Id	-
└─ownerName	string	委托人姓名	-
└─assigneeId	string	委托对象Id	-
└─assigneeName	string	委托对象姓名	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─used	int32	是否启用	-
└─startTime	string	委托开始时间	-
└─endTime	string	委托结束时间	-
└─creatTime	string	委托事项的生成时间	-
└─updateTime	string	委托事项编辑时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "ownerId": "",
      "ownerName": "",
      "assigneeId": "",
      "assigneeName": "",
      "itemId": "",
      "itemName": "",
      "used": 0,
      "startTime": "",
      "endTime": "",
      "creatTime": "",
      "updateTime": ""
    }
  ]
}

获取委托我的列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrust/getMyEntrustList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取委托我的列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/entrust/getMyEntrustList?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─ownerId	string	委托人Id	-
└─ownerName	string	委托人姓名	-
└─assigneeId	string	委托对象Id	-
└─assigneeName	string	委托对象姓名	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─used	int32	是否启用	-
└─startTime	string	委托开始时间	-
└─endTime	string	委托结束时间	-
└─creatTime	string	委托事项的生成时间	-
└─updateTime	string	委托事项编辑时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "ownerId": "",
      "ownerName": "",
      "assigneeId": "",
      "assigneeName": "",
      "itemId": "",
      "itemName": "",
      "used": 0,
      "startTime": "",
      "endTime": "",
      "creatTime": "",
      "updateTime": ""
    }
  ]
}

保存或更新委托

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrust/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或更新委托

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	唯一标示	-
└─ownerId	string	false	委托人Id	-
└─ownerName	string	false	委托人姓名	-
└─assigneeId	string	false	委托对象Id	-
└─assigneeName	string	false	委托对象姓名	-
└─itemId	string	false	事项Id	-
└─itemName	string	false	事项名称	-
└─used	int32	false	是否启用	-
└─startTime	string	false	委托开始时间	-
└─endTime	string	false	委托结束时间	-
└─creatTime	string	false	委托事项的生成时间	-
└─updateTime	string	false	委托事项编辑时间	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/entrust/saveOrUpdate?tenantId=&orgUnitId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "ownerId": "",
    "ownerName": "",
    "assigneeId": "",
    "assigneeName": "",
    "itemId": "",
    "itemName": "",
    "used": 0,
    "startTime": "",
    "endTime": "",
    "creatTime": "",
    "updateTime": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

出差委托历史接口

获取某个用户的某个事项委托历史对象集合

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrustHistory/findByOwnerIdAndItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取某个用户的某个事项委托历史对象集合

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
ownerId	string	true	委托人id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/entrustHistory/findByOwnerIdAndItemId?tenantId=&userId=&ownerId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─ownerId	string	委托人Id	-
└─ownerName	string	委托人姓名	-
└─assigneeId	string	委托对象Id	-
└─assigneeName	string	委托对象姓名	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─startTime	string	委托开始时间	-
└─endTime	string	委托结束时间	-
└─creatTime	string	委托事项的生成时间	-
└─updateTime	string	委托事项编辑时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "ownerId": "",
      "ownerName": "",
      "assigneeId": "",
      "assigneeName": "",
      "itemId": "",
      "itemName": "",
      "startTime": "",
      "endTime": "",
      "creatTime": "",
      "updateTime": ""
    }
  ]
}

获取某个用户的委托历史对象集合

URL: https://demo.youshengyun.com/itemAdmin/services/rest/entrustHistory/findOneByOwnerId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取某个用户的委托历史对象集合

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
ownerId	string	true	委托人id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/entrustHistory/findOneByOwnerId?tenantId=&userId=&ownerId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─ownerId	string	委托人Id	-
└─ownerName	string	委托人姓名	-
└─assigneeId	string	委托对象Id	-
└─assigneeName	string	委托对象姓名	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─startTime	string	委托开始时间	-
└─endTime	string	委托结束时间	-
└─creatTime	string	委托事项的生成时间	-
└─updateTime	string	委托事项编辑时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "ownerId": "",
      "ownerName": "",
      "assigneeId": "",
      "assigneeName": "",
      "itemId": "",
      "itemName": "",
      "startTime": "",
      "endTime": "",
      "creatTime": "",
      "updateTime": ""
    }
  ]
}

错误日志记录接口

保存错误日志

URL: https://demo.youshengyun.com/itemAdmin/services/rest/errorLog/saveErrorLog

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存错误日志

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─processInstanceId	string	false	流程实例	-
└─taskId	string	false	任务id	-
└─errorType	string	false	错误类型	-
└─errorFlag	string	false	错误标识	-
└─extendField	string	false	扩展字段	-
└─text	string	false	错误日志信息	-
└─createTime	string	false	创建时间	-
└─updateTime	string	false	更新时间	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/errorLog/saveErrorLog?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "errorType": "",
    "errorFlag": "",
    "extendField": "",
    "text": "",
    "createTime": "",
    "updateTime": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

表单接口

删除子表数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/delChildTableRow

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除子表数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-
tableId	string	true	表id	-
guid	string	true	数据id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/delChildTableRow

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除前置表单数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/delPreFormData

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除前置表单数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-
guid	string	true	主键id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/delPreFormData

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取事项绑定的表单

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/findFormItemBind

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项绑定的表单

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefinitionKey	string	false	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/findFormItemBind?tenantId=&itemId=&processDefinitionId=&taskDefinitionKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─formId	string	表单id	-
└─formName	string	表单名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "formId": "",
      "formName": ""
    }
  ]
}

获取表单所有字段权限

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getAllFieldPerm

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取表单所有字段权限

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
formId	string	true	表单id	-
taskDefKey	string	true	任务key	-
processDefinitionId	string	true	流程定义id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getAllFieldPerm?tenantId=&userId=&formId=&taskDefKey=&processDefinitionId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─fieldName	string	字段名称	-
└─writePerm	boolean	写权限	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "fieldName": "",
      "writePerm": true
    }
  ]
}

根据事项id获取绑定前置表单

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getBindPreFormByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id获取绑定前置表单

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getBindPreFormByItemId?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─formId	string	表单id	-
└─formName	string	表单名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "formId": "",
    "formName": ""
  }
}

获取子表数据（一个表单为一个子表）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getChildFormData

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取子表数据（一个表单为一个子表）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员、岗位id	-
formId	string	true	表单id	-
parentProcessSerialNumber	string	true	父流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getChildFormData?tenantId=&userId=&formId=&parentProcessSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "mapKey": {
        "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
      }
    }
  ]
}

获取子表数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getChildTableData

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取子表数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-
tableId	string	true	表id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getChildTableData?tenantId=&formId=&tableId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "mapKey": {
        "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
      }
    }
  ]
}

根据事项id和流程编号获取数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getData

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id和流程编号获取数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getData?tenantId=&itemId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

获取字段权限

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFieldPerm

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取字段权限

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
formId	string	true	表单id	-
fieldName	string	true	字段名	-
taskDefKey	string	true	任务key	-
processDefinitionId	string	true	流程定义id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFieldPerm?tenantId=&userId=&formId=&fieldName=&taskDefKey=&processDefinitionId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─fieldName	string	字段名称	-
└─writePerm	boolean	写权限	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "fieldName": "",
    "writePerm": true
  }
}

根据表单id获取绑定字段信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormField

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据表单id获取绑定字段信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormField?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─formId	string	表单Id	-
└─tableId	string	对应的表id	-
└─tableName	string	对应的表名称	-
└─fieldName	string	字段名称	-
└─fieldCnName	string	字段中文名称	-
└─fieldType	string	字段类型	-
└─querySign	string	开启查询条件	-
└─queryType	string	查询类型	-
└─optionValue	string	多选框，单选框选项值	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "formId": "",
      "tableId": "",
      "tableName": "",
      "fieldName": "",
      "fieldCnName": "",
      "fieldType": "",
      "querySign": "",
      "queryType": "",
      "optionValue": ""
    }
  ]
}

根据表单id获取绑定字段信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormFieldDefine

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据表单id获取绑定字段信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormFieldDefine?tenantId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─formCtrltype	string	字段类型	-
└─disChinaName	string	字段中文名称	-
└─formCtrlName	string	字段名称	-
└─columnName	string	表列名	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "formCtrltype": "",
      "disChinaName": "",
      "formCtrlName": "",
      "columnName": ""
    }
  ]
}

获取表单json数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormJson

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取表单json数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFormJson?tenantId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据表单id获取表单数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFromData

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据表单id获取表单数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getFromData?tenantId=&formId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

根据表单id获取前置表单数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/getPreFormDataByFormId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据表单id获取前置表单数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/getPreFormDataByFormId?tenantId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "mapKey": {
        "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
      }
    }
  ]
}

保存子表数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveChildTableData

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存子表数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-
tableId	string	true	表id	-
processSerialNumber	string	true	流程编号	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveChildTableData?tenantId=&formId=&tableId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存子表数据，一个表单是一个子表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveChildTableData1

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存子表数据，一个表单是一个子表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveChildTableData1?tenantId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存表单数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveFormData

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存表单数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
formId	string	true	表单id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/saveFormData?tenantId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存前置表单数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/formData/savePreFormData

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存前置表单数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
formId	string	true	表单id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/formData/savePreFormData?tenantId=&itemId=&formId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

事项接口

根据系统名称获取事项列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/findAll

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称获取事项列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
systemName	string	true	系统名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/findAll?tenantId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─name	string	事项名称	-
└─type	string	事项类型	-
└─accountability	string	事项责任制	-
└─nature	string	事项管理员	-
└─sysLevel	string	系统级别	-
└─legalLimit	int32	法定期限	-
└─expired	int32	承诺时限	-
└─workflowGuid	string	工作流GUID	-
└─isOnline	string	是否网上申办，1“是”、0“否”	-
└─isDocking	string	是否对接，1“是”、0“否”	-
└─dockingSystem	string	对接外部系统标识	-
└─dockingItemId	string	对接事项id	-
└─systemName	string	系统名称	-
└─todoTaskUrlPrefix	string	待办任务链接前缀	-
└─iconData	string	图标内容	-
└─customItem	boolean	是否可定制事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "type": "",
      "accountability": "",
      "nature": "",
      "sysLevel": "",
      "legalLimit": 0,
      "expired": 0,
      "workflowGuid": "",
      "isOnline": "",
      "isDocking": "",
      "dockingSystem": "",
      "dockingItemId": "",
      "systemName": "",
      "todoTaskUrlPrefix": "",
      "iconData": "",
      "customItem": true
    }
  ]
}

根据流程的定义Key查找对应的事项信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/findByProcessDefinitionKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程的定义Key查找对应的事项信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
processDefinitionKey	string	true	流程定义Key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/findByProcessDefinitionKey?tenantId=&processDefinitionKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─name	string	事项名称	-
└─type	string	事项类型	-
└─accountability	string	事项责任制	-
└─nature	string	事项管理员	-
└─sysLevel	string	系统级别	-
└─legalLimit	int32	法定期限	-
└─expired	int32	承诺时限	-
└─workflowGuid	string	工作流GUID	-
└─isOnline	string	是否网上申办，1“是”、0“否”	-
└─isDocking	string	是否对接，1“是”、0“否”	-
└─dockingSystem	string	对接外部系统标识	-
└─dockingItemId	string	对接事项id	-
└─systemName	string	系统名称	-
└─todoTaskUrlPrefix	string	待办任务链接前缀	-
└─iconData	string	图标内容	-
└─customItem	boolean	是否可定制事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "type": "",
    "accountability": "",
    "nature": "",
    "sysLevel": "",
    "legalLimit": 0,
    "expired": 0,
    "workflowGuid": "",
    "isOnline": "",
    "isDocking": "",
    "dockingSystem": "",
    "dockingItemId": "",
    "systemName": "",
    "todoTaskUrlPrefix": "",
    "iconData": "",
    "customItem": true
  }
}

获取当前租户所有事项列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getAllItem

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前租户所有事项列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getAllItem?tenantId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─name	string	事项名称	-
└─type	string	事项类型	-
└─accountability	string	事项责任制	-
└─nature	string	事项管理员	-
└─sysLevel	string	系统级别	-
└─legalLimit	int32	法定期限	-
└─expired	int32	承诺时限	-
└─workflowGuid	string	工作流GUID	-
└─isOnline	string	是否网上申办，1“是”、0“否”	-
└─isDocking	string	是否对接，1“是”、0“否”	-
└─dockingSystem	string	对接外部系统标识	-
└─dockingItemId	string	对接事项id	-
└─systemName	string	系统名称	-
└─todoTaskUrlPrefix	string	待办任务链接前缀	-
└─iconData	string	图标内容	-
└─customItem	boolean	是否可定制事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "type": "",
      "accountability": "",
      "nature": "",
      "sysLevel": "",
      "legalLimit": 0,
      "expired": 0,
      "workflowGuid": "",
      "isOnline": "",
      "isDocking": "",
      "dockingSystem": "",
      "dockingItemId": "",
      "systemName": "",
      "todoTaskUrlPrefix": "",
      "iconData": "",
      "customItem": true
    }
  ]
}

获取所有事项信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getAllItemList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有事项信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getAllItemList?tenantId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─name	string	事项名称	-
└─type	string	事项类型	-
└─accountability	string	事项责任制	-
└─nature	string	事项管理员	-
└─sysLevel	string	系统级别	-
└─legalLimit	int32	法定期限	-
└─expired	int32	承诺时限	-
└─workflowGuid	string	工作流GUID	-
└─isOnline	string	是否网上申办，1“是”、0“否”	-
└─isDocking	string	是否对接，1“是”、0“否”	-
└─dockingSystem	string	对接外部系统标识	-
└─dockingItemId	string	对接事项id	-
└─systemName	string	系统名称	-
└─todoTaskUrlPrefix	string	待办任务链接前缀	-
└─iconData	string	图标内容	-
└─customItem	boolean	是否可定制事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "type": "",
      "accountability": "",
      "nature": "",
      "sysLevel": "",
      "legalLimit": 0,
      "expired": 0,
      "workflowGuid": "",
      "isOnline": "",
      "isDocking": "",
      "dockingSystem": "",
      "dockingItemId": "",
      "systemName": "",
      "todoTaskUrlPrefix": "",
      "iconData": "",
      "customItem": true
    }
  ]
}

根据事项id获取事项信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id获取事项信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getByItemId?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─name	string	事项名称	-
└─type	string	事项类型	-
└─accountability	string	事项责任制	-
└─nature	string	事项管理员	-
└─sysLevel	string	系统级别	-
└─legalLimit	int32	法定期限	-
└─expired	int32	承诺时限	-
└─workflowGuid	string	工作流GUID	-
└─isOnline	string	是否网上申办，1“是”、0“否”	-
└─isDocking	string	是否对接，1“是”、0“否”	-
└─dockingSystem	string	对接外部系统标识	-
└─dockingItemId	string	对接事项id	-
└─systemName	string	系统名称	-
└─todoTaskUrlPrefix	string	待办任务链接前缀	-
└─iconData	string	图标内容	-
└─customItem	boolean	是否可定制事项	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "name": "",
    "type": "",
    "accountability": "",
    "nature": "",
    "sysLevel": "",
    "legalLimit": 0,
    "expired": 0,
    "workflowGuid": "",
    "isOnline": "",
    "isDocking": "",
    "dockingSystem": "",
    "dockingItemId": "",
    "systemName": "",
    "todoTaskUrlPrefix": "",
    "iconData": "",
    "customItem": true
  }
}

获取有权限的第一个事项id

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getFirstItem

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有权限的第一个事项id

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getFirstItem?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据事项id获取绑定的表单id

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getFormIdByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id获取绑定的表单id

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
itemId	string	true	事项id	-
processDefinitionKey	string	true	流程定义Key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getFormIdByItemId?tenantId=&itemId=&processDefinitionKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取有权限的事项列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有权限的事项列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemList?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	资源id	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─url	string	事项Id	-
└─appIcon	string	事项图标	-
└─todoCount	int32	待办数量	-
└─name	string	事项名称	-
└─processDefinitionKey	string	流程定义key	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "itemName": "",
      "url": "",
      "appIcon": "",
      "todoCount": 0,
      "name": "",
      "processDefinitionKey": ""
    }
  ]
}

获取事项系统字段映射配置

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemMappingConf

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项系统字段映射配置

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
itemId	string	true	事项id	-
mappingId	string	true	系统标识	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemMappingConf?tenantId=&itemId=&mappingId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─itemId	string	事项Id	-
└─sysType	string	对接系统类型 1为内部系统，2为外部系统	-
└─tableName	string	表名称	-
└─columnName	string	列名称	-
└─mappingId	string	映射系统标识内部系统为事项id，外部系统为自定义标识	-
└─mappingTableName	string	映射表名称，sysType为1时使用	-
└─mappingName	string	映射字段名	-
└─createTime	string	生成时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "sysType": "",
      "tableName": "",
      "columnName": "",
      "mappingId": "",
      "mappingTableName": "",
      "mappingName": "",
      "createTime": ""
    }
  ]
}

获取事项系统列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemSystem

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项系统列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getItemSystem?tenantId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─systemName	string	系统英文名称	-
└─sysLevel	string	系统名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "systemName": "",
      "sysLevel": ""
    }
  ]
}

获取个人有权限事项列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/getMyItemList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取个人有权限事项列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/getMyItemList?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	资源id	-
└─itemId	string	事项Id	-
└─itemName	string	事项名称	-
└─url	string	事项Id	-
└─appIcon	string	事项图标	-
└─todoCount	int32	待办数量	-
└─name	string	事项名称	-
└─processDefinitionKey	string	流程定义key	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "itemName": "",
      "url": "",
      "appIcon": "",
      "todoCount": 0,
      "name": "",
      "processDefinitionKey": ""
    }
  ]
}

判断流程定义key是否绑定事项

URL: https://demo.youshengyun.com/itemAdmin/services/rest/item/hasProcessDefinitionByKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 判断流程定义key是否绑定事项

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
processDefinitionKey	string	true	流程定义Key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/item/hasProcessDefinitionByKey?tenantId=&processDefinitionKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

在办接口

根据系统名称查询当前人的在办数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/countByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称查询当前人的在办数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/countByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统名称查询在办列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/findBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称查询在办列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
systemName	string	true	系统名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/findBySystemName?page=0&rows=0&tenantId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户id和系统名称查询当前人的在办列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/findByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户id和系统名称查询当前人的在办列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/findByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统名称、表名称、搜索内容查询在办列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/searchBySystemName

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据系统名称、表名称、搜索内容查询在办列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
systemName	string	true	系统名称	-
tableName	string	true	表名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/searchBySystemName?page=0&rows=0&tenantId=&systemName=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户id、系统名称、表名称、搜索内容查询当前人的在办列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/searchByUserIdAndSystemName

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据用户id、系统名称、表名称、搜索内容查询当前人的在办列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
tableName	string	true	表名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDoing/searchByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

办结接口

根据用户id和系统名称查询办结数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/countByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户id和系统名称查询办结数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/countByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统名称查询办结列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/findBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称查询办结列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
systemName	string	true	系统名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/findBySystemName?page=0&rows=0&tenantId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户id和系统名称查询当前人办结列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/findByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户id和系统名称查询当前人办结列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/findByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统名称、表名称、搜索内容查询办结列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/searchBySystemName

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据系统名称、表名称、搜索内容查询办结列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
systemName	string	true	系统名称	-
tableName	string	false	表名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/searchBySystemName?page=0&rows=0&tenantId=&systemName=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户id、系统名称、表名称、搜索内容查询当前人办结列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/searchByUserIdAndSystemName

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据用户id、系统名称、表名称、搜索内容查询当前人办结列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
tableName	string	true	表名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/itemDone/searchByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

事项接口绑定信息

获取事项绑定的接口信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getInterface

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项绑定的接口信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
taskKey	string	false	任务key	-
processDefinitionId	string	true	流程定义id	-
condition	string	true	执行条件	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getInterface?tenantId=&itemId=&processDefinitionId=&condition=&taskKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─interfaceName	string	接口名称	-
└─interfaceAddress	string	接口地址	-
└─requestType	string	请求方式	-
└─asyn	string	No comments found.	-
└─abnormalStop	string	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "interfaceName": "",
      "interfaceAddress": "",
      "requestType": "",
      "asyn": "",
      "abnormalStop": ""
    }
  ]
}

获取事项绑定的接口参数信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getInterfaceParams

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项绑定的接口参数信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
interfaceId	string	true	接口id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getInterfaceParams?tenantId=&itemId=&interfaceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─parameterName	string	参数名称	-
└─parameterType	string	参数类型	-
└─fileType	string	是否文件	-
└─bindType	string	绑定类型	-
└─tableName	string	表名称	-
└─columnName	string	表列名	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parameterName": "",
      "parameterType": "",
      "fileType": "",
      "bindType": "",
      "tableName": "",
      "columnName": ""
    }
  ]
}

获取任务时间配置信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getTaskTimeConf

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取任务时间配置信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processDefinitionId	string	true	流程定义id	-
itemId	string	true	事项id	-
taskKey	string	false	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemInterface/getTaskTimeConf?tenantId=&processDefinitionId=&itemId=&taskKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	任务key	-
└─timeoutInterrupt	int32	超时打断时长	-
└─leastTime	int32	最短时长	-
└─taskDefName	string	任务名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "itemId": "",
    "processDefinitionId": "",
    "taskDefKey": "",
    "timeoutInterrupt": 0,
    "leastTime": 0,
    "taskDefName": ""
  }
}

事项链接接口

获取有权限的事项绑定链接

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemLink/getItemLinkList

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有权限的事项绑定链接

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	false	租户id	-
orgUnitId	string	false	人员、岗位id	-
itemId	string	false	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemLink/getItemLinkList?tenantId=&orgUnitId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─linkName	string	链接名称	-
└─linkUrl	string	链接地址	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "linkName": "",
      "linkUrl": "",
      "createTime": ""
    }
  ]
}

获取有权限的节点绑定链接

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemLink/getItemNodeLinkList

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有权限的节点绑定链接

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	false	租户id	-
orgUnitId	string	false	人员、岗位id	-
itemId	string	false	事项id	-
processDefinitionId	string	false	流程定义id	-
taskDefKey	string	false	节点id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemLink/getItemNodeLinkList?itemId=&tenantId=&processDefinitionId=&orgUnitId=&taskDefKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─linkName	string	链接名称	-
└─linkUrl	string	链接地址	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "linkName": "",
    "linkUrl": "",
    "createTime": ""
  }
}

意见框绑定接口

根据事项id获取所有绑定意见框列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id获取所有绑定意见框列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemId?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	意见框和流程定义节点绑定唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框唯一标示	-
└─opinionFrameName	string	意见框名称	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	流程定义节点名称	-
└─taskDefName	string	流程定义节点key	-
└─roleNames	string	角色名称字符串	-
└─roleIds	array	角色Id集合	-
└─userName	string	操作的人员的名称	-
└─userId	string	最后操作的人员的Id	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "opinionFrameName": "",
      "itemId": "",
      "processDefinitionId": "",
      "taskDefKey": "",
      "taskDefName": "",
      "roleNames": "",
      "roleIds": [
        ""
      ],
      "userName": "",
      "userId": "",
      "createDate": "",
      "modifyDate": ""
    }
  ]
}

根据事项id和流程定义id获取所有绑定意见框列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id和流程定义id获取所有绑定意见框列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionId?tenantId=&itemId=&processDefinitionId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	意见框和流程定义节点绑定唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框唯一标示	-
└─opinionFrameName	string	意见框名称	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	流程定义节点名称	-
└─taskDefName	string	流程定义节点key	-
└─roleNames	string	角色名称字符串	-
└─roleIds	array	角色Id集合	-
└─userName	string	操作的人员的名称	-
└─userId	string	最后操作的人员的Id	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "opinionFrameName": "",
      "itemId": "",
      "processDefinitionId": "",
      "taskDefKey": "",
      "taskDefName": "",
      "roleNames": "",
      "roleIds": [
        ""
      ],
      "userName": "",
      "userId": "",
      "createDate": "",
      "modifyDate": ""
    }
  ]
}

根据事项id和任务id获取绑定意见框列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionIdAndTaskDefKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id和任务id获取绑定意见框列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefKey	string	false	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionIdAndTaskDefKey?tenantId=&userId=&itemId=&processDefinitionId=&taskDefKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	意见框和流程定义节点绑定唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框唯一标示	-
└─opinionFrameName	string	意见框名称	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	流程定义节点名称	-
└─taskDefName	string	流程定义节点key	-
└─roleNames	string	角色名称字符串	-
└─roleIds	array	角色Id集合	-
└─userName	string	操作的人员的名称	-
└─userId	string	最后操作的人员的Id	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "opinionFrameName": "",
      "itemId": "",
      "processDefinitionId": "",
      "taskDefKey": "",
      "taskDefName": "",
      "roleNames": "",
      "roleIds": [
        ""
      ],
      "userName": "",
      "userId": "",
      "createDate": "",
      "modifyDate": ""
    }
  ]
}

根据事项id和任务id获取绑定的意见框（包含角色信息）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionIdAndTaskDefKeyContainRole

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据事项id和任务id获取绑定的意见框（包含角色信息）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefKey	string	false	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameBind/findByItemIdAndProcessDefinitionIdAndTaskDefKeyContainRole?tenantId=&userId=&itemId=&processDefinitionId=&taskDefKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	意见框和流程定义节点绑定唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框唯一标示	-
└─opinionFrameName	string	意见框名称	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	流程定义节点名称	-
└─taskDefName	string	流程定义节点key	-
└─roleNames	string	角色名称字符串	-
└─roleIds	array	角色Id集合	-
└─userName	string	操作的人员的名称	-
└─userId	string	最后操作的人员的Id	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "opinionFrameName": "",
      "itemId": "",
      "processDefinitionId": "",
      "taskDefKey": "",
      "taskDefName": "",
      "roleNames": "",
      "roleIds": [
        ""
      ],
      "userName": "",
      "userId": "",
      "createDate": "",
      "modifyDate": ""
    }
  ]
}

意见框绑定角色接口

获取意见框绑定角色列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameRole/findByItemOpinionFrameId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取意见框绑定角色列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemOpinionFrameId	string	true	意见框绑定id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemOpinionFrameRole/findByItemOpinionFrameId?tenantId=&itemOpinionFrameId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─itemOpinionFrameId	string	事项意见框绑定ID	-
└─roleId	string	角色ID	-
└─roleName	string	角色名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemOpinionFrameId": "",
      "roleId": "",
      "roleName": ""
    }
  ]
}

发送选人接口

获取抄送选人组织机构数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUser

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取抄送选人组织机构数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
id	string	false	唯一标识	-
principalType	int32	true	类型:2(部门)、3 (人员)、5(用户组)、6 (岗位)	-
processInstanceId	string	false	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUser?principalType=0&tenantId=&userId=&orgUnitId=&processInstanceId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

获取委办局组织机构数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUserBureau

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取委办局组织机构数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
principalType	int32	true	类型:2(部门)、3 (人员)、5(用户组)、6 (岗位)	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUserBureau?principalType=0&tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

抄送选人搜索

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUserSearch

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 抄送选人搜索

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
name	string	true	人员名称	-
principalType	int32	true	类型:2(部门)、3 (人员)、5(用户组)、6 (岗位)	-
processInstanceId	string	false	流程实例Id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findCsUserSearch?principalType=0&tenantId=&userId=&orgUnitId=&name=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

获取发送人

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUser

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取发送人

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义Id	-
taskDefKey	string	true	流程定义中节点Id	-
principalType	int32	true	类型:2(部门)、3 (人员)、5(用户组)、6 (岗位)	-
id	string	false	唯一标识	-
processInstanceId	string	false	流程实例Id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUser?principalType=0&tenantId=&userId=&orgUnitId=&itemId=&processDefinitionId=&taskDefKey=&id=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

发送选人搜索

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUserByName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 发送选人搜索

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-
name	string	false	人员名称	-
principalType	int32	true	类型:2(部门)、3 (人员)、5(用户组)、6 (岗位)	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefKey	string	true	流程定义中节点Id	-
processInstanceId	string	false	流程实例Id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUserByName?principalType=0&tenantId=&userId=&orgUnitId=&itemId=&processDefinitionId=&taskDefKey=&processInstanceId=&name=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

获取发送人（收发单位）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUserSendReceive

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取发送人（收发单位）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
id	string	false	父节点id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/findPermUserSendReceive?tenantId=&orgUnitId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

获取组织机构树

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/getOrgTree

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取组织机构树

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
id	string	false	组织架构id	-
treeType	enum	true	TREE_TYPE_ORG(tree_type_org, 组织机构树，包含机构、部门、用户组、岗位、人员) TREE_TYPE_ORG_PERSON(tree_type_org_person, 人员组织机构树，包含机构、部门、用户组、人员) TREE_TYPE_ORG_POSITION(tree_type_org_position, 岗位组织机构树，包含机构、部门、用户组、岗位) TREE_TYPE_ORG_MANAGER(tree_type_org_manager, 三员树，包含机构、部门、三员) TREE_TYPE_BUREAU(tree_type_bureau, 委办局树，包含机构、委办局) TREE_TYPE_DEPT(tree_type_dept, 部门树，包含机构、部门) TREE_TYPE_GROUP(tree_type_group, 用户组树，包含机构、部门、用户组) TREE_TYPE_POSITION(tree_type_position, 岗位树，包含机构、部门、岗位) TREE_TYPE_PERSON(tree_type_person, 人员树，包含机构、部门、人员)	-
name	string	false	人员名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemRole/getOrgTree?treeType=TREE_TYPE_ORG&tenantId=&orgUnitId=&id=&name=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─principalType	int32	选项类型	-
└─person	string	选项id	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "name": "",
      "orgType": "",
      "isParent": true,
      "principalType": 0,
      "person": ""
    }
  ]
}

待办接口

根据用户id和系统名称查询待办数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/countByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户id和系统名称查询待办数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/countByUserIdAndSystemName?tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据用户id和系统名称查询待办列表(以发送时间排序)

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/findByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据用户id和系统名称查询待办列表(以发送时间排序)

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/findByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据用户id和系统名称、表名称、搜索集合查询待办列表(以发送时间排序)

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/searchByUserIdAndSystemName

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据用户id和系统名称、表名称、搜索集合查询待办列表(以发送时间排序)

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
systemName	string	true	系统名称	-
tableName	string	true	表名称	-
page	int32	true	page	-
rows	int32	true	rows	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/itemTodo/searchByUserIdAndSystemName?page=0&rows=0&tenantId=&userId=&systemName=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

列表视图接口

获取事项视图配置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/itemViewConf/findByItemIdAndViewType

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项视图配置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
viewType	string	true	视图类型	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/itemViewConf/findByItemIdAndViewType?tenantId=&itemId=&viewType=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─itemId	string	事项ID	-
└─viewType	string	视图类型	-
└─tableName	string	表名	-
└─columnName	string	字段名	-
└─disPlayName	string	显示名称	-
└─disPlayWidth	string	显示宽度	-
└─disPlayAlign	string	显示对齐方式	-
└─tabIndex	int32	排序	-
└─userId	string	用户ID	-
└─userName	string	用户名	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─openSearch	int32	是否开启搜索条件,绑定数据库表和字段时，可开启搜索条件	-
└─inputBoxType	string	输入框类型,search-带图标前缀的搜索框,input,select,date	-
└─spanWidth	string	搜索框宽度	-
└─labelName	string	搜索名称,不填写则使用disPlayName显示名称	-
└─optionClass	string	绑定数据字典,输入框类型select时使用	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "itemId": "",
      "viewType": "",
      "tableName": "",
      "columnName": "",
      "disPlayName": "",
      "disPlayWidth": "",
      "disPlayAlign": "",
      "tabIndex": 0,
      "userId": "",
      "userName": "",
      "createTime": "",
      "updateTime": "",
      "openSearch": 0,
      "inputBoxType": "",
      "spanWidth": "",
      "labelName": "",
      "optionClass": ""
    }
  ]
}

办结信息接口

取消上会（定制）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/cancelMeeting

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 取消上会（定制）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/cancelMeeting

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

监控办结统计数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 监控办结统计数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	false	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByItemId?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

统计个人办结件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 统计个人办结件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	false	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByUserId?tenantId=&orgUnitId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统名称统计个人办结件数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称统计个人办结件数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
systemName	string	false	系统名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countByUserIdAndSystemName?tenantId=&orgUnitId=&systemName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

监控在办统计数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countDoingByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 监控在办统计数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	false	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/countDoingByItemId?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int64	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据流程实例id删除办结信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/deleteOfficeDoneInfo

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id删除办结信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/deleteOfficeDoneInfo

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id获取办结信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/findByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取办结信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/findByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "processInstanceId": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processSerialNumber": "",
    "systemName": "",
    "systemCnName": "",
    "itemId": "",
    "itemName": "",
    "title": "",
    "docNumber": "",
    "urgency": "",
    "creatUserId": "",
    "creatUserName": "",
    "allUserId": "",
    "entrustUserId": "",
    "deptId": "",
    "deptName": "",
    "bureauId": "",
    "startTime": "",
    "endTime": "",
    "userComplete": "",
    "meeting": "",
    "meetingType": "",
    "target": ""
  }
}

上会台账列表（定制）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/getMeetingList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 上会台账列表（定制）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userName	string	false	申请人	-
deptName	string	false	部门名称	-
title	string	false	标题	-
meetingType	string	false	会议类型	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/getMeetingList?page=0&rows=0&tenantId=&title=&userName=&deptName=&meetingType=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

保存办结信息（不经过kafka消息队列，直接保存）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/saveOfficeDone

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存办结信息（不经过kafka消息队列，直接保存）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─tenantId	string	false	租户id	-
└─processInstanceId	string	false	流程实例id	-
└─processDefinitionId	string	false	流程定义id	-
└─processDefinitionKey	string	false	流程定义key	-
└─processSerialNumber	string	false	流程编号	-
└─systemName	string	false	系统英文名称	-
└─systemCnName	string	false	系统中文名称	-
└─itemId	string	false	事项id	-
└─itemName	string	false	事项名称	-
└─title	string	false	标题	-
└─docNumber	string	false	文号	-
└─urgency	string	false	紧急程度	-
└─creatUserId	string	false	创建人Id	-
└─creatUserName	string	false	创建人姓名	-
└─allUserId	string	false	承办人Id	-
└─entrustUserId	string	false	委托人Id，用于委托办结件查询	-
└─deptId	string	false	科室id	-
└─deptName	string	false	部门名称	-
└─bureauId	string	false	委办局id	-
└─startTime	string	false	创建时间	-
└─endTime	string	false	办结时间	-
└─userComplete	string	false	办结人	-
└─meeting	string	false	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	false	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	false	目标，xxx使用	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/saveOfficeDone?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "processInstanceId": "",
    "processDefinitionId": "",
    "processDefinitionKey": "",
    "processSerialNumber": "",
    "systemName": "",
    "systemCnName": "",
    "itemId": "",
    "itemName": "",
    "title": "",
    "docNumber": "",
    "urgency": "",
    "creatUserId": "",
    "creatUserName": "",
    "allUserId": "",
    "entrustUserId": "",
    "deptId": "",
    "deptName": "",
    "bureauId": "",
    "startTime": "",
    "endTime": "",
    "userComplete": "",
    "meeting": "",
    "meetingType": "",
    "target": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取科室所有件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByDeptId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取科室所有件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
deptId	string	true	部门id	-
title	string	false	标题	-
itemId	string	false	事项id	-
userName	string	false	人员名称	-
state	string	false	状态	-
year	string	false	年份	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByDeptId?page=0&rows=0&tenantId=&deptId=&state=&title=&userName=&year=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取个人所有件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取个人所有件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
title	string	false	标题	-
itemId	string	false	事项id	-
userName	string	false	人员名称	-
state	string	false	状态	-
year	string	false	年份	-
startDate	string	false	开始日期	-
endDate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserId?page=0&rows=0&tenantId=&orgUnitId=&itemId=&state=&userName=&endDate=&title=&year=&startDate=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统查询个人所有件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统查询个人所有件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
title	string	false	标题	-
systemName	string	false	系统名称	-
itemId	string	false	事项id	-
state	string	false	状态	-
year	string	false	年份	-
startdate	string	false	开始日期	-
enddate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserIdAndSystemName?page=0&rows=0&tenantId=&orgUnitId=&title=&itemId=&year=&state=&systemName=&startdate=&enddate=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据系统，个人所有件搜索,xxx使用

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserIdAndSystemName4xxx

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统，个人所有件搜索,xxx使用

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
title	string	false	标题	-
systemName	string	false	系统名称	-
itemId	string	false	事项id	-
target	string	false	目标	-
state	string	false	状态	-
year	string	false	年份	-
startdate	string	false	开始日期	-
enddate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllByUserIdAndSystemName4xxx?page=0&rows=0&tenantId=&orgUnitId=&target=&year=&startdate=&title=&systemName=&itemId=&state=&enddate=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取监控办件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取监控办件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
searchName	string	false	搜索词	-
itemId	string	false	事项id	-
userName	string	false	人员名称	-
state	string	false	状态	-
year	string	false	年份	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchAllList?page=0&rows=0&tenantId=&searchName=&userName=&state=&year=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取监控在办、办结件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByItemId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取监控在办、办结件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
title	string	false	搜索词	-
itemId	string	false	事项id	-
state	string	false	状态	-
startdate	string	false	开始日期	-
enddate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByItemId?page=0&rows=0&tenantId=&state=&title=&itemId=&startdate=&enddate=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取个人办结件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取个人办结件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
title	string	false	搜索词	-
itemId	string	false	事项id	-
startdate	string	false	开始日期	-
enddate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByUserId?page=0&rows=0&tenantId=&orgUnitId=&title=&itemId=&startdate=&enddate=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

根据id、系统名称、获取个人办结件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByUserIdAndSystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id、系统名称、获取个人办结件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
title	string	false	搜索词	-
systemName	string	false	系统名称	-
startdate	string	false	开始日期	-
enddate	string	false	结束日期	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/searchByUserIdAndSystemName?page=0&rows=0&tenantId=&orgUnitId=&startdate=&systemName=&enddate=&title=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户id	-
└─processInstanceId	string	流程实例id	-
└─processDefinitionId	string	流程定义id	-
└─processDefinitionKey	string	流程定义key	-
└─processSerialNumber	string	流程编号	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─itemName	string	事项名称	-
└─title	string	标题	-
└─docNumber	string	文号	-
└─urgency	string	紧急程度	-
└─creatUserId	string	创建人Id	-
└─creatUserName	string	创建人姓名	-
└─allUserId	string	承办人Id	-
└─entrustUserId	string	委托人Id，用于委托办结件查询	-
└─deptId	string	科室id	-
└─deptName	string	部门名称	-
└─bureauId	string	委办局id	-
└─startTime	string	创建时间	-
└─endTime	string	办结时间	-
└─userComplete	string	办结人	-
└─meeting	string	是否上会，1为上会,ddyjs使用	-
└─meetingType	string	会议类型，党组会，办公会，专题会,当代研究所使用	-
└─target	string	目标，xxx使用	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "processInstanceId": "",
        "processDefinitionId": "",
        "processDefinitionKey": "",
        "processSerialNumber": "",
        "systemName": "",
        "systemCnName": "",
        "itemId": "",
        "itemName": "",
        "title": "",
        "docNumber": "",
        "urgency": "",
        "creatUserId": "",
        "creatUserName": "",
        "allUserId": "",
        "entrustUserId": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "startTime": "",
        "endTime": "",
        "userComplete": "",
        "meeting": "",
        "meetingType": "",
        "target": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

设置会议类型(上会)

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/setMeeting

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置会议类型(上会)

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
meetingType	string	true	会议类型	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeDoneInfo/setMeeting

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

我的关注接口

根据流程实例id获取关注数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/countByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取关注数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/countByProcessInstanceId?tenantId=&orgUnitId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

取消关注

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/delOfficeFollow

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 取消关注

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceIds	string	true	流程实例id列表	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/delOfficeFollow

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例id删除关注数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/deleteByProcessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id删除关注数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/deleteByProcessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取我的关注数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getFollowCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取我的关注数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getFollowCount?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

根据系统名称获取关注列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getFollowListBySystemName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据系统名称获取关注列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
systemName	string	true	系统名称	-
searchName	string	false	搜索词	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getFollowListBySystemName?page=0&rows=0&tenantId=&orgUnitId=&systemName=&searchName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─guid	string	唯一标示	-
└─processSerialNumber	string	工作流流程编号	-
└─itemId	string	事项id	-
└─processInstanceId	string	流程实例id	-
└─jinjichengdu	string	紧急程度	-
└─numbers	string	文件编号	-
└─sendDept	string	来文单位/拟稿单位	-
└─fileType	string	文件类型	-
└─systemName	string	系统名称	-
└─documentTitle	string	标题	-
└─handleTerm	string	办理期限	-
└─bureauId	string	委办局id	-
└─bureauName	string	委办局名称	-
└─userId	string	关注人ID	-
└─userName	string	关注人姓名	-
└─startTime	string	流程启动时间	-
└─createTime	string	关注时间	-
└─taskId	string	任务id	-
└─taskName	string	任务环节	-
└─taskCreateTime	string	任务创建时间	-
└─taskAssignee	string	当前任务办理人	-
└─itembox	string	办件状态	-
└─chaosong	boolean	是否有抄送	-
└─msgremind	boolean	是否有消息提醒	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "guid": "",
        "processSerialNumber": "",
        "itemId": "",
        "processInstanceId": "",
        "jinjichengdu": "",
        "numbers": "",
        "sendDept": "",
        "fileType": "",
        "systemName": "",
        "documentTitle": "",
        "handleTerm": "",
        "bureauId": "",
        "bureauName": "",
        "userId": "",
        "userName": "",
        "startTime": "",
        "createTime": "",
        "taskId": "",
        "taskName": "",
        "taskCreateTime": "",
        "taskAssignee": "",
        "itembox": "",
        "chaosong": true,
        "msgremind": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取指定人员的关注列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getOfficeFollowList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取指定人员的关注列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
searchName	string	false	搜索词	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/getOfficeFollowList?page=0&rows=0&tenantId=&orgUnitId=&searchName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─guid	string	唯一标示	-
└─processSerialNumber	string	工作流流程编号	-
└─itemId	string	事项id	-
└─processInstanceId	string	流程实例id	-
└─jinjichengdu	string	紧急程度	-
└─numbers	string	文件编号	-
└─sendDept	string	来文单位/拟稿单位	-
└─fileType	string	文件类型	-
└─systemName	string	系统名称	-
└─documentTitle	string	标题	-
└─handleTerm	string	办理期限	-
└─bureauId	string	委办局id	-
└─bureauName	string	委办局名称	-
└─userId	string	关注人ID	-
└─userName	string	关注人姓名	-
└─startTime	string	流程启动时间	-
└─createTime	string	关注时间	-
└─taskId	string	任务id	-
└─taskName	string	任务环节	-
└─taskCreateTime	string	任务创建时间	-
└─taskAssignee	string	当前任务办理人	-
└─itembox	string	办件状态	-
└─chaosong	boolean	是否有抄送	-
└─msgremind	boolean	是否有消息提醒	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "guid": "",
        "processSerialNumber": "",
        "itemId": "",
        "processInstanceId": "",
        "jinjichengdu": "",
        "numbers": "",
        "sendDept": "",
        "fileType": "",
        "systemName": "",
        "documentTitle": "",
        "handleTerm": "",
        "bureauId": "",
        "bureauName": "",
        "userId": "",
        "userName": "",
        "startTime": "",
        "createTime": "",
        "taskId": "",
        "taskName": "",
        "taskCreateTime": "",
        "taskAssignee": "",
        "itembox": "",
        "chaosong": true,
        "msgremind": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

保存办件关注信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/saveOfficeFollow

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存办件关注信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─guid	string	false	唯一标示	-
└─processSerialNumber	string	false	工作流流程编号	-
└─itemId	string	false	事项id	-
└─processInstanceId	string	false	流程实例id	-
└─jinjichengdu	string	false	紧急程度	-
└─numbers	string	false	文件编号	-
└─sendDept	string	false	来文单位/拟稿单位	-
└─fileType	string	false	文件类型	-
└─systemName	string	false	系统名称	-
└─documentTitle	string	false	标题	-
└─handleTerm	string	false	办理期限	-
└─bureauId	string	false	委办局id	-
└─bureauName	string	false	委办局名称	-
└─userId	string	false	关注人ID	-
└─userName	string	false	关注人姓名	-
└─startTime	string	false	流程启动时间	-
└─createTime	string	false	关注时间	-
└─taskId	string	false	任务id	-
└─taskName	string	false	任务环节	-
└─taskCreateTime	string	false	任务创建时间	-
└─taskAssignee	string	false	当前任务办理人	-
└─itembox	string	false	办件状态	-
└─chaosong	boolean	false	是否有抄送	-
└─msgremind	boolean	false	是否有消息提醒	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/saveOfficeFollow?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "guid": "",
    "processSerialNumber": "",
    "itemId": "",
    "processInstanceId": "",
    "jinjichengdu": "",
    "numbers": "",
    "sendDept": "",
    "fileType": "",
    "systemName": "",
    "documentTitle": "",
    "handleTerm": "",
    "bureauId": "",
    "bureauName": "",
    "userId": "",
    "userName": "",
    "startTime": "",
    "createTime": "",
    "taskId": "",
    "taskName": "",
    "taskCreateTime": "",
    "taskAssignee": "",
    "itembox": "",
    "chaosong": true,
    "msgremind": true
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

更新关注信息的标题

URL: https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/updateTitle

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新关注信息的标题

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
documentTitle	string	true	文档标题	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/officeFollow/updateTitle

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

意见接口

验证当前taskId任务节点是否已经签写意见

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/checkSignOpinion

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 验证当前taskId任务节点是否已经签写意见

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
taskId	string	false	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/checkSignOpinion?tenantId=&userId=&processSerialNumber=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

获取意见框历史记录数量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/countOpinionHistory

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取意见框历史记录数量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
opinionFrameMark	string	true	意见框标识	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/countOpinionHistory?tenantId=&processSerialNumber=&opinionFrameMark=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

删除意见数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/delete

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除意见数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	唯一标识	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/delete

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取事项绑定的意见框列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/getBindOpinionFrame

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取事项绑定的意见框列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-
processDefinitionId	string	false	流程定义Id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/getBindOpinionFrame?tenantId=&itemId=&processDefinitionId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	意见框和流程定义节点绑定唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框唯一标示	-
└─opinionFrameName	string	意见框名称	-
└─itemId	string	事项Id	-
└─processDefinitionId	string	流程定义Id	-
└─taskDefKey	string	流程定义节点名称	-
└─taskDefName	string	流程定义节点key	-
└─roleNames	string	角色名称字符串	-
└─roleIds	array	角色Id集合	-
└─userName	string	操作的人员的名称	-
└─userId	string	最后操作的人员的Id	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "opinionFrameName": "",
      "itemId": "",
      "processDefinitionId": "",
      "taskDefKey": "",
      "taskDefName": "",
      "roleNames": "",
      "roleIds": [
        ""
      ],
      "userName": "",
      "userId": "",
      "createDate": "",
      "modifyDate": ""
    }
  ]
}

根据id获取意见数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/getById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id获取意见数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	唯一标识	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/getById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─tenantId	string	租户Id,必填	-
└─opinionFrameMark	string	意见框Id,必填	-
└─processSerialNumber	string	流程系列号,必填	-
└─processInstanceId	string	流程实例Id,新建为空，不是新建传值	-
└─taskId	string	任务实例Id,新建为空，不是新建传值	-
└─content	string	意见内容,必填	-
└─userId	string	填写意见人员id,必填	-
└─userName	string	填写意见的人员名称,必填	-
└─deptId	string	填写意见部门id,必填	-
└─deptName	string	填写意见的部门名称,必填	-
└─createDate	string	意见生成时间	-
└─modifyDate	string	意见最后的修改时间	-
└─processTrackId	string	自定义历程id	-
└─positionId	string	岗位id,必填	-
└─positionName	string	岗位名称	-
└─sign	array	个人签名图片	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "opinionFrameMark": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "content": "",
    "userId": "",
    "userName": "",
    "deptId": "",
    "deptName": "",
    "createDate": "",
    "modifyDate": "",
    "processTrackId": "",
    "positionId": "",
    "positionName": "",
    "sign": []
  }
}

根据意见框标识获取意见框历史记录

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/opinionHistoryList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据意见框标识获取意见框历史记录

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
opinionFrameMark	string	true	意见框标识	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/opinionHistoryList?tenantId=&processSerialNumber=&opinionFrameMark=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─tenantId	string	租户Id	-
└─opinionFrameMark	string	意见框Id	-
└─processSerialNumber	string	流程系列号	-
└─processInstanceId	string	流程实例Id	-
└─taskId	string	任务实例Id	-
└─content	string	意见内容	-
└─userId	string	填写意见人员id	-
└─userName	string	填写意见的人员名称	-
└─deptId	string	填写意见部门id	-
└─deptName	string	填写意见的部门名称	-
└─agentUserId	string	意见代录人Guid	-
└─agentUserName	string	意见代录人姓名	-
└─agentUserDeptId	string	代录人的部门Id	-
└─agentUserDeptName	string	代录人的部门Name	-
└─isAgent	int32	是否是代录意见， 0=不是；1=是	-
└─createDate	string	意见生成时间	-
└─modifyDate	string	意见最后的修改时间	-
└─saveDate	string	操作、保存时间	-
└─opinionType	string	意见类型，1为修改，2为删除	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "opinionFrameMark": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "taskId": "",
      "content": "",
      "userId": "",
      "userName": "",
      "deptId": "",
      "deptName": "",
      "agentUserId": "",
      "agentUserName": "",
      "agentUserDeptId": "",
      "agentUserDeptName": "",
      "isAgent": 0,
      "createDate": "",
      "modifyDate": "",
      "saveDate": "",
      "opinionType": ""
    }
  ]
}

获取个人意见列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/personCommentList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取个人意见列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
taskId	string	false	任务id	-
itembox	string	true	办件状态，todo（待办），doing（在办），done（办结）	-
opinionFrameMark	string	true	意见框标识	-
itemId	string	true	事项id	-
taskDefinitionKey	string	false	任务定义key	-
activitiUser	string	false	人员id	-
orderByUser	string	false	是否根据岗位排序 1：按岗位排序号排序	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/personCommentList?tenantId=&userId=&processSerialNumber=&itembox=&opinionFrameMark=&itemId=&taskDefinitionKey=&activitiUser=&orderByUser=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─opinionFrameMark	string	意见框标识	-
└─isEdit	boolean	意见是否编辑过	-
└─editable	boolean	意见是否可编辑	-
└─addAgent	boolean	是否可新增代录意见	-
└─addable	boolean	是否可新增意见	-
└─opinion	object	意见实体内容	-
└─id	string	唯一标示	-
└─tenantId	string	租户Id,必填	-
└─opinionFrameMark	string	意见框Id,必填	-
└─processSerialNumber	string	流程系列号,必填	-
└─processInstanceId	string	流程实例Id,新建为空，不是新建传值	-
└─taskId	string	任务实例Id,新建为空，不是新建传值	-
└─content	string	意见内容,必填	-
└─userId	string	填写意见人员id,必填	-
└─userName	string	填写意见的人员名称,必填	-
└─deptId	string	填写意见部门id,必填	-
└─deptName	string	填写意见的部门名称,必填	-
└─createDate	string	意见生成时间	-
└─modifyDate	string	意见最后的修改时间	-
└─processTrackId	string	自定义历程id	-
└─positionId	string	岗位id,必填	-
└─positionName	string	岗位名称	-
└─sign	array	个人签名图片	-
└─signOpinion	boolean	是否必签意见	-
└─oneClickSetList	array	一键设置列表	-
└─id	string	唯一标示	-
└─oneSetType	string	No comments found.	-
└─executeAction	string	No comments found.	-
└─oneSetTypeName	string	No comments found.	-
└─executeActionName	string	No comments found.	-
└─description	string	No comments found.	-
└─bindId	string	No comments found.	-
└─userId	string	No comments found.	-
└─createDate	string	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "opinionFrameMark": "",
      "isEdit": true,
      "editable": true,
      "addAgent": true,
      "addable": true,
      "opinion": {
        "id": "",
        "tenantId": "",
        "opinionFrameMark": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "content": "",
        "userId": "",
        "userName": "",
        "deptId": "",
        "deptName": "",
        "createDate": "",
        "modifyDate": "",
        "processTrackId": "",
        "positionId": "",
        "positionName": "",
        "sign": []
      },
      "signOpinion": true,
      "oneClickSetList": [
        {
          "id": "",
          "oneSetType": "",
          "executeAction": "",
          "oneSetTypeName": "",
          "executeActionName": "",
          "description": "",
          "bindId": "",
          "userId": "",
          "createDate": ""
        }
      ]
    }
  ]
}

保存意见信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/save

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存意见信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	唯一标示	-
└─tenantId	string	false	租户Id,必填	-
└─opinionFrameMark	string	false	意见框Id,必填	-
└─processSerialNumber	string	false	流程系列号,必填	-
└─processInstanceId	string	false	流程实例Id,新建为空，不是新建传值	-
└─taskId	string	false	任务实例Id,新建为空，不是新建传值	-
└─content	string	false	意见内容,必填	-
└─userId	string	false	填写意见人员id,必填	-
└─userName	string	false	填写意见的人员名称,必填	-
└─deptId	string	false	填写意见部门id,必填	-
└─deptName	string	false	填写意见的部门名称,必填	-
└─createDate	string	false	意见生成时间	-
└─modifyDate	string	false	意见最后的修改时间	-
└─processTrackId	string	false	自定义历程id	-
└─positionId	string	false	岗位id,必填	-
└─positionName	string	false	岗位名称	-
└─sign	array	false	个人签名图片	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/save?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "opinionFrameMark": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "content": "",
    "userId": "",
    "userName": "",
    "deptId": "",
    "deptName": "",
    "createDate": "",
    "modifyDate": "",
    "processTrackId": "",
    "positionId": "",
    "positionName": "",
    "sign": []
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

保存或更新意见信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或更新意见信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
orgUnitId	string	true	人员、岗位id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	唯一标示	-
└─tenantId	string	false	租户Id,必填	-
└─opinionFrameMark	string	false	意见框Id,必填	-
└─processSerialNumber	string	false	流程系列号,必填	-
└─processInstanceId	string	false	流程实例Id,新建为空，不是新建传值	-
└─taskId	string	false	任务实例Id,新建为空，不是新建传值	-
└─content	string	false	意见内容,必填	-
└─userId	string	false	填写意见人员id,必填	-
└─userName	string	false	填写意见的人员名称,必填	-
└─deptId	string	false	填写意见部门id,必填	-
└─deptName	string	false	填写意见的部门名称,必填	-
└─createDate	string	false	意见生成时间	-
└─modifyDate	string	false	意见最后的修改时间	-
└─processTrackId	string	false	自定义历程id	-
└─positionId	string	false	岗位id,必填	-
└─positionName	string	false	岗位名称	-
└─sign	array	false	个人签名图片	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/saveOrUpdate?tenantId=&userId=&orgUnitId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "opinionFrameMark": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "content": "",
    "userId": "",
    "userName": "",
    "deptId": "",
    "deptName": "",
    "createDate": "",
    "modifyDate": "",
    "processTrackId": "",
    "positionId": "",
    "positionName": "",
    "sign": []
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─tenantId	string	租户Id,必填	-
└─opinionFrameMark	string	意见框Id,必填	-
└─processSerialNumber	string	流程系列号,必填	-
└─processInstanceId	string	流程实例Id,新建为空，不是新建传值	-
└─taskId	string	任务实例Id,新建为空，不是新建传值	-
└─content	string	意见内容,必填	-
└─userId	string	填写意见人员id,必填	-
└─userName	string	填写意见的人员名称,必填	-
└─deptId	string	填写意见部门id,必填	-
└─deptName	string	填写意见的部门名称,必填	-
└─createDate	string	意见生成时间	-
└─modifyDate	string	意见最后的修改时间	-
└─processTrackId	string	自定义历程id	-
└─positionId	string	岗位id,必填	-
└─positionName	string	岗位名称	-
└─sign	array	个人签名图片	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "opinionFrameMark": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "taskId": "",
    "content": "",
    "userId": "",
    "userName": "",
    "deptId": "",
    "deptName": "",
    "createDate": "",
    "modifyDate": "",
    "processTrackId": "",
    "positionId": "",
    "positionName": "",
    "sign": []
  }
}

更新意见信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/opinion/updateOpinion

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新意见信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	意见id	-
content	string	true	意见内容	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/opinion/updateOpinion

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

数据字典接口

获取数据字典列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/optionClass/getOptionValueList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取数据字典列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
type	string	true	字典标识	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/optionClass/getOptionValueList?tenantId=&type=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─code	string	数据代码	-
└─name	string	主键名称	-
└─type	string	字典类型	-
└─defaultSelected	int32	是否默认选中	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "code": "",
      "name": "",
      "type": "",
      "defaultSelected": 0
    }
  ]
}

编号接口

验证编号是否已经被使用

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/checkNumberStr

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 验证编号是否已经被使用

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
characterValue	string	true	机关代字	-
custom	string	true	机关代字标志	-
year	int32	true	文号年份	-
numberTemp	int32	true	编号	-
itemId	string	true	事项id	-
common	int32	true	common	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/checkNumberStr?year=0&numberTemp=0&common=0&tenantId=&userId=&characterValue=&custom=&itemId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

判断编号标识在当前流程实例中是否编号,未编号就获取有权限的编号的机关代字

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/exist

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 判断编号标识在当前流程实例中是否编号,未编号就获取有权限的编号的机关代字

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
custom	string	true	编号标识	-
processSerialNumber	string	true	流程编号	-
processInstanceId	string	false	流程实例id	-
itembox	string	true	办件状态，todo（待办），doing（在办），done（办结）	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/exist?tenantId=&userId=&custom=&processSerialNumber=&itembox=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标识	-
└─custom	string	编号标识标志	-
└─name	string	编号标识名字	-
└─numberString	string	编号标识	-
└─exist	boolean	No comments found.	-
└─hasPermission	boolean	No comments found.	-
└─list	array	No comments found.	-
└─id	string	唯一标识	-
└─name	string	机关代字名字	-
└─custom	string	机关代字类型	-
└─initNumber	int32	初始值	-
└─hasPermission	boolean	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "custom": "",
    "name": "",
    "numberString": "",
    "exist": true,
    "hasPermission": true,
    "list": [
      {
        "id": "",
        "name": "",
        "custom": "",
        "initNumber": 0,
        "hasPermission": true
      }
    ]
  }
}

获取编号标识对应的有权限的机构代字

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/findByCustom

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取编号标识对应的有权限的机构代字

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
custom	string	true	编号标识	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefKey	string	false	任务定义key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/findByCustom?tenantId=&orgUnitId=&custom=&itemId=&processDefinitionId=&taskDefKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─name	string	机关代字名字	-
└─custom	string	机关代字类型	-
└─initNumber	int32	初始值	-
└─hasPermission	boolean	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "custom": "",
      "initNumber": 0,
      "hasPermission": true
    }
  ]
}

获取有权限的编号标识

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/findByCustomNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取有权限的编号标识

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
processDefinitionId	string	true	流程定义id	-
taskDefKey	string	false	任务定义key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/findByCustomNumber?tenantId=&orgUnitId=&itemId=&processDefinitionId=&taskDefKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─name	string	机关代字名字	-
└─custom	string	机关代字类型	-
└─initNumber	int32	初始值	-
└─hasPermission	boolean	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "name": "",
      "custom": "",
      "initNumber": 0,
      "hasPermission": true
    }
  ]
}

获取未使用的编号数字

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取未使用的编号数字

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
custom	string	true	机关代字标志	-
characterValue	string	true	机关代字	-
year	int32	true	文号年份	-
common	int32	true	common	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getNumber?year=0&common=0&tenantId=&userId=&custom=&characterValue=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取编号的数字

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getNumberOnly

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取编号的数字

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
custom	string	true	机关代字标志	-
characterValue	string	true	机关代字	-
year	int32	true	文号年份	-
common	int32	true	common	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getNumberOnly?year=0&common=0&tenantId=&userId=&custom=&characterValue=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

获取临时编号数字

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getTempNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取临时编号数字

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	false	租户id	-
userId	string	false	人员id	-
custom	string	false	机关代字标志	-
characterValue	string	false	机关代字	-
itemId	string	false	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/getTempNumber?userId=&custom=&tenantId=&itemId=&characterValue=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

保存临时编号字符串（保存后将占用编号）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/organWord/saveNumberString

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存临时编号字符串（保存后将占用编号）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
custom	string	true	机关代字标志	-
numberString	string	true	编号字符串	-
itemId	string	true	事项id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/organWord/saveNumberString?tenantId=&userId=&custom=&numberString=&itemId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─mapKey	object	A map key.	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  }
}

打印模板接口

获取打印模板文件存储ID（打开打印模板使用）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/print/openDocument

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取打印模板文件存储ID（打开打印模板使用）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
itemId	string	true	事项id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/print/openDocument?tenantId=&itemId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

协作状态接口

删除协作状态数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/deleteProcessInstance

Type: POST

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除协作状态数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/deleteProcessInstance

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

获取协作状态列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/processInstanceList

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取协作状态列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
title	string	false	标题或文号	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/processInstanceList?page=0&rows=0&tenantId=&userId=&title=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─itembox	string	办件状态：todo待办，doing在办，done办结	-
└─processInstanceId	string	流程实例id	-
└─itemName	string	事项名称	-
└─title	string	文件标题	-
└─number	string	编号	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─url	string	详情链接	-
└─itemInfo	array	详情列表	-
└─id	string	主键	-
└─processInstanceId	string	流程实例id	-
└─processSerialNumber	string	流程编号	-
└─taskId	string	任务id	-
└─taskName	string	任务名称	-
└─opinionContent	string	意见内容	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─itemId	string	事项id	-
└─appName	string	应用名称	-
└─appCnName	string	应用中文名称	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─assigneeId	string	办理人id	-
└─assigneeName	string	办理人名称	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─serialNumber	string	编号	-
└─title	string	文件标题	-
└─userName	string	发起人	-
└─itembox	string	办件状态	-
└─url	string	详情链接	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "itembox": "",
        "processInstanceId": "",
        "itemName": "",
        "title": "",
        "number": "",
        "startTime": "yyyy-MM-dd HH:mm:ss",
        "endTime": "yyyy-MM-dd HH:mm:ss",
        "url": "",
        "itemInfo": [
          {
            "id": "",
            "processInstanceId": "",
            "processSerialNumber": "",
            "taskId": "",
            "taskName": "",
            "opinionContent": "",
            "systemName": "",
            "systemCnName": "",
            "itemId": "",
            "appName": "",
            "appCnName": "",
            "senderId": "",
            "senderName": "",
            "assigneeId": "",
            "assigneeName": "",
            "startTime": "yyyy-MM-dd HH:mm:ss",
            "endTime": "yyyy-MM-dd HH:mm:ss",
            "serialNumber": "",
            "title": "",
            "userName": "",
            "itembox": "",
            "url": ""
          }
        ]
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

保存协作状态详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/saveProcessInstanceDetails

Type: POST

Author: zhangchongjie

Content-Type: application/json

Description: 保存协作状态详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─processInstanceId	string	false	流程实例id	-
└─processSerialNumber	string	false	流程编号	-
└─taskId	string	false	任务id	-
└─taskName	string	false	任务名称	-
└─opinionContent	string	false	意见内容	-
└─systemName	string	false	系统英文名称	-
└─systemCnName	string	false	系统中文名称	-
└─itemId	string	false	事项id	-
└─appName	string	false	应用名称	-
└─appCnName	string	false	应用中文名称	-
└─senderId	string	false	发送人id	-
└─senderName	string	false	发送人名称	-
└─assigneeId	string	false	办理人id	-
└─assigneeName	string	false	办理人名称	-
└─startTime	string	false	开始时间	-
└─endTime	string	false	结束时间	-
└─serialNumber	string	false	编号	-
└─title	string	false	文件标题	-
└─userName	string	false	发起人	-
└─itembox	string	false	办件状态	-
└─url	string	false	详情链接	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/saveProcessInstanceDetails?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "processSerialNumber": "",
    "taskId": "",
    "taskName": "",
    "opinionContent": "",
    "systemName": "",
    "systemCnName": "",
    "itemId": "",
    "appName": "",
    "appCnName": "",
    "senderId": "",
    "senderName": "",
    "assigneeId": "",
    "assigneeName": "",
    "startTime": "yyyy-MM-dd HH:mm:ss",
    "endTime": "yyyy-MM-dd HH:mm:ss",
    "serialNumber": "",
    "title": "",
    "userName": "",
    "itembox": "",
    "url": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

更新协作状态详情

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/updateProcessInstanceDetails

Type: POST

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新协作状态详情

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
assigneeId	string	true	受让人id	-
processInstanceId	string	true	流程实例id	-
taskId	string	true	任务id	-
itembox	string	true	办件状态，todo（待办）,doing（在办）,done（办结）	-
endTime	string	true	结束时间	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processInstance/updateProcessInstanceDetails

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

流程变量接口

根据流程实例id删除流程变量数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processParam/deleteByPprocessInstanceId

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id删除流程变量数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processParam/deleteByPprocessInstanceId

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据流程实例获取流程变量数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processParam/findByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例获取流程变量数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processParam/findByProcessInstanceId?tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例Id	-
└─processSerialNumber	string	流程编号	-
└─itemId	string	事项id	-
└─itemName	string	事项id	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─title	string	标题	-
└─customNumber	string	自定义编号	-
└─customLevel	string		-
└─bureauIds	string	委办局Ids	-
└─deptIds	string	部门ids	-
└─completer	string	流程办结人员姓名	-
└─todoTaskUrlPrefix	string	统一待办url前缀	-
└─searchTerm	string	搜索词	-
└─isSendSms	string	是否发送短信	-
└─isShuMing	string	是否署名	-
└─smsContent	string	发送短信内容	-
└─smsPersonId	string	接收短信人员id	-
└─sponsorGuid	string	主办人id	-
└─startor	string	流程的启动人员id	-
└─startorName	string	流程的启动人员姓名	-
└─sended	string	这个件是否发送过,true为发送过	-
└─createTime	string	创建时间	-
└─customItem	boolean	是否定制流程	-
└─target	string	目标，xxx使用	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "processSerialNumber": "",
    "itemId": "",
    "itemName": "",
    "systemName": "",
    "systemCnName": "",
    "title": "",
    "customNumber": "",
    "customLevel": "",
    "bureauIds": "",
    "deptIds": "",
    "completer": "",
    "todoTaskUrlPrefix": "",
    "searchTerm": "",
    "isSendSms": "",
    "isShuMing": "",
    "smsContent": "",
    "smsPersonId": "",
    "sponsorGuid": "",
    "startor": "",
    "startorName": "",
    "sended": "",
    "createTime": "",
    "customItem": true,
    "target": ""
  }
}

根据流程编号获取流程变量数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processParam/findByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号获取流程变量数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processParam/findByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例Id	-
└─processSerialNumber	string	流程编号	-
└─itemId	string	事项id	-
└─itemName	string	事项id	-
└─systemName	string	系统英文名称	-
└─systemCnName	string	系统中文名称	-
└─title	string	标题	-
└─customNumber	string	自定义编号	-
└─customLevel	string		-
└─bureauIds	string	委办局Ids	-
└─deptIds	string	部门ids	-
└─completer	string	流程办结人员姓名	-
└─todoTaskUrlPrefix	string	统一待办url前缀	-
└─searchTerm	string	搜索词	-
└─isSendSms	string	是否发送短信	-
└─isShuMing	string	是否署名	-
└─smsContent	string	发送短信内容	-
└─smsPersonId	string	接收短信人员id	-
└─sponsorGuid	string	主办人id	-
└─startor	string	流程的启动人员id	-
└─startorName	string	流程的启动人员姓名	-
└─sended	string	这个件是否发送过,true为发送过	-
└─createTime	string	创建时间	-
└─customItem	boolean	是否定制流程	-
└─target	string	目标，xxx使用	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "processSerialNumber": "",
    "itemId": "",
    "itemName": "",
    "systemName": "",
    "systemCnName": "",
    "title": "",
    "customNumber": "",
    "customLevel": "",
    "bureauIds": "",
    "deptIds": "",
    "completer": "",
    "todoTaskUrlPrefix": "",
    "searchTerm": "",
    "isSendSms": "",
    "isShuMing": "",
    "smsContent": "",
    "smsPersonId": "",
    "sponsorGuid": "",
    "startor": "",
    "startorName": "",
    "sended": "",
    "createTime": "",
    "customItem": true,
    "target": ""
  }
}

保存或更新流程变量数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processParam/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或更新流程变量数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户ID	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─processInstanceId	string	false	流程实例Id	-
└─processSerialNumber	string	false	流程编号	-
└─itemId	string	false	事项id	-
└─itemName	string	false	事项id	-
└─systemName	string	false	系统英文名称	-
└─systemCnName	string	false	系统中文名称	-
└─title	string	false	标题	-
└─customNumber	string	false	自定义编号	-
└─customLevel	string	false		-
└─bureauIds	string	false	委办局Ids	-
└─deptIds	string	false	部门ids	-
└─completer	string	false	流程办结人员姓名	-
└─todoTaskUrlPrefix	string	false	统一待办url前缀	-
└─searchTerm	string	false	搜索词	-
└─isSendSms	string	false	是否发送短信	-
└─isShuMing	string	false	是否署名	-
└─smsContent	string	false	发送短信内容	-
└─smsPersonId	string	false	接收短信人员id	-
└─sponsorGuid	string	false	主办人id	-
└─startor	string	false	流程的启动人员id	-
└─startorName	string	false	流程的启动人员姓名	-
└─sended	string	false	这个件是否发送过,true为发送过	-
└─createTime	string	false	创建时间	-
└─customItem	boolean	false	是否定制流程	-
└─target	string	false	目标，xxx使用	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/processParam/saveOrUpdate?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "processSerialNumber": "",
    "itemId": "",
    "itemName": "",
    "systemName": "",
    "systemCnName": "",
    "title": "",
    "customNumber": "",
    "customLevel": "",
    "bureauIds": "",
    "deptIds": "",
    "completer": "",
    "todoTaskUrlPrefix": "",
    "searchTerm": "",
    "isSendSms": "",
    "isShuMing": "",
    "smsContent": "",
    "smsPersonId": "",
    "sponsorGuid": "",
    "startor": "",
    "startorName": "",
    "sended": "",
    "createTime": "",
    "customItem": true,
    "target": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

更新定制流程状态

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processParam/updateCustomItem

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新定制流程状态

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-
isCustomItem	boolean	true	是否定制流程	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processParam/updateCustomItem

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

历程接口

根据唯一标示删除历程数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/deleteById

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据唯一标示删除历程数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	唯一标识	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/deleteById

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据任务id获取自定义历程数据（结束时间倒叙排列）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/findByTaskId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id获取自定义历程数据（结束时间倒叙排列）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/findByTaskId?tenantId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例Id	-
└─taskId	string	任务节点Id	-
└─senderName	string	发送人/操作人	-
└─receiverName	string	接收人	-
└─taskDefName	string	任务节点名称	-
└─isChaoSong	boolean	是否有抄送	-
└─opinion	string	意见	-
└─docVersion	int32	正文版本	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─handlingTime	string	办理用时	-
└─described	string	描述	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "processInstanceId": "",
      "taskId": "",
      "senderName": "",
      "receiverName": "",
      "taskDefName": "",
      "isChaoSong": true,
      "opinion": "",
      "docVersion": 0,
      "startTime": "",
      "endTime": "",
      "handlingTime": "",
      "described": ""
    }
  ]
}

根据任务id获取自定义历程数据（开始时间正序排列）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/findByTaskIdAsc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id获取自定义历程数据（开始时间正序排列）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/findByTaskIdAsc?tenantId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例Id	-
└─taskId	string	任务节点Id	-
└─senderName	string	发送人/操作人	-
└─receiverName	string	接收人	-
└─taskDefName	string	任务节点名称	-
└─isChaoSong	boolean	是否有抄送	-
└─opinion	string	意见	-
└─docVersion	int32	正文版本	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─handlingTime	string	办理用时	-
└─described	string	描述	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "processInstanceId": "",
      "taskId": "",
      "senderName": "",
      "receiverName": "",
      "taskDefName": "",
      "isChaoSong": true,
      "opinion": "",
      "docVersion": 0,
      "startTime": "",
      "endTime": "",
      "handlingTime": "",
      "described": ""
    }
  ]
}

获取流程图任务节点信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/getTaskList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程图任务节点信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/getTaskList?tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─Id	string	主键	-
└─activityId	string	节点id	-
└─activityName	string	节点名称	-
└─activityType	string	节点类型	-
└─processDefinitionId	string	流程定义id	-
└─processInstanceId	string	流程实例id	-
└─executionId	string	执行id	-
└─taskId	string	任务id	-
└─calledProcessInstanceId	string	父任务id	-
└─assignee	string	办理人ID	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─durationInMillis	int64	持续市场	-
└─deleteReason	string	删除原因	-
└─tenantId	string	租户ID	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "Id": "",
      "activityId": "",
      "activityName": "",
      "activityType": "",
      "processDefinitionId": "",
      "processInstanceId": "",
      "executionId": "",
      "taskId": "",
      "calledProcessInstanceId": "",
      "assignee": "",
      "startTime": "yyyy-MM-dd HH:mm:ss",
      "endTime": "yyyy-MM-dd HH:mm:ss",
      "durationInMillis": 0,
      "deleteReason": "",
      "tenantId": ""
    }
  ]
}

获取流程历程数据列表(包含每个任务节点的特殊操作的历程)

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/processTrackList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程历程数据列表(包含每个任务节点的特殊操作的历程)

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/processTrackList?tenantId=&orgUnitId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─assignee	string	收件人	-
└─assigneeId	string	收件人id	-
└─taskId	string	任务id	-
└─name	string	任务名称	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─startTimes	int64	开始时间（time）	-
└─endTimes	int64	结束时间（time）	-
└─time	string	历时	-
└─description	object	描述	-
└─opinion	string	意见	-
└─historyVersion	int32	历史正文版本	-
└─endFlag	string	是否被强制办结任务标识	-
└─undertakerId	string	承办人id,用于数据中心保存	-
└─newToDo	int32	是否新建待办	-
└─isChaoSong	boolean	是否有抄送	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "assignee": "",
      "assigneeId": "",
      "taskId": "",
      "name": "",
      "startTime": "",
      "endTime": "",
      "startTimes": 0,
      "endTimes": 0,
      "time": "",
      "description": {
        "object": "any object"
      },
      "opinion": "",
      "historyVersion": 0,
      "endFlag": "",
      "undertakerId": "",
      "newToDo": 0,
      "isChaoSong": true
    }
  ]
}

获取流程历程信息数据（简单版）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/processTrackList4Simple

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程历程信息数据（简单版）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/processTrackList4Simple?tenantId=&orgUnitId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─assignee	string	收件人	-
└─assigneeId	string	收件人id	-
└─taskId	string	任务id	-
└─name	string	任务名称	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─startTimes	int64	开始时间（time）	-
└─endTimes	int64	结束时间（time）	-
└─time	string	历时	-
└─description	object	描述	-
└─opinion	string	意见	-
└─historyVersion	int32	历史正文版本	-
└─endFlag	string	是否被强制办结任务标识	-
└─undertakerId	string	承办人id,用于数据中心保存	-
└─newToDo	int32	是否新建待办	-
└─isChaoSong	boolean	是否有抄送	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "assignee": "",
      "assigneeId": "",
      "taskId": "",
      "name": "",
      "startTime": "",
      "endTime": "",
      "startTimes": 0,
      "endTimes": 0,
      "time": "",
      "description": {
        "object": "any object"
      },
      "opinion": "",
      "historyVersion": 0,
      "endFlag": "",
      "undertakerId": "",
      "newToDo": 0,
      "isChaoSong": true
    }
  ]
}

保存或更新历程数据

URL: https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或更新历程数据

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	主键	-
└─processInstanceId	string	false	流程实例Id	-
└─taskId	string	false	任务节点Id	-
└─senderName	string	false	发送人/操作人	-
└─receiverName	string	false	接收人	-
└─taskDefName	string	false	任务节点名称	-
└─isChaoSong	boolean	false	是否有抄送	-
└─opinion	string	false	意见	-
└─docVersion	int32	false	正文版本	-
└─startTime	string	false	开始时间	-
└─endTime	string	false	结束时间	-
└─handlingTime	string	false	办理用时	-
└─described	string	false	描述	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/processTrack/saveOrUpdate?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "senderName": "",
    "receiverName": "",
    "taskDefName": "",
    "isChaoSong": true,
    "opinion": "",
    "docVersion": 0,
    "startTime": "",
    "endTime": "",
    "handlingTime": "",
    "described": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例Id	-
└─taskId	string	任务节点Id	-
└─senderName	string	发送人/操作人	-
└─receiverName	string	接收人	-
└─taskDefName	string	任务节点名称	-
└─isChaoSong	boolean	是否有抄送	-
└─opinion	string	意见	-
└─docVersion	int32	正文版本	-
└─startTime	string	开始时间	-
└─endTime	string	结束时间	-
└─handlingTime	string	办理用时	-
└─described	string	描述	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "senderName": "",
    "receiverName": "",
    "taskDefName": "",
    "isChaoSong": true,
    "opinion": "",
    "docVersion": 0,
    "startTime": "",
    "endTime": "",
    "handlingTime": "",
    "described": ""
  }
}

综合查询接口

综合搜索办件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/queryList/getQueryList

Type: POST

Author: zhangchongjie

Content-Type: application/json

Description: 综合搜索办件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	岗位id	-
systemName	string	true	系统名称	-
state	string	false	状态	-
createDate	string	false	开始日期	-
tableName	string	false	表名称	-
page	int32	true	页面	-
rows	int32	true	条数	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	string	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/queryList/getQueryList?page=0&rows=0&tenantId=&userId=&systemName=&state=&createDate=&tableName= --data '&0&0'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	唯一标示	-
└─itemId	string	事项Id	-
└─processSerialNumber	string	流程编号	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务Id	-
└─processDefinitionKey	string	所属事项绑定的流程定义	-
└─startTime	string	流程启动时间	-
└─systemName	string	所属事项的系统英文名称	-
└─status	int32	1是在办、0是待办	-
└─assignee	string	办理人Id	-
└─deptId	string	办理部门	-
└─deptName	string	办理部门名称	-
└─bureauId	string	办理部门所在委办局	-
└─bureauName	string	办理部门所在委办局	-
└─assigneeName	string	办理人姓名	-
└─createTime	string	生成的时间	-
└─lastTime	string	最后一次的办理时间	-
└─started	boolean	是否启动流程	-
└─ended	boolean	流程是否办结	-
└─deleted	boolean	是否删除	-
└─placeOnFile	boolean	是否归档	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "itemId": "",
        "processSerialNumber": "",
        "processInstanceId": "",
        "taskId": "",
        "processDefinitionKey": "",
        "startTime": "",
        "systemName": "",
        "status": 0,
        "assignee": "",
        "deptId": "",
        "deptName": "",
        "bureauId": "",
        "bureauName": "",
        "assigneeName": "",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "lastTime": "yyyy-MM-dd HH:mm:ss",
        "started": true,
        "ended": true,
        "deleted": true,
        "placeOnFile": true
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

快速发送设置接口

获取设置的快速发送人信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/quickSend/getAssignee

Type: GET

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取设置的快速发送人信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
taskKey	string	true	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/quickSend/getAssignee?tenantId=&orgUnitId=&itemId=&taskKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

保存快速发送人信息设置

URL: https://demo.youshengyun.com/itemAdmin/services/rest/quickSend/saveOrUpdate

Type: POST

Author: zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存快速发送人信息设置

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-
itemId	string	true	事项id	-
taskKey	string	true	任务key	-
assignee	string	true	发送人	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/quickSend/saveOrUpdate

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

收发单位接口

根据单位名称模糊查询收发单位

URL: https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/findByDeptNameLike

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据单位名称模糊查询收发单位

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
name	string	true	单位名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/findByDeptNameLike?tenantId=&name=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─disabled	boolean	是否禁用	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─nameWithBureau	string	带委办局的名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "disabled": true,
      "name": "",
      "orgType": "",
      "isParent": true,
      "nameWithBureau": ""
    }
  ]
}

获取所有收发单位

URL: https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getReceiveDeptTree

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有收发单位

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getReceiveDeptTree?tenantId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─disabled	boolean	是否禁用	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─nameWithBureau	string	带委办局的名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "disabled": true,
      "name": "",
      "orgType": "",
      "isParent": true,
      "nameWithBureau": ""
    }
  ]
}

获取所有收发单位、子收发单位（可根据单位名称模糊查询）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getReceiveDeptTreeById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有收发单位、子收发单位（可根据单位名称模糊查询）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	单位Id	-
name	string	false	名称	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getReceiveDeptTreeById?tenantId=&orgUnitId=&name=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─disabled	boolean	是否禁用	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─nameWithBureau	string	带委办局的名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "disabled": true,
      "name": "",
      "orgType": "",
      "isParent": true,
      "nameWithBureau": ""
    }
  ]
}

根据收发单位id获取单位下未禁用的人员集合

URL: https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getSendReceiveByDeptId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据收发单位id获取单位下未禁用的人员集合

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
deptId	string	true	部门id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getSendReceiveByDeptId?tenantId=&deptId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─tenantId	string	租户Id	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-
└─disabled	boolean	是否禁用	-
└─description	string	描述	-
└─customId	string	自定义ID	-
└─dn	string	域名称	-
└─name	string	名称	-
└─orgType	enum	节点类型 [Enum values: ORGANIZATION("Organization", "组织机构") DEPARTMENT("Department", "部门") GROUP("Group", "用户组") POSITION("Position", "岗位") PERSON("Person", "人员") MANAGER("Manager", "三员管理员") ]	-
└─properties	string	扩展属性（json格式）	-
└─tabIndex	int32	序号	-
└─guidPath	string	由ID组成的父子关系列表，之间用逗号分隔	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "tenantId": "",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "disabled": true,
      "description": "",
      "customId": "",
      "dn": "",
      "name": "",
      "orgType": "ORGANIZATION",
      "properties": "",
      "tabIndex": 0,
      "guidPath": ""
    }
  ]
}

根据组织id获取对应的收发单位

URL: https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getSendReceiveByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据组织id获取对应的收发单位

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
orgUnitId	string	true	人员、岗位id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/receiveDeptAndPerson/getSendReceiveByUserId?tenantId=&orgUnitId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标识	-
└─parentId	string	父节点ID	-
└─disabled	boolean	是否禁用	-
└─name	string	名称	-
└─orgType	string	节点类型	-
└─isParent	boolean	是否父节点	-
└─nameWithBureau	string	带委办局的名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "parentId": "",
      "disabled": true,
      "name": "",
      "orgType": "",
      "isParent": true,
      "nameWithBureau": ""
    }
  ]
}

驳回原因接口

保存驳回原因信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/rejectReason/save

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存驳回原因信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
action	int32	true	action	-
taskId	string	true	任务id	-
reason	string	false	理由	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/rejectReason/save

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

催办提醒接口

删除催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/deleteList

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 删除催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─ -	array[string]	false	array of string	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/deleteList?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据id获取催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id获取催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	催办id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─reminderSendType	string	催办发送类型	-
└─reminderMakeTyle	int32	提醒类型	-
└─procInstId	string	流程实例id	-
└─taskId	string	任务id	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─msgContent	string	消息内容	-
└─createTime	string	创建时间	-
└─modifyTime	string	修改时间	-
└─readTime	string	"阅读时间"	-
└─serialNumber	int32	序号	-
└─userName	string	用户名称	-
└─taskName	string	任务名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "reminderSendType": "",
    "reminderMakeTyle": 0,
    "procInstId": "",
    "taskId": "",
    "senderId": "",
    "senderName": "",
    "msgContent": "",
    "createTime": "",
    "modifyTime": "",
    "readTime": "",
    "serialNumber": 0,
    "userName": "",
    "taskName": ""
  }
}

获取流程实例的催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取流程实例的催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findByProcessInstanceId?page=0&rows=0&tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─reminderSendType	string	催办发送类型	-
└─reminderMakeTyle	int32	提醒类型	-
└─procInstId	string	流程实例id	-
└─taskId	string	任务id	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─msgContent	string	消息内容	-
└─createTime	string	创建时间	-
└─modifyTime	string	修改时间	-
└─readTime	string	"阅读时间"	-
└─serialNumber	int32	序号	-
└─userName	string	用户名称	-
└─taskName	string	任务名称	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "reminderSendType": "",
        "reminderMakeTyle": 0,
        "procInstId": "",
        "taskId": "",
        "senderId": "",
        "senderName": "",
        "msgContent": "",
        "createTime": "",
        "modifyTime": "",
        "readTime": "",
        "serialNumber": 0,
        "userName": "",
        "taskName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取当前催办人的在办任务的催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findBySenderIdAndProcessInstanceIdAndActive

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前催办人的在办任务的催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
senderId	string	true	人员di	-
processInstanceId	string	true	流程实例id	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findBySenderIdAndProcessInstanceIdAndActive?page=0&rows=0&tenantId=&senderId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─reminderSendType	string	催办发送类型	-
└─reminderMakeTyle	int32	提醒类型	-
└─procInstId	string	流程实例id	-
└─taskId	string	任务id	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─msgContent	string	消息内容	-
└─createTime	string	创建时间	-
└─modifyTime	string	修改时间	-
└─readTime	string	"阅读时间"	-
└─serialNumber	int32	序号	-
└─userName	string	用户名称	-
└─taskName	string	任务名称	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "reminderSendType": "",
        "reminderMakeTyle": 0,
        "procInstId": "",
        "taskId": "",
        "senderId": "",
        "senderName": "",
        "msgContent": "",
        "createTime": "",
        "modifyTime": "",
        "readTime": "",
        "serialNumber": 0,
        "userName": "",
        "taskName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

获取待办的催办信息列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findByTaskId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取待办的催办信息列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
taskId	string	true	任务id	-
page	int32	true	页码	-
rows	int32	true	条数	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/findByTaskId?page=0&rows=0&tenantId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─currPage	int32	当前页	-
└─totalPages	int32	总页数	-
└─total	int64	总条数	-
└─rows	array	数据项	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─reminderSendType	string	催办发送类型	-
└─reminderMakeTyle	int32	提醒类型	-
└─procInstId	string	流程实例id	-
└─taskId	string	任务id	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─msgContent	string	消息内容	-
└─createTime	string	创建时间	-
└─modifyTime	string	修改时间	-
└─readTime	string	"阅读时间"	-
└─serialNumber	int32	序号	-
└─userName	string	用户名称	-
└─taskName	string	任务名称	-
└─code	int64	错误代码	-
└─msg	string	调用信息	-
└─success	boolean	操作是否成功	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currPage": 0,
    "totalPages": 0,
    "total": 0,
    "rows": [
      {
        "id": "",
        "tenantId": "",
        "reminderSendType": "",
        "reminderMakeTyle": 0,
        "procInstId": "",
        "taskId": "",
        "senderId": "",
        "senderName": "",
        "msgContent": "",
        "createTime": "",
        "modifyTime": "",
        "readTime": "",
        "serialNumber": 0,
        "userName": "",
        "taskName": ""
      }
    ],
    "code": 0,
    "msg": "",
    "success": true
  }
}

查看催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/getReminder

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查看催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
taskId	string	true	任务id	-
type	string	true	类型，todo（待办），doing（在办），done（办结）	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/getReminder?tenantId=&userId=&taskId=&type=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─reminderSendType	string	催办发送类型	-
└─reminderMakeTyle	int32	提醒类型	-
└─procInstId	string	流程实例id	-
└─taskId	string	任务id	-
└─senderId	string	发送人id	-
└─senderName	string	发送人名称	-
└─msgContent	string	消息内容	-
└─createTime	string	创建时间	-
└─modifyTime	string	修改时间	-
└─readTime	string	"阅读时间"	-
└─serialNumber	int32	序号	-
└─userName	string	用户名称	-
└─taskName	string	任务名称	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "reminderSendType": "",
    "reminderMakeTyle": 0,
    "procInstId": "",
    "taskId": "",
    "senderId": "",
    "senderName": "",
    "msgContent": "",
    "createTime": "",
    "modifyTime": "",
    "readTime": "",
    "serialNumber": 0,
    "userName": "",
    "taskName": ""
  }
}

保存催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/saveReminder

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-
msgContent	string	true	催办信息	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─ -	array[string]	false	array of string	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/saveReminder?tenantId=&userId=&processInstanceId=&msgContent=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

发送催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/sendReminderMessage

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 发送催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员、岗位id	-
remType	string	true	催办类型，"1":短信,"2":邮件",3":站内信",4":待办列表中	-
procInstId	string	true	procInstId	-
processInstanceId	string	true	流程实例id	-
documentTitle	string	true	文档标题	-
taskId	string	true	任务id	-
taskAssigneeId	string	true	任务受让人Id	-
msgContent	string	true	催办信息	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/sendReminderMessage

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

设置催办阅读时间

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/setReadTime

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 设置催办阅读时间

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-
└─ -	array[string]	false	array of string	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/setReadTime?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

更新催办信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/reminder/updateReminder

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新催办信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	催办id	-
msgContent	string	true	催办信息	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/reminder/updateReminder

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

消息提醒接口

根据流程实例id获取消息提醒设置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstance

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取消息提醒设置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstance?tenantId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "remindType": "",
      "processInstanceId": "",
      "taskId": "",
      "arriveTaskKey": "",
      "completeTaskKey": "",
      "userId": "",
      "createTime": ""
    }
  ]
}

根据流程实例id和任务key获取任务到达的消息提醒设置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndArriveTaskKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id和任务key获取任务到达的消息提醒设置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
taskKey	string	true	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndArriveTaskKey?tenantId=&processInstanceId=&taskKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "remindType": "",
      "processInstanceId": "",
      "taskId": "",
      "arriveTaskKey": "",
      "completeTaskKey": "",
      "userId": "",
      "createTime": ""
    }
  ]
}

根据流程实例id和任务key获取任务完成的消息提醒设置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndCompleteTaskKey

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id和任务key获取任务完成的消息提醒设置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
taskKey	string	true	任务key	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndCompleteTaskKey?tenantId=&processInstanceId=&taskKey=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "remindType": "",
      "processInstanceId": "",
      "taskId": "",
      "arriveTaskKey": "",
      "completeTaskKey": "",
      "userId": "",
      "createTime": ""
    }
  ]
}

根据流程实例id和提醒类型获取消息提醒设置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndRemindType

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id和提醒类型获取消息提醒设置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
remindType	string	true	提醒类型	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndRemindType?tenantId=&processInstanceId=&remindType=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "remindType": "",
      "processInstanceId": "",
      "taskId": "",
      "arriveTaskKey": "",
      "completeTaskKey": "",
      "userId": "",
      "createTime": ""
    }
  ]
}

根据流程实例id和任务id获取消息提醒设置列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndTaskId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id和任务id获取消息提醒设置列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processInstanceId	string	true	流程实例id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/findRemindInstanceByProcessInstanceIdAndTaskId?tenantId=&processInstanceId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "tenantId": "",
      "remindType": "",
      "processInstanceId": "",
      "taskId": "",
      "arriveTaskKey": "",
      "completeTaskKey": "",
      "userId": "",
      "createTime": ""
    }
  ]
}

根据流程实例id获取个人消息提醒设置

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/getRemindInstance

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例id获取个人消息提醒设置

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/getRemindInstance?tenantId=&userId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─tenantId	string	租户Id	-
└─remindType	string	消息提醒类型	-
└─processInstanceId	string	流程实例id	-
└─taskId	string	任务id	-
└─arriveTaskKey	string	节点到达任务key	-
└─completeTaskKey	string	节点完成任务key	-
└─userId	string	人员id	-
└─createTime	string	创建时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "tenantId": "",
    "remindType": "",
    "processInstanceId": "",
    "taskId": "",
    "arriveTaskKey": "",
    "completeTaskKey": "",
    "userId": "",
    "createTime": ""
  }
}

保存消息提醒设置

URL: https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/saveRemindInstance

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存消息提醒设置

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员、岗位id	-
processInstanceId	string	true	流程实例id	-
taskIds	string	true	任务ids	-
process	boolean	true	是否流程办结提醒	-
arriveTaskKey	string	true	节点到达任务	-
completeTaskKey	string	true	节点完成任务	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/remindInstance/saveRemindInstance

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

签名图片接口

删除签名图片信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/deleteById

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除签名图片信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/deleteById

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据id获取签名图片信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id获取签名图片信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/findById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─fileStoreId	string	文件仓库Id	-
└─tenantId	string	租户Id	-
└─userId	string	签名归属人员id	-
└─userName	string	签名归属人员名称	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "tenantId": "",
    "userId": "",
    "userName": "",
    "createDate": "",
    "modifyDate": ""
  }
}

根据人员id获取签名图片信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/findByUserId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据人员id获取签名图片信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/findByUserId?tenantId=&userId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─fileStoreId	string	文件仓库Id	-
└─tenantId	string	租户Id	-
└─userId	string	签名归属人员id	-
└─userName	string	签名归属人员名称	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "tenantId": "",
    "userId": "",
    "userName": "",
    "createDate": "",
    "modifyDate": ""
  }
}

保存或更新签名图片信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存或更新签名图片信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
spJson	string	true	spJson	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/signaturePicture/saveOrUpdate

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─fileStoreId	string	文件仓库Id	-
└─tenantId	string	租户Id	-
└─userId	string	签名归属人员id	-
└─userName	string	签名归属人员名称	-
└─createDate	string	生成时间	-
└─modifyDate	string	最后的修改时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "tenantId": "",
    "userId": "",
    "userName": "",
    "createDate": "",
    "modifyDate": ""
  }
}

沟通交流接口

逻辑删除发出的沟通消息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/deleteById

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除发出的沟通消息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
id	string	true	主键id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/deleteById

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

根据唯一标示获取发出的沟通消息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/findById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据唯一标示获取发出的沟通消息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
id	string	true	主键id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/findById?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	唯一标示	-
└─processInstanceId	string	流程实例Id	-
└─content	string	发言信息	-
└─userName	string	发言人名称	-
└─userId	string	发言人Id	-
└─edited	boolean	是否可以编辑	-
└─createTime	string	发言时间	-
└─updateTime	string	发言时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "content": "",
    "userName": "",
    "userId": "",
    "edited": true,
    "createTime": "",
    "updateTime": ""
  }
}

根据流程实例查找某一个流程的所有沟通的消息，根据时间倒叙排列

URL: https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/findByProcessInstanceId

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程实例查找某一个流程的所有沟通的消息，根据时间倒叙排列

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/findByProcessInstanceId?tenantId=&userId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	唯一标示	-
└─processInstanceId	string	流程实例Id	-
└─content	string	发言信息	-
└─userName	string	发言人名称	-
└─userId	string	发言人Id	-
└─edited	boolean	是否可以编辑	-
└─createTime	string	发言时间	-
└─updateTime	string	发言时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "processInstanceId": "",
      "content": "",
      "userName": "",
      "userId": "",
      "edited": true,
      "createTime": "",
      "updateTime": ""
    }
  ]
}

获取未读消息计数

URL: https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/getNotReadCount

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取未读消息计数

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processInstanceId	string	true	流程实例id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/getNotReadCount?tenantId=&userId=&processInstanceId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	int32	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": 0
}

保存或者更新发出的沟通消息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/saveOrUpdate

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 保存或者更新发出的沟通消息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	object	false	操作成功返回的数据	-
└─id	string	false	唯一标示	-
└─processInstanceId	string	false	流程实例Id	-
└─content	string	false	发言信息	-
└─userName	string	false	发言人名称	-
└─userId	string	false	发言人Id	-
└─edited	boolean	false	是否可以编辑	-
└─createTime	string	false	发言时间	-
└─updateTime	string	false	发言时间	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/speakInfo/saveOrUpdate?tenantId=&userId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "content": "",
    "userName": "",
    "userId": "",
    "edited": true,
    "createTime": "",
    "updateTime": ""
  }
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

任务变量接口

根据任务id和keyName获取任务变量

URL: https://demo.youshengyun.com/itemAdmin/services/rest/taskVariable/findByTaskIdAndKeyName

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id和keyName获取任务变量

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
taskId	string	true	任务id	-
keyName	string	true	keyName	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/taskVariable/findByTaskIdAndKeyName?tenantId=&taskId=&keyName=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─processInstanceId	string	流程实例	-
└─taskId	string	任务id	-
└─keyName	string	变量名称	-
└─text	string	变量值	-
└─createTime	string	创建时间	-
└─updateTime	string	更新时间	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "processInstanceId": "",
    "taskId": "",
    "keyName": "",
    "text": "",
    "createTime": "",
    "updateTime": ""
  }
}

正文接口

根据流程编号删除正文，同时删除文件历史的文件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/delBatchByProcessSerialNumbers

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/json

Description: 根据流程编号删除正文，同时删除文件历史的文件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-

Body-parameters:

Parameter	Type	Required	Description	Since
success	boolean	false	操作是否成功	-
code	int32	false	错误代码	-
msg	string	false	操作描述	-
data	array	false	操作成功返回的数据	-

Request-example:

bash

curl -X POST -k -H 'Content-Type: application/json' -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/delBatchByProcessSerialNumbers?tenantId= --data '{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    "",
    ""
  ]
}'

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

删除撤销PDF文件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/deleteByIsTaoHong

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除撤销PDF文件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
isTaoHong	string	true	是否套红	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/deleteByIsTaoHong

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取正文文件信息（数据传输）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/exchangeFindWordByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取正文文件信息（数据传输）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/exchangeFindWordByProcessSerialNumber?tenantId=&userId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileStoreId	string	附件上传ID	-
└─title	string	标题	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─fileSize	string	文件大小	-
└─userId	string	上传人员id	-
└─userName	string	上传人员名称	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─isTaoHong	string	是否套红、1为套红word，0为word	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "title": "",
    "fileType": "",
    "fileName": "",
    "fileSize": "",
    "userId": "",
    "userName": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "isTaoHong": ""
  }
}

根据任务id获取正文历史文件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/findHistoryVersionDoc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据任务id获取正文历史文件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/findHistoryVersionDoc?tenantId=&userId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileStoreId	string	文件仓库Id	-
└─title	string	标题	-
└─fileType	string	文件类型	-
└─fileSize	string	文件大小	-
└─userId	string	上传人员id	-
└─userName	string	上传人员名称	-
└─isTaoHong	string	是否套红,1为套红word，0为word	-
└─saveDate	string	保存时间	-
└─taskId	string	任务ID	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─openWordOrPdf	string	打开方式	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "title": "",
    "fileType": "",
    "fileSize": "",
    "userId": "",
    "userName": "",
    "isTaoHong": "",
    "saveDate": "",
    "taskId": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "openWordOrPdf": ""
  }
}

根据流程编号获取正文文件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/findWordByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号获取正文文件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/findWordByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileStoreId	string	附件上传ID	-
└─title	string	标题	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─fileSize	string	文件大小	-
└─userId	string	上传人员id	-
└─userName	string	上传人员名称	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─isTaoHong	string	是否套红、1为套红word，0为word	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "title": "",
    "fileType": "",
    "fileName": "",
    "fileSize": "",
    "userId": "",
    "userName": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "isTaoHong": ""
  }
}

获取当前流程所有的正文文件列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/getWordList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前流程所有的正文文件列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/getWordList?tenantId=&userId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─id	string	主键	-
└─fileStoreId	string	附件上传ID	-
└─title	string	标题	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─fileSize	string	文件大小	-
└─userId	string	上传人员id	-
└─userName	string	上传人员名称	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─isTaoHong	string	是否套红、1为套红word，0为word	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "id": "",
      "fileStoreId": "",
      "title": "",
      "fileType": "",
      "fileName": "",
      "fileSize": "",
      "userId": "",
      "userName": "",
      "saveDate": "",
      "processSerialNumber": "",
      "processInstanceId": "",
      "isTaoHong": ""
    }
  ]
}

获取正文文件存储路径信息（用于打开正文）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocument

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取正文文件存储路径信息（用于打开正文）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
itemId	string	true	事项id	-
bindValue	string	false	绑定值	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocument?tenantId=&userId=&processSerialNumber=&itemId=&bindValue=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据流程编号打开正文

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocumentByProcessSerialNumber

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据流程编号打开正文

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocumentByProcessSerialNumber?tenantId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

根据模板id获取套红模板数据（打开套红模板使用）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocumentTemplate

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据模板id获取套红模板数据（打开套红模板使用）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	用户id	-
templateGuid	string	true	模板id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openDocumentTemplate?tenantId=&userId=&templateGuid=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

打开历史文件

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openHistoryVersionDoc

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 打开历史文件

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
taskId	string	true	任务id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openHistoryVersionDoc?tenantId=&userId=&taskId=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─any object	object	any object.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {}
}

获取PDF文件存储信息（打开PDF使用）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openPdf

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取PDF文件存储信息（打开PDF使用）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openPdf?tenantId=&userId=&processSerialNumber=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取撤销PDF后的正文文件存储信息（用于撤销PDF操作后打开正文）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openRevokePDFAfterDocument

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取撤销PDF后的正文文件存储信息（用于撤销PDF操作后打开正文）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
isTaoHong	string	true	是否套红	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openRevokePDFAfterDocument?tenantId=&userId=&processSerialNumber=&isTaoHong=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

获取套红文件存储信息（打开套红使用）

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openTaoHong

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取套红文件存储信息（打开套红使用）

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
activitiUser	string	true	activitiUser	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/openTaoHong?tenantId=&userId=&activitiUser=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

保存公文传输转入工作流的正文信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/saveImportTransationWord

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 保存公文传输转入工作流的正文信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
userId	string	true	人员Id	-
docjson	string	true	正文json信息	-
processSerialNumber	string	true	流程编号	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/saveImportTransationWord

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

获取正文文件信息

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/showWord

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取正文文件信息

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
processSerialNumber	string	true	流程编号	-
itemId	string	true	事项id	-
itembox	string	false	办件状态，todo（待办），doing（在办），done（办结）	-
taskId	string	false	任务id	-
bindValue	string	false	绑定值	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/showWord?tenantId=&userId=&processSerialNumber=&itemId=&taskId=&itembox=&bindValue=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─activitiUser	string	候选人组	-
└─fileDocumentId	string	正文模板ID	-
└─processSerialNumber	string	流程编号	-
└─userName	string	用户名称	-
└─saveDate	string	保存时间	-
└─openWordOrPdf	string	打开方式	-
└─wordReadOnly	string	是否只读	-
└─itemId	string	事项id	-
└─itembox	string	办件状态：todo（待办），doing（在办），done（办结）	-
└─taskId	string	任务id	-
└─isTaoHong	string	是否套红、1为套红word，0为word	-
└─fileType	string	文件类型	-
└─docCategory	string	正文类型	-
└─fileStoreId	string	文件仓库Id （uid）	-
└─uid	string	文件Id （uid）	-
└─documentTitle	string	正文标题	-
└─browser	string	浏览器类型	-
└─processInstanceId	string	流程实例id	-
└─tenantId	string	租户ID	-
└─userId	string	人员ID	-
└─positionId	string	岗位id	-
└─currentBureauGuid	string	委办局ID	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "activitiUser": "",
    "fileDocumentId": "",
    "processSerialNumber": "",
    "userName": "",
    "saveDate": "",
    "openWordOrPdf": "",
    "wordReadOnly": "",
    "itemId": "",
    "itembox": "",
    "taskId": "",
    "isTaoHong": "",
    "fileType": "",
    "docCategory": "",
    "fileStoreId": "",
    "uid": "",
    "documentTitle": "",
    "browser": "",
    "processInstanceId": "",
    "tenantId": "",
    "userId": "",
    "positionId": "",
    "currentBureauGuid": ""
  }
}

获取当前委办局的套红模板列表

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/taoHongTemplateList

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前委办局的套红模板列表

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
currentBureauGuid	string	true	委办局id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/taoHongTemplateList?tenantId=&userId=&currentBureauGuid=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	array	操作成功返回的数据	-
└─templateGuid	string	主键	-
└─bureauGuid	string	委办局GUID	-
└─bureauName	string	委办局名称	-
└─templateContent	array	文件内容	-
└─templateFileName	string	文件名	-
└─templateType	string	模板类型	-
└─hasDocumentTemplate	string	No comments found.	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": [
    {
      "templateGuid": "",
      "bureauGuid": "",
      "bureauName": "",
      "templateContent": [],
      "templateFileName": "",
      "templateType": "",
      "hasDocumentTemplate": ""
    }
  ]
}

正文上传

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/uploadWord

Type: POST

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 正文上传

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户id	-
userId	string	true	人员id	-
documentTitle	string	true	文档标题	-
fileType	string	true	文件类型	-
processSerialNumber	string	true	流程编号	-
isTaoHong	string	false	是否套红	-
docCategory	string	false	文档类别	-
taskId	string	false	任务id	-
fileSizeString	string	false	文件大小	-
fileStoreId	string	true	文件id	-

Request-example:

bash

curl -X POST -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/uploadWord

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	boolean	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": true
}

下载正文

URL: https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/wordDownload

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 下载正文

Query-parameters:

Parameter	Type	Required	Description	Since
tenantId	string	true	租户Id	-
id	string	true	正文id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/transactionWord/wordDownload?tenantId=&id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	object	操作成功返回的数据	-
└─id	string	主键	-
└─fileStoreId	string	附件上传ID	-
└─title	string	标题	-
└─fileType	string	文件类型	-
└─fileName	string	包括文件名+后缀	-
└─fileSize	string	文件大小	-
└─userId	string	上传人员id	-
└─userName	string	上传人员名称	-
└─saveDate	string	保存时间	-
└─processSerialNumber	string	流程序号	-
└─processInstanceId	string	流程实例id	-
└─isTaoHong	string	是否套红、1为套红word，0为word	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "id": "",
    "fileStoreId": "",
    "title": "",
    "fileType": "",
    "fileName": "",
    "fileSize": "",
    "userId": "",
    "userName": "",
    "saveDate": "",
    "processSerialNumber": "",
    "processInstanceId": "",
    "isTaoHong": ""
  }
}

正文模板接口

根据id获取正文模板文件路径

URL: https://demo.youshengyun.com/itemAdmin/services/rest/wordTemplate/getFilePathById

Type: GET

Author: qinman,zhangchongjie

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id获取正文模板文件路径

Query-parameters:

Parameter	Type	Required	Description	Since
id	string	true	模板id	-

Request-example:

bash

curl -X GET -k -i https://demo.youshengyun.com/itemAdmin/services/rest/wordTemplate/getFilePathById?id=

Response-fields:

Field	Type	Description	Since
success	boolean	操作是否成功	-
code	int32	错误代码	-
msg	string	操作描述	-
data	string	操作成功返回的数据	-

Response-example:

json

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": ""
}

错误码列表

Error code	Description
0	操作成功
1	服务器内部错误，请联系开发人员
2	参数校验失败
3	对象[{}]不存在
100	令牌未传入
101	令牌已失效
102	校验令牌出问题了
200	权限不足拒绝访问
211	当前用户不是全局系统管理员
212	当前用户不是全局安全保密员
213	当前用户不是全局安全审计员
214	当前用户不是部门系统管理员
215	当前用户不是部门安全保密员
216	当前用户不是部门安全审计员
220	当前用户没有拥有角色[{}]
221	当前岗位没有拥有角色[{}]
222	当前用户不是[{}]
230	当前用户没有被授权资源[{}]
231	当前岗位没有被授权资源[{}]

数据字典

http状态码字典

Code	Type	Description
200	string	ok
400	string	Bad Request
401	string	Unauthorized
403	string	Forbidden
404	string	Not Found
415	string	Unsupported Media Type
500	string	Internal Server Error
502	string	Bad Gateway
503	string	Service Unavailable

事项管理后端接口文档 - itemAdmin ​

流转信息接口 ​

根据流程实例 id 标记流程为办结状态 ​

根据流程编号标记流程为办结状态 ​

根据流程实例和办件状态查找正在办理的流转详细信息 ​

根据流程编号查找正在办理的流转详细信息 ​

根据流程编号和办理人id查找办理的流转信息 ​

根据流程编号查找正在办理的流转详细信息 ​

恢复整个流程的流转信息（通过改变流程是否结束状态恢复） ​

根据流程实例id删除整个流程的办件详情 ​

根据流程编号删除整个流程的办件详情 ​

删除指定办理人的办件详情 ​

保存或者更新流转信息 ​

恢复整个流程的流转信息（通过改变流程是否结束状态恢复） ​

关联流程接口 ​

关联流程数量 ​

批量删除关联流程 ​

删除关联流程 ​

获取关联流程列表（包括未办结件） ​

保存关联流程信息 ​

附件接口 ​

根据流程编号删除附件 ​

删除附件（物理删除，包含具体文件） ​

根据流程编号获取附件数量 ​

根据附件id获取附件信息 ​

根据流程编号、附件来源、文件类型获取附件数量 ​

获取附件分页列表 ​

获取附件列表 ​

获取附件文件信息 ​

保存附件信息 ​

保存或更新附件上传信息 ​

更新附件信息 ​

上传附件 ​

更新附件信息(model) ​

书签绑定接口 ​

根据模板id和流程编号查询模板的书签对应的值 ​

按钮操作接口 ​

加签 ​

减签 ​

直接发送至流程启动人 ​

最后一人拒签退回 ​

重定位 ​

退回操作 ​

发回给上一步的发送人 ​

退回操作，直接退回到办件登记人 ​

特殊办结 ​

收回操作 ​

日历配置接口 ​

获取指定年节假日配置信息 ​

抄送件接口 ​

改变抄送件意见状态 ​

批量设置抄送件状态为已阅 ​

根据抄送ID修改状态为已阅 ​

根据流程实例id统计除当前人外的抄送件数量 ​

根据流程实例id统计当前人抄送件数量 ​

批量删除抄送件 ​

根据流程实例id删除抄送件 ​

抄送件详情 ​

获取批阅件数量（签写过意见的阅件） ​

获取未阅件数量 ​

获取已阅件列表 ​

根据流程实例id获取除当前人外的其他抄送件列表 ​

根据流程实例id获取当前人的抄送件列表 ​

获取批阅件列表 ​

根据岗位id获取已阅件数量 ​

获取未阅件列表 ​

获取我的抄送列表 ​

抄送保存 ​

个人阅件综合搜索列表 ​

获取监控阅件列表 ​

更新抄送件标题 ​

常用语接口 ​

删除常用语 ​

获取常用语列表 ​

根据排序号tabIndex删除常用语 ​

清空常用语使用次数 ​

根据id保存更新常用语 ​

根据排序号tabIndex保存更新常用语 ​

更新常用语使用次数 ​

定制流程接口 ​

事项管理后端接口文档 - itemAdmin

流转信息接口

根据流程实例 id 标记流程为办结状态

根据流程编号标记流程为办结状态

根据流程实例和办件状态查找正在办理的流转详细信息

根据流程编号查找正在办理的流转详细信息

根据流程编号和办理人id查找办理的流转信息

根据流程编号查找正在办理的流转详细信息

恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

根据流程实例id删除整个流程的办件详情

根据流程编号删除整个流程的办件详情

删除指定办理人的办件详情

保存或者更新流转信息

恢复整个流程的流转信息（通过改变流程是否结束状态恢复）

关联流程接口

关联流程数量

批量删除关联流程

删除关联流程

获取关联流程列表（包括未办结件）

保存关联流程信息

附件接口

根据流程编号删除附件

删除附件（物理删除，包含具体文件）

根据流程编号获取附件数量

根据附件id获取附件信息

根据流程编号、附件来源、文件类型获取附件数量

获取附件分页列表

获取附件列表

获取附件文件信息

保存附件信息

保存或更新附件上传信息

更新附件信息

上传附件

更新附件信息(model)

书签绑定接口

根据模板id和流程编号查询模板的书签对应的值

按钮操作接口

加签

减签

直接发送至流程启动人

最后一人拒签退回

重定位

退回操作

发回给上一步的发送人

退回操作，直接退回到办件登记人

特殊办结

收回操作

日历配置接口

获取指定年节假日配置信息

抄送件接口

改变抄送件意见状态

批量设置抄送件状态为已阅

根据抄送ID修改状态为已阅

根据流程实例id统计除当前人外的抄送件数量

根据流程实例id统计当前人抄送件数量

批量删除抄送件

根据流程实例id删除抄送件

抄送件详情

获取批阅件数量（签写过意见的阅件）

获取未阅件数量

获取已阅件列表

根据流程实例id获取除当前人外的其他抄送件列表

根据流程实例id获取当前人的抄送件列表

获取批阅件列表

根据岗位id获取已阅件数量

获取未阅件列表

获取我的抄送列表

抄送保存

个人阅件综合搜索列表

获取监控阅件列表

更新抄送件标题

常用语接口

删除常用语

获取常用语列表

根据排序号tabIndex删除常用语

清空常用语使用次数

根据id保存更新常用语

根据排序号tabIndex保存更新常用语

更新常用语使用次数

定制流程接口