# 功能简介

积木式页面中的组件的数据，需要通过数据源获取。以下提供多个七巧API接口：

# 积木式页面设计器-数据源API

# 流程API

# 流程中心数据API

# 获取当前用户流程相关数据的总数量

功能描述 获取用户门户流程气泡数统计。

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/bubble-statistics

请求参数

参数	必须	数据类型	说明
userId	否	string	用户id

返回结果

{
    "msg": "执行成功",
    "traceId": xxxx,
    "code": 0,
    "data": {
        "copyToTaskTotal": 18, // 抄送总数
        "draftBoxTaskTotal": 4,// 我的草稿箱总数
        "havedoneTotal": 272, // 已处理总数
        "initiateTaskTotal": 373, // 发起处理中总数
        "markerTotal": 19, // 我的标记总数
        "relevantTotal": 511, // 我的相关总数
        "todoTaskTotal": 394, // 待办总数
        "unreadCopyToTaskTotal": 6 抄送未读数总数
    }
}

返回结果说明

参数	数据类型	说明
copyToTaskTotal	int	抄送总数
draftBoxTaskTotal	int	我的草稿箱总数
havedoneTotal	int	已处理总数
initiateTaskTotal	int	发起处理中总数
markerTotal	int	我的标记总数
relevantTotal	int	我的相关总数
todoTaskTotal	int	待办总数
unreadCopyToTaskTotal	int	抄送未读数总数

# 当前用户的待办数据

功能描述 获取当前用户待办数据。

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/todos

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": x xxx,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "approving": false,
                "batchApprove": false,
                "createTime": 1661331228000,
                "currentApprovers": "",
                "endTime": null,
                "formModelCode": "",
                "forwardStatus": "NO_FORWARD",
                "id": "6851761121474805760",
                "initiator": "张三",
                "initiatorId": "e43f7f7f8432ed1f31e2d76aa",
                "myMark": false,
                "nodeId": "obj_03",
                "nodeName": "",
                "processDefinitionId": "6791327392558161922",
                "processInstanceId": "6791464350475321344",
                "processLabelId": "",
                "processModelId": "6791327392558161921",
                "processName": "流程名称",
                "processStatus": "PROCESSING",
                "reason": "",
                "recTime": 1663086094393,
                "requestPathParams": "{\"processInstanceId\":\"6791464350475321344\",\"applicationId\":\"fa46cf347f25403c8a5ad4a011f3222d\",\"taskId\":\"6791464384835059715\"}",
                "scope": "TODO",
                "state": "人工任务2",
                "taskId": "6791464384835059715",
                "tenantId": "00e673a185b240942fb46c09",
                "title": "张三_2022082416",
                "type": "userTask",
                "updateTime": null,
                "userId": "5a995b1dabb8d05ff74d62f"
            },
          ......
        ],
        "pageSize": 20,
        "totalCount": 12,
        "totalPage": 1
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的抄送数据

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/copy_tos

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": x xxx,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": 1661330699000,
                "currentApprovers": "",
                "endTime": null,
                "formModelCode": "",
                "id": "6851765863118700544",
                "initiator": "张三",
                "initiatorId": "e43f7f7f8432ed1f31e25d10cf6d76aa",
                "myMark": false,
                "nodeId": "obj_03",
                "nodeName": "人工任务2",
                "processDefinitionId": "6791321963719499778",
                "processInstanceId": "6791446208533463040",
                "processLabelId": "",
                "processModelId": "6791321963719499777",
                "processName": "流程名成",
                "processStatus": "PROCESSING",
                "read": false,
                "readTime": null,
                "recTime": 1663086232503,
                "requestPathParams": "{\"sourceId\":\"70607a7c54fe00e55d86465f2652fb25\"}",
                "scope": "COPY_TO",
                "source": "张三",
                "state": "人工任务2",
                "taskId": "6791446208533463046",
                "tenantId": "00e673a185b2401f8856942fb46c09",
                "title": "流程副本_2022082416",
                "updateTime": 1661330761080,
                "userId": "5a995b1dabb8d05cd16794f274d62f"
            },
            ......
        ],
        "pageSize": 20,
        "totalCount": 2,
        "totalPage": 1
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的发起数据

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/initiates

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": x xxx,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": 1669688978000,
                "currentApprovers": "5a995b1dabb8d05cd16794f2ff74d62f",
                "formModelCode": "",
                "id": "7078634522583285760",
                "initiator": "张三",
                "initiatorId": "5a995b1dabb8d05cd16794f2ff74d62f",
                "myMark": false,
                "nodeId": "",
                "nodeName": "",
                "processDefinitionId": "638467836aff8d4e428e468d",
                "processInstanceId": "7078634453863833600",
                "processLabelId": "",
                "processModelId": "638466fc6aff8d4e428e468b",
                "processName": "流程名称",
                "processStatus": "PROCESSING",
                "requestPathParams": "{\"processInstanceId\":\"7078634453863833600\",\"applicationId\":\"fa46cf347f25403c8a5ad4a011f3222d\"}",
                "scope": "INITIATOR",
                "state": "人工任务2",
                "taskId": "",
                "tenantId": "00e673a185b2401f88566c2fb46c09",
                "title": "流程名称_2022112910",
                "updateTime": 1669688978362,
                "userId": "5a995b1dabb8d05cd16792ff74d62f"
            },
            .....
        ],
        "pageSize": 20,
        "totalCount": 10,
        "totalPage": 1
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的已办数据

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/have_done

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": x xxx,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": 1663211679000,
                "currentApprovers": "7d92b2167268bf04add5907b25eab000,d585f92cc05e2344b6cb90d050fa7cde,e43f7f7f8432ed1f31e25d10cf6d76aa",
                "endTime": 1663211687914,
                "formModelCode": "",
                "id": "6856076498456428544",
                "initiator": "张三",
                "initiatorId": "e43f7f7f8432ed1f31e25d10cf6d76aa",
                "myMark": false,
                "nodeId": "obj_03",
                "nodeName": "",
                "processDefinitionId": "6856035988324884482",
                "processInstanceId": "6856076189218889728",
                "processLabelId": "",
                "processModelId": "6856035988324884481",
                "processName": "流程名称",
                "processStatus": "PROCESSING",
                "recTime": 1663211687914,
                "requestPathParams": "{\"processInstanceId\":\"6856076189218889728\",\"applicationId\":\"fa46cf347f25403c8a5ad4a011f3222d\",\"taskId\":\"6856076189218889734\"}",
                "scope": "HAVE_DONE",
                "state": "人工任务2",
                "taskId": "6856076189218889734",
                "tenantId": "00e673a185b2401f88566c942fb46c09",
                "title": "流程名称_2022091511",
                "type": "userTask",
                "updateTime": null,
                "userId": "5a995b1dabb8d05cd16794f2ff74d62f"
            },
            .....
        ],
        "pageSize": 20,
        "totalCount": 7,
        "totalPage": 1
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的标记数据

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/marks

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [],
        "pageSize": 20,
        "totalCount": 0,
        "totalPage": 0
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的相关数据

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/relevant

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": 1661850632725,
                "currentApprovers": "e43f7f7f8432ed1f31e25d10cf6d76aa",
                "formModelCode": "",
                "id": "6809311004743000066",
                "initiator": "张三",
                "initiatorId": "92b23f7d9731ef205f7622a189eb1cb5",
                "myMark": false,
                "nodeName": "",
                "processDefinitionId": "6809302208650027008",
                "processInstanceId": "6809309492915060736",
                "processLabelId": "",
                "processModelId": "630dcb9035bde02ccfe8f220",
                "processName": "流程名称",
                "processStatus": "PROCESSING",
                "requestPathParams": "{\"processInstanceId\":\"6809309492915060736\",\"applicationId\":\"fa46cf347f25403c8a5ad4a011f3222d\"}",
                "scope": "RELEVANT",
                "startTime": 1661850590000,
                "state": "人工任务4",
                "taskId": "",
                "tenantId": "00e673a185b2401f88566c942fb46c09",
                "title": "流程名_2022083017",
                "updateTime": 1661850632725,
                "userId": "5a995b1dabb8d05cd16794f2ff74d62f"
            },
           ......
        ],
        "pageSize": 20,
        "totalCount": 21,
        "totalPage": 2
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 当前用户的草稿箱

请求说明

请求方式：GET

请求URL ：/portal/plugin/process-data/draft_box

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页条数，上限200
criteria	否	string	模糊查询文本(标题名称、流程名称、应用名称、发起人)
order	否	string	排序方式:【RECENT】：最近、【EARLIEST】：最早
startCreateTime	否	string	创建时间的开始范围
endCreateTime	否	string	创建时间的结束范围
applicationIds	否	string	应用id
processModelIds	否	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "d91f55b07f4e4765a3a06bbead866bf6",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": null,
                "currentApprovers": "",
                "formDefinitionId": "a456085685c54e7bb8542276df0ca4b8",
                "formInstanceId": "6791452015329247232",
                "id": "6791452702523998208",
                "initiator": "",
                "initiatorId": "5a995b1dabb8d05cd16794f2ff74d62f",
                "nodeId": "obj_1eicb88",
                "nodeName": "提单人",
                "processDefinitionId": "af55888e3fd44a849f1cc276b535c022",
                "processInstanceId": "",
                "processLabelId": "",
                "processModelId": "ebd9375e282b404296b47f2bbc3f74b8",
                "processName": "流程名称",
                "processStatus": null,
                "requestPathParams": "{\"applicationId\":\"d91f55b07f4e4765a3a06bbead866bf6\"}",
                "scope": "START_PROCESS",
                "state": "",
                "title": "流程名称_20220824",
                "updateTime": 1661330888460,
                "userId": "5a995b1dabb8d05cd794f2ff74d62f"
            },
            ......
        ],
        "pageSize": 20,
        "totalCount": 4,
        "totalPage": 1
    }
}

返回参数

参考：附件=>流程中心数据对象结构说明

# 流程流转数据 API

# 发起流程 API

# 通过document信息发起流程

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processModelId}/start

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id

请求体

{
    "nextNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_03",
            "approvers": [
                "123"
            ]
        }
    ],
     "designatedNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_0yegawo",
            "activityName": "人工任务3",
            "activityType": "userTask",
            "designate": true,
            "designateLimit": false,
            "designateName": "initiatorDesignatedUser",
            "designateType": "USER",
            "approvers": [
                "4564564564646"
            ],
            "success": true
        }
    ]
    "pictureUrl": "",
    "variables": {
        "单行文本1": "110000",
        "单行文本2": "220000",
        "多行文本1": "330000"
    }
}

请求体参数说明

参数	必须	数据类型	说明
nextNodesAndHandlers	否	List	下个节点及处理人
designatedNodesAndHandlers	否	List	指定节点及处理人
variables	是	object	表单信息

参考：附件=>下一个节点处理人对象结构说明、指定节点处理人对象结构说明

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "processModelId":""
         "processDefinitionId": ""
         "processDefinitionKey": ""
         "subject": ""
         "initiator": ""
         "initiatorDeptId": ""
         "startTime": 12324123123
         "endTime": 12324123123
         "updateTime": 12324123123
         "processState": ""
         "existSubProcess": true
         "completed": true
         "suspended":true
         "exception": true
         "overTime": true
         "costTime": 12324123123
         "applicationId": ""
         "processName": ""
         "initiatorName": ""
         "formInstanceId": ""
         "formDefinitionId": ""
         "parentInstanceId": ""
         "parentProcessDefinitionId": ""
         "parentActivityDefinitionId": ""
         "revoked": true
         "returned":true
         "recover":true
         "terminated": true
         "tenantId": ""
         "createTime": 123123
         "createBy": ""
         "updateBy": ""
         "remarks": ""
      }
}

返回参数

参考：附件=>发起流程返回参数对象结构

# 通过docId发起流程

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance//{processModelId}/start/documents/{documentId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id
documentId	是	string	表单实例id

请求体参数

{
    "nextNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_03",
            "approvers": [
                "123"
            ]
        }
    ],
    "designatedNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_0yegawo",
            "activityName": "人工任务3",
            "activityType": "userTask",
            "designate": true,
            "designateLimit": false,
            "designateName": "initiatorDesignatedUser",
            "designateType": "USER",
            "approvers": [
                "4564564564646"
            ],
            "success": true
        }
    ]
}

参数说明

参数	必须	数据类型	说明
nextNodesAndHandlers	否	List	下个节点及处理人
designatedNodesAndHandlers	否	List	指定节点及处理人

参考：附件=>下一个节点处理人对象结构说明、指定节点处理人对象结构说明

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "processModelId":""
         "processDefinitionId": ""
         "processDefinitionKey": ""
         "subject": ""
         "initiator": ""
         "initiatorDeptId": ""
         "startTime": 12324123123
         "endTime": 12324123123
         "updateTime": 12324123123
         "processState": ""
         "existSubProcess": true
         "completed": true
         "suspended":true
         "exception": true
         "overTime": true
         "costTime": 12324123123
         "applicationId": ""
         "processName": ""
         "initiatorName": ""
         "formInstanceId": ""
         "formDefinitionId": ""
         "parentInstanceId": ""
         "parentProcessDefinitionId": ""
         "parentActivityDefinitionId": ""
         "revoked": true
         "returned":true
         "recover":true
         "terminated": true
         "tenantId": ""
         "createTime": 123123
         "createBy": ""
         "updateBy": ""
         "remarks": ""
      }
}

返回结果说明

参考：附件=>发起流程返回参数对象结构

# 完成流程任务审批

# 通过document信息完成流程任务审批

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/tasks/{taskId}/complete

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id
taskId	是	string	流程节点id

请求体参数

{
    "comment": {
        "htmlContent": "<p>同意。</p>",
        "content": "同意。",
        "atUserIds": [],
        "files": [],
        "commentOpinionSource": "办理"
    },
    "nextNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_1lsspyi",
            "approvers": [
                "111111"
            ]
        }
    ],
    "designatedNodesAndHandlers": [
           {
                "activityDefinitionId": "obj_0yegawo",
                "activityName": "人工任务2",
                "activityType": "userTask",
                "designate": true,
                "designateLimit": false,
                "designateName": "specialTaskNodeDesignatedUser",
                "designateType": "USER",
                "approvers": ["1111111111","2222222"],
                "success": true
            },
            {
                "activityDefinitionId": "obj_14xiamq",
                "activityName": "人工任务3",
                "activityType": "userTask",
                "designate": true,
                "designateLimit": false,
                "designateName": "specialTaskNodeDesignatedUser",
                "designateType": "USER",
                "approvers": ["333333","444444"],
                "success": true
            }
    ],
    "pictureUrl": "",
     "variables": {
            "单行文本1": "测试0001",
            "多行文本1": "此次调查0001",
            "单行文本2": ""
        }
}

请求参数说明

参数	必须	数据类型	说明
nextNodesAndHandlers	是	List	下个节点及处理人
designatedNodesAndHandlers	否	List	指定节点及处理人
variables	是	object	表单信息
pictureUrl	否	string	图片地址
comment	是	object	审批意见对象

返回结果

{
    "msg": "执行成功",
    "traceId": "9a3d3bfa8f3cb5026f776a779289691e",
    "code": 0,
    "data": {
        "activityDefinitionId": "obj_03",
        "activityName": "人工任务0002",
        "activityType": "userTask",
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "arrangement": 0,
        "counts": 1,
        "createTime": 1674031518238,
        "executionId": "1615631401664856065",
        "id": "7227843026147598339",
        "processDefinitionId": "63c79a082a25c179a1d5c008",
        "processInstanceId": "7227842991787859968"
    }
}

返回结果说明

参考：附件=>流程审批返回结果对象结构

# 通过docId完成流程任务审批

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/tasks/{taskId}/complete/documents/{documentId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id
taskId	是	string	流程节点id
documentId	是	string	表单实例id

请求体参数

{
    "comment": {
        "htmlContent": "<p>同意。</p>",
        "content": "同意。",
        "atUserIds": [],
        "files": [],
        "commentOpinionSource": "办理"
    },
    "nextNodesAndHandlers": [
        {
            "activityDefinitionId": "obj_1lsspyi",
            "approvers": [
                "be1380b6ba74f8e6b0a1badc53d59fbf"
            ]
        }
    ],
    "designatedNodesAndHandlers": []
}

请求体说明

参数	必须	数据类型	说明
comment	是	object	审批意见对象
nextNodesAndHandlers	否	list	下一个节点处理人
designatedNodesAndHandlers	否	list	指定节点处理人

参考：附件=>下一个节点处理人对象结构说明、指定节点处理人对象结构说明

附件=>流程审批对象结构说明=>审批意见对象

返回结果

{
    "msg": "执行成功",
    "traceId": "f864a5b27837d8955e13e95794aa3dbf",
    "code": 0,
    "data": {
        "activityDefinitionId": "obj_03",
        "activityName": "人工任务0002",
        "activityType": "userTask",
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "arrangement": 0,
        "counts": 1,
        "createTime": 1674032193869,
        "executionId": "1615634236578152450",
        "id": "7227866218970996742",
        "processDefinitionId": "63c79a082a25c179a1d5c008",
        "processInstanceId": "7227866218970996736"
    }
}

返回结果参数

参考：附件=>流程审批返回结果对象结构

# 流程任务驳回

# 通过document信息,完成驳回任务

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/tasks/{taskId}/return

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id
taskId	是	string	流程节点id

请求体参数

{
    "nextNodeId": "obj_02",
    "comment": {
        "htmlContent": "<p>不同意。</p>",
        "content": "不同意。",
        "atUserIds": [],
        "files": [],
        "commentOpinionSource": "驳回"
    },
    "backToPreRejectNode": true,
    "variables": {
            "单行文本1": "777测试000100",
            "多行文本1": "888此次调查000100",
            "单行文本2": "999"
        }
}

参数说明

参数	必须	数据类型	说明
comment	是	string	审批意见
nextNodeId	是	string	回退节点id
backToPreRejectNode	是	boolean	驳回按钮：是否回到驳回前节点
variables	否	object	表单信息

返回结果

{
    "msg": "执行成功",
    "traceId": "c6a348be88e5a229dadd0876aed914bc",
    "code": 0,
    "data": {
        "activityDefinitionId": "obj_02",
        "activityName": "人工任务00001",
        "activityType": "userTask",
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "arrangement": 0,
        "counts": 1,
        "createTime": 1674033743935,
        "executionId": "7227919476565475329",
        "id": "7227919476565475330",
        "processDefinitionId": "63c79a082a25c179a1d5c008",
        "processInstanceId": "7227866218970996736"
    }
}

参考：附件=>流程审批返回结果对象结构

# 通过docId完成,完成驳回任务

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/tasks/{taskId}/return/documents/{documentId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id
taskId	是	string	流程节点id
documentId	是	string	表单实例id

请求体

{
    "nextNodeId": "obj_02",
    "comment": {
        "htmlContent": "<p>不同意。</p>",
        "content": "不同意。",
        "atUserIds": [],
        "files": [],
        "commentOpinionSource": "驳回"
    },
    "backToPreRejectNode": true
}

参数	必须	数据类型	说明
comment	是	string	审批意见
nextNodeId	是	string	回退节点id
backToPreRejectNode	是	boolean	驳回按钮：是否回到驳回前节点

返回结果

{
    "msg": "执行成功",
    "traceId": "9dcbe263d2b69035b1d2c33d5f9f0d1f",
    "code": 0,
    "data": {
        "activityDefinitionId": "obj_02",
        "activityName": "人工任务00001",
        "activityType": "userTask",
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "arrangement": 0,
        "counts": 1,
        "createTime": 1674034027249,
        "executionId": "7227929234731171840",
        "id": "7227929234731171841",
        "processDefinitionId": "63c79a082a25c179a1d5c008",
        "processInstanceId": "7227637864149770240"
    }
}

返回结果参说明

参考：附件=>流程审批返回结果对象结构

# 流程模型数据API

# 通过流程模型id获取当前最新版本的流程定义

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/process-models/{processModelId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id

返回结果

{
    "msg": "执行成功",
    "traceId": "1950b0cf147bbea92380f0ce49317f16",
    "code": 0,
    "data": {
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "applicationName": "",
        "createDate": 1674025480000,
        "id": "63c79a082a25c179a1d5c008",
        "key": "",
        "module": "",
        "name": "测试流程呀",
        "processIcon": "",
        "resourceURL": "",
        "suspended": false,
        "version": 1
    }
}

返回结果参说明

参考：附件=>流程定义返回结果对象结构

# 通过流程定义id获取当前流程定义

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/process-definitions/{processDefinitionId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processDefinitionId	是	string	流程定义id

返回结果

{
    "msg": "执行成功",
    "traceId": "f0cf4d8a140f38c2fa83ee4c8b2aa7da",
    "code": 0,
    "data": {
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "applicationName": "",
        "createDate": 1674025480000,
        "id": "63c79a082a25c179a1d5c008",
        "key": "",
        "module": "",
        "name": "测试流程呀",
        "processIcon": "",
        "resourceURL": "",
        "suspended": false,
        "version": 1
    }
}

返回结果参说明

参考：附件=>流程定义返回结果对象结构

# 流程历史数据 API

# 获取指定流程实例的审批历史

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/comments

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "ee48a7ad5632dcc0229fe4b460c2e7a2",
    "code": 0,
    "data": [
        {
            "activityDefinitionId": "obj_02",
            "activityName": "人工任务00001",
            "activityType": "userTask",
            "comment": "",
            "compareTime": null,
            "createTime": null,
            "deptId": "63511993e0454439b2f143dfd25df973",
            "deptName": "市场部门",
            "id": "",
            "read": false,
            "receiveTime": 1674034027236,
            "taskId": "",
            "type": "processing",
            "userId": "be1380b6ba74f8e6b0a1badc53d59fbf",
            "userName": "郑涛"
        }
    ]
}

返回结果参说明

参考：附件=>流程实例的审批历史返回结果对象结构

# 获取指定用户对指定流程实例的审批记录

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/process-instance/{processInstanceId}/comments/users/{userId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processInstanceId	是	string	流程实例id
userId	是	string	用户id

返回结果

{
    "msg": "执行成功",
    "traceId": "ee48a7ad5632dcc0229fe4b460c2e7a2",
    "code": 0,
    "data": [
        {
            "activityDefinitionId": "obj_02",
            "activityName": "人工任务00001",
            "activityType": "userTask",
            "comment": "",
            "compareTime": null,
            "createTime": null,
            "deptId": "63511993e0454439b2f143dfd25df973",
            "deptName": "市场部门",
            "id": "",
            "read": false,
            "receiveTime": 1674034027236,
            "taskId": "",
            "type": "processing",
            "userId": "be1380b6ba74f8e6b0a1badc53d59fbf",
            "userName": "郑涛"
        }
    ]
}

返回结果参数说明

参考：附件=>流程实例的审批历史返回结果对象结构

# 流程实例数据 API

# 获取指定用户指定流程模型相关的流程实例

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/processes/{processModelId}/process-instance

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id

请求参数

参数	必须	数据类型	说明
userId	否	string	用户id，为空时获取当前用户

返回结果

{
    "msg": "执行成功",
    "traceId": "27e581f1ab920f9f1c5adb65e7b04551",
    "code": 0,
    "data": [
        {
            "applicationId": "63c76c182a25c179a1d5bfc4",
            "completed": false,
            "costTime": 0,
            "createBy": "",
            "createTime": null,
            "endTime": null,
            "exception": false,
            "existSubProcess": false,
            "formDefinitionId": "63c797222a25c179a1d5bffe",
            "formInstanceId": "7227611338431750144",
            "id": "7227637864149770240",
            "initiator": "be1380b6ba74f8e6b0a1badc53d59fbf",
            "initiatorDeptId": "63511993e0454439b2f143dfd25df973",
            "initiatorName": "郑涛",
            "overTime": false,
            "parentActivityDefinitionId": "",
            "parentInstanceId": "",
            "parentProcessDefinitionId": "",
            "processDefinitionId": "63c79a082a25c179a1d5c008",
            "processDefinitionKey": "",
            "processModelId": "63c799db2a25c179a1d5c007",
            "processName": "测试流程呀",
            "processState": "审批中",
            "recovered": false,
            "remarks": "",
            "returned": true,
            "revoked": false,
            "startTime": 1674025548000,
            "subject": "郑涛的测试流程呀_2023011815",
            "suspended": false,
            "tenantId": "d1e5bb5c-a93e-492d-9c4d-12fb07165d0f",
            "terminated": false,
            "updateBy": "",
            "updateTime": 1674034027170
        }
    ]
}

字段	字段类型	字段说明
id	string	流程实例id
processModelId	string	流程模型id
processDefinitionId	string	流程定义id
processDefinitionKey	string	流程定义key
subject	string	主题
initiator	string	创建人id
initiatorDeptId	string	创建人部门id
startTime	DATE	开始时间
endTime	DATE	结束时间
updateTime	DATE	更新时间
processState	string	流程状态
existSubProcess	boolean	是否存在子流程
completed	boolean	是否完成
suspended	boolean	是否暂停
exception	boolean	是否异常
overTime	boolean	是否超时
costTime	long	消耗时间
applicationId	string	应用id
processName	string	流程名称
initiatorName	string	创建人名称
formInstanceId	string	表单id
formDefinitionId	string	表单定义id
parentInstanceId	string	父流程实例id
parentProcessDefinitionId	string	父流程定义id
parentActivityDefinitionId	string	父节点id
revoked	boolean	撤销标识
returned	boolean	回退
recover	boolean	单步回收
terminated	boolean	终止
tenantId	string	租户id
createTime	date	创建时间
createBy	string	创建人
updateBy	string	更新人
remarks	string	备注

# 获取指定用户指定流程模型相关的任务实例

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/processes/{processModelId}/tasks

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id

请求参数

参数	必须	数据类型	说明
userId	否	string	用户id，为空时获取当前用户

返回结果

{
    "msg": "执行成功",
    "traceId": "c3cf7e8a4b409e2b81f52a14657d2aa9",
    "code": 0,
    "data": [
        {
            "activityDefinitionId": "obj_02",
            "activityName": "人工任务00001",
            "activityType": "userTask",
            "applicationId": "63c76c182a25c179a1d5bfc4",
            "arrangement": 0,
            "counts": 1,
            "createTime": 1674033743935,
            "executionId": "7227919476565475329",
            "id": "7227919476565475330",
            "processDefinitionId": "63c79a082a25c179a1d5c008",
            "processInstanceId": "7227866218970996736"
        }
    ]
}

返回参数说明

参考：附件=>流程审批返回结果对象结构

# 通过流程实例id获取流程实例数据

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/processes/{processModelId}/process-instance/{processInstanceId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id
processInstanceId	是	string	流程实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "d86a48c8de64497f259de3af1acebbf2",
    "code": 0,
    "data": {
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "completed": false,
        "costTime": 0,
        "createBy": "",
        "createTime": null,
        "endTime": null,
        "exception": false,
        "existSubProcess": false,
        "formDefinitionId": "63c797222a25c179a1d5bffe",
        "formInstanceId": "7227611338431750144",
        "id": "7227637864149770240",
        "initiator": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "initiatorDeptId": "63511993e0454439b2f143dfd25df973",
        "initiatorName": "郑涛",
        "overTime": false,
        "parentActivityDefinitionId": "",
        "parentInstanceId": "",
        "parentProcessDefinitionId": "",
        "processDefinitionId": "63c79a082a25c179a1d5c008",
        "processDefinitionKey": "",
        "processModelId": "63c799db2a25c179a1d5c007",
        "processName": "测试流程呀",
        "processState": "审批中",
        "recovered": false,
        "remarks": "",
        "returned": true,
        "revoked": false,
        "startTime": 1674025548000,
        "subject": "郑涛的测试流程呀_2023011815",
        "suspended": false,
        "tenantId": "d1e5bb5c-a93e-492d-9c4d-12fb07165d0f",
        "terminated": false,
        "updateBy": "",
        "updateTime": 1674034027170
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	流程实例id
processModelId	string	流程模型id
processDefinitionId	string	流程定义id
processDefinitionKey	string	流程定义key
subject	string	主题
initiator	string	创建人id
initiatorDeptId	string	创建人部门id
startTime	DATE	开始时间
endTime	DATE	结束时间
updateTime	DATE	更新时间
processState	string	流程状态
existSubProcess	boolean	是否存在子流程
completed	boolean	是否完成
suspended	boolean	是否暂停
exception	boolean	是否异常
overTime	boolean	是否超时
costTime	long	消耗时间
applicationId	string	应用id
processName	string	流程名称
initiatorName	string	创建人名称
formInstanceId	string	表单id
formDefinitionId	string	表单定义id
parentInstanceId	string	父流程实例id
parentProcessDefinitionId	string	父流程定义id
parentActivityDefinitionId	string	父节点id
revoked	boolean	撤销标识
returned	boolean	回退
recover	boolean	单步回收
terminated	boolean	终止
tenantId	string	租户id
createTime	date	创建时间
createBy	string	创建人
updateBy	string	更新人
remarks	string	备注

# 通过流程实例id获取流程任务实例数据

请求说明

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/processes/{processModelId}/process-instance/{processInstanceId}/tasks

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
processModelId	是	string	流程模型id
processInstanceId	是	string	流程实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "785d1ca0242ba14afb5470d010b32c89",
    "code": 0,
    "data": [
        {
            "activityDefinitionId": "obj_02",
            "activityName": "人工任务00001",
            "activityType": "userTask",
            "applicationId": "63c76c182a25c179a1d5bfc4",
            "arrangement": 0,
            "counts": 1,
            "createTime": 1674034027249,
            "executionId": "7227929234731171840",
            "id": "7227929234731171841",
            "processDefinitionId": "63c79a082a25c179a1d5c008",
            "processInstanceId": "7227637864149770240"
        }
    ]
}

返回结果参数说明

字段	字段类型	字段说明
id	string	主键ID
processInstanceId	string	流程实例id
activityType	string	节点类型
activityDefinitionId	int	节点定义id
activityName	string	节点名称
createTime	Date	创建时间
applicationId	string	应用id
processDefinitionId	string	流程定义id
counts	int	处理人总数
arrangement	int	任务实例的执行顺序

# 表单数据 API

# 新增表单

请求说明

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求体

{
    "variables": {
        "单行文本1": "9999",
        "多行文本1": "9999",
        "单行文本2": "9999"
    },
    "id": ""
}

请求体参数说明

参数	必须	数据类型	说明
variables	是	object	表单数据对象
id	否	string	表单实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "ee64b30718fdd32e90c21994ffd54882",
    "code": 0,
    "data": {
        "processInstanceId": null,
        "processDefinitionId": null,
        "processCurrentApprovers": null,
        "variables": {
            "多行文本1": "999901",
            "__isDeleted": false,
            "单行文本2": "999901",
            "单行文本1": "999901"
        },
        "processStatus": null,
        "processState": null,
        "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifier": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifierName": "郑涛",
        "version": 1,
        "authorName": "郑涛",
        "dataStaticUrl": null,
        "formDefinitionId": null,
        "id": "7256846012584607744",
        "applicationId": null,
        "lastModifyDate": 1674875616561,
        "taskId": null,
        "createDate": 1674875616561
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	表单实例ID
processInstanceId	string	流程实例id
processDefinitionId	string	流程定义实例id
processCurrentApprovers	string	流程当前处理人id数组
variables	object	表单对象
processStatus	string	流程状态
processState	string	流程节点
author	string	表单实例创建人id
authorName	string	表单实例创建人姓名
lastModifier	string	最后修改人id
lastModifierName	string	最后修改人姓名
version	int	版本号
dataStaticUrl	string	静态文件url
formDefinitionId	string	表单定义id
applicationId	string	应用id
lastModifyDate	DATE	最后修改时间
createDate	DATE	创建时间
taskId	string	流程任务id

# 批量新增表单数据

请求方式：POST

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/batch

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求体

[
    {
        "variables": {
            "单行文本1": "888",
            "多行文本1": "888",
            "单行文本2": "888"
        },
        "id": ""
    },
    {
        "variables": {
            "单行文本1": "999",
            "多行文本1": "999",
            "单行文本2": "999"
        },
        "id": ""
    }
]

请求体参数说明

参数	必须	数据类型	说明
variables	是	object	表单数据对象
id	否	string	表单实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "70dd909d8e8a0e12a155d927353d7df7",
    "code": 0,
    "data": [
        {
            "variables": {
                "多行文本1": "888",
                "单行文本2": "888",
                "单行文本1": "888"
            },
            "id": ""
        },
        {
            "variables": {
                "多行文本1": "999",
                "单行文本2": "999",
                "单行文本1": "999"
            },
            "id": ""
        }
    ]
}

# 通过docId删除指定表单的表单实例数据

请求方式：DELETE

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents/{docId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id
docId	是	string	表单实例id

请求参数

参数	必须	数据类型	说明
isCascadeDel	是	boolean	是否级联删除子表控件数据

返回结果

{
    "msg": "执行成功",
    "traceId": "55e53d3c7ceaa5c137756117999d8580",
    "code": 0,
    "data": true
}

# 通过docId集合删除指定表单的表单实例数据集合

请求方式：DELETE

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求参数

参数	必须	数据类型	说明
isCascadeDel	是	boolean	是否级联删除子表控件数据

请求体

参数	必须	数据类型	说明
docIds	是	list	表单实例id数组

返回结果

{
    "msg": "执行成功",
    "traceId": "c23d81f760ff3eb15e445969a8ba3833",
    "code": 0,
    "data": false
}

# 删除指定表单的全部表单实例数据

请求方式：DELETE

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/all-documents

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求参数

参数	必须	数据类型	说明
formTableId	是	string	表单名

返回结果

{
    "msg": "执行成功",
    "traceId": "4b2b456e443d58beae223d5bb23db1e5",
    "code": 0,
    "data": false
}

# 根据指定条件删除指定表单的表单实例数据

请求方式：DELETE

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents/query/conditions

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求参数

参数	必须	数据类型	说明
formTableId	是	string	表单名

请求体

[
    {
        "fieldName":"单行文本1",
        "logic":"like",
        "value":"123"
    }
]

数组对象

参数	必须	数据类型	说明
fieldName	是	string	字段名称
logic	是	string	查询逻辑
value	是	string	查询值

返回结果

{
    "msg": "执行成功",
    "traceId": "83345556886f5e486c0d8bb1cda37438",
    "code": 0,
    "data": 1
}

# 修改表单

请求方式：PUT

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求体

{
    "variables": {
        "单行文本1": "3339",
        "多行文本1": "3339",
        "单行文本2": "333"
    },
    "id": "7256926311293173762",
    "version": 4
}

参数	必须	数据类型	说明
variables	是	object	表单实例数据
id	是	string	表单实例id
version	是	int	版本号

运行结果

{
    "msg": "执行成功",
    "traceId": "5c54f0af2ecf39e0dbdd522ec4c44225",
    "code": 0,
    "data": {
        "processInstanceId": null,
        "processDefinitionId": null,
        "processCurrentApprovers": null,
        "variables": {
            "多行文本1": "3339",
            "__isDeleted": false,
            "单行文本2": "333",
            "单行文本1": "3339"
        },
        "processStatus": null,
        "processState": null,
        "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifier": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "lastModifierName": "郑涛",
        "version": 5,
        "authorName": "郑涛",
        "dataStaticUrl": null,
        "formDefinitionId": null,
        "id": "7256926311293173762",
        "applicationId": null,
        "lastModifyDate": 1674883198117,
        "taskId": null,
        "createDate": 1674877960000
    }
}

运行结果参数说明：

参考新增表单返回结果参数说明

# 批量修改表单

请求方式：PUT

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/batch

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求体

[
    {
        "variables": {
            "单行文本1": "3339",
            "多行文本1": "3339",
            "单行文本2": "33399999"
        },
        "id": "7256926311293173762",
        "version": 5
    },
    {
        "variables": {
            "单行文本1": "2239",
            "多行文本1": "2239",
            "单行文本2": "22399999"
        },
        "id": "7256926105134743554",
        "version": 2
    }
]

返回结果

{
    "msg": "执行成功",
    "traceId": "09922f80969e8b7321c079f61e554f9b",
    "code": 0,
    "data": [
        {
            "variables": {
                "多行文本1": "3339",
                "单行文本2": "33399999",
                "单行文本1": "3339"
            },
            "id": "7256926311293173762",
            "version": 5
        },
        {
            "variables": {
                "多行文本1": "2239",
                "单行文本2": "22399999",
                "单行文本1": "2239"
            },
            "id": "7256926105134743554",
            "version": 2
        }
    ]
}

# 通过docId获取指定表单的表单实例数据

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents/{docId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id
docId	是	string	表单实例id

返回结果

{
    "msg": "执行成功",
    "traceId": "d465a61e432ea5d5f382c36b5b1c4791",
    "code": 0,
    "data": {
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
        "authorName": "郑涛",
        "createDate": 1674877960000,
        "formDefinitionId": "63c797222a25c179a1d5bffe",
        "id": "7256926311293173762",
        "lastModifierName": "郑涛",
        "lastModifyDate": 1674883876000,
        "prettyValue": {},
        "variables": {
            "多行文本1": "3339",
            "单行文本2": "33399999",
            "单行文本1": "3339"
        },
        "version": 6
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	表单实例ID
applicationId	string	应用id
author	string	表单实例创建人id
authorName	string	表单实例创建人名称
formDefinitionId	string	表单定义id
prettyValue	object	结果集
variables	object	表单实例数据
version	int	版本号
createDate	DATE	创建时间
lastModifierName	string	最后修改人名称
lastModifyDate	DATE	最后修改时间

# 通过docId集合获取指定表单的表单实例数据集合

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求参数

参数	必须	数据类型	说明
docIds	是	string	表单实例id数组
orderField	否	string	排序字段
isAsc	否	boolean	是否为升序

返回结果

{
    "msg": "执行成功",
    "traceId": "30c4763c8d2bcf319c2ffc387f1ba7fa",
    "code": 0,
    "data": [
        {
            "applicationId": "",
            "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
            "authorName": "郑涛",
            "createDate": 1674877960000,
            "formDefinitionId": "",
            "id": "7256926311293173762",
            "lastModifierName": "郑涛",
            "lastModifyDate": 1674883876000,
            "prettyValue": {},
            "variables": {
                "多行文本1": "3339",
                "单行文本2": "33399999",
                "单行文本1": "3339"
            },
            "version": 6
        },
        {
            "applicationId": "",
            "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
            "authorName": "郑涛",
            "createDate": 1674877954000,
            "formDefinitionId": "",
            "id": "7256926105134743554",
            "lastModifierName": "郑涛",
            "lastModifyDate": 1674883876000,
            "prettyValue": {},
            "variables": {
                "多行文本1": "2239",
                "单行文本2": "22399999",
                "单行文本1": "2239"
            },
            "version": 2
        }
    ]
}

返回结果参数说明：

参考通过docId获取指定表单的表单实例

# 查询条件分页获取指定表单的表单实例数据

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/forms/{formModelId}/documents/query/conditions

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
formModelId	是	string	表单模型id

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页记录数，最大为200

请求体

{
    "orderField": "单行文本1",
    "isAsc": false,
    "filterParams": [
        [
            {
                "fieldName": "单行文本1",
                "logic": "like",
                "value": "002"
            },
            {
                "fieldName": "单行文本2",
                "logic": "like",
                "value": "003"
            }
        ],
        [
            {
                "fieldName": "单行文本2",
                "logic": "like",
                "value": "001"
            }
        ]
    ]
}

请求体参数说明

参数	必须	数据类型	说明
orderField	否	string	排序字段
isAsc	否	boolean	是否为升序
filterParams	否	list	筛选条件对象数组，第一层为并集，第二层为交集

筛选条件对象

参数	必须	数据类型	说明
fieldName	否	string	筛选字段
logic	否	string	筛选逻辑
value	否	string	筛选值

返回结果

{
    "msg": "执行成功",
    "traceId": "f368047588751209afdcffea1ea77720",
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "",
                "author": "be1380b6ba74f8e6b0a1badc53d59fbf",
                "authorName": "郑涛",
                "createDate": 1674877947000,
                "formDefinitionId": "",
                "id": "7256925761537359872",
                "lastModifierName": "郑涛",
                "lastModifyDate": 1674877947000,
                "prettyValue": {},
                "variables": {
                    "多行文本1": "1111",
                    "单行文本2": "111",
                    "单行文本1": "1111"
                },
                "version": 1
            }
        ],
        "pageSize": 20,
        "totalCount": 3,
        "totalPage": 1
    }
}

返回结果参数说明：

参考通过docId获取指定表单的表单实例

# 通讯录数据 API

# 用户API

# 分页获取企业下用户

请求方式：GET

请求URL ：/runtime/plugin/users/all

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页记录数，最大为200

返回结果

{
    "msg": "执行成功",
    "traceId": "bf0be1ef205dfc644425dbadd556c1a8",
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "account": "caiwenhao",
                "address": "",
                "birthday": "",
                "certificateNumber": "",
                "certificateType": 1,
                "defaultDepartmentId": "85f6d67fe8b443a291cde36671757c67",
                "defaultDepartmentName": "aaa",
                "departments": [
                    {
                        "deptFullName": "研发三部->aaa",
                        "id": "85f6d67fe8b443a291cde36671757c67",
                        "isVirtual": false,
                        "name": "aaa"
                    }
                ],
                "email": "",
                "entryTime": null,
                "extendAttr": "",
                "gender": 1,
                "headPic": "",
                "id": "1ebe0ce73dfa2cdeba7306a0412cb433",
                "leaveTime": null,
                "name": "蔡文浩（勿删）1",
                "order": 0,
                "position": "啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊",
                "positions": [
                    "啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊"
                ],
                "status": 1,
                "telephone": "13580441862",
                "userGroupIds": [],
                "userNo": "",
                "wxUserId": "caiwenhao"
            }
        ],
        "pageSize": 20,
        "totalCount": 197,
        "totalPage": 10
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	主键ID
name	string	名称
account	string	账号
gender	int	性别
telephone	string	手机号码
defaultDepartmentId	string	默认部门ID
defaultDepartmentName	string	默认部门名称
departments	list	用户所在关联部门数组
address	string	用户地址
birthday	string	出生日期：yyyyMMDD
certificateNumber	string	证件号码
certificateType	int	证件类型
email	string	邮箱
entryTime	string	入职时间：yyyy-MM-dd HH:mm:ss
extendAttr	string	扩展字段
headPic	string	头像
leaveTime	string	离职时间：yyyy-MM-dd HH:mm:ss
order	int	排序
position	string	职位
positions	list	职务数组，多个职务时，默认第一个为主职务
status	int	状态
userGroupIds	list	用户所属分组
userNo	string	员工编号
wxUserId	string	用户微信id

部门对象

字段	字段类型	字段说明
id	string	主键ID
name	string	部门名称
isVirtual	boolean	是否为虚拟部门
deptFullName	string	部门全路径名称

# 分页获取部门下用户

请求方式：GET

请求URL ：/runtime/plugin/users/depts/{deptId}

请求路径参数

参数	必须	数据类型	说明
deptId	是	string	部门id

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页记录数，最大为200
recursion	是	boolean	是否递归获取子部门下面的成员：true-递归获取，false-只获取本部门

返回结果

{
    "msg": "执行成功",
    "traceId": "50e8c7b7217dc9876bb4d07dfee67b4e",
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "account": "caiwenhao",
                "address": "",
                "birthday": "",
                "certificateNumber": "",
                "certificateType": 1,
                "defaultDepartmentId": "85f6d67fe8b443a291cde36671757c67",
                "defaultDepartmentName": "aaa",
                "departments": [
                    {
                        "deptFullName": "研发三部->aaa",
                        "id": "85f6d67fe8b443a291cde36671757c67",
                        "isVirtual": false,
                        "name": "aaa"
                    }
                ],
                "email": "",
                "entryTime": null,
                "extendAttr": "",
                "gender": 1,
                "headPic": "",
                "id": "1ebe0ce73dfa2cdeba7306a0412cb433",
                "leaveTime": null,
                "name": "蔡文浩（勿删）1",
                "order": 0,
                "position": "啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊",
                "positions": [
                    "啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊"
                ],
                "status": 1,
                "telephone": "13580441862",
                "userGroupIds": [],
                "userNo": "",
                "wxUserId": "caiwenhao"
            }
        ],
        "pageSize": 20,
        "totalCount": 5,
        "totalPage": 1
    }
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 分页获取标签下用户

请求方式：GET

请求URL ：/runtime/plugin/users/tags/{tagId}

请求路径参数

参数	必须	数据类型	说明
tagId	是	string	标签id

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	每页记录数，最大为200
recursion	是	boolean	是否递归获取子部门下面的成员：true-递归获取，false-只获取本部门

返回结果

{
    "msg": "执行成功",
    "traceId": "90de72c689bbe7bc4ed7adfc96a5aa1b",
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "account": "liuzhenyu",
                "address": "",
                "birthday": "",
                "certificateNumber": "",
                "certificateType": 1,
                "defaultDepartmentId": "",
                "defaultDepartmentName": "",
                "departments": [],
                "email": "",
                "entryTime": null,
                "extendAttr": "",
                "gender": 2,
                "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
                "id": "17eafd6f5af17171e10c5d541e1235b0",
                "leaveTime": null,
                "name": "产研研发-刘震宇",
                "order": 0,
                "position": "产品专员",
                "positions": [
                    "产品专员"
                ],
                "status": 1,
                "telephone": "18676633796",
                "userGroupIds": [],
                "userNo": "",
                "wxUserId": "liuzhenyu"
            }
        ],
        "pageSize": 20,
        "totalCount": 1,
        "totalPage": 1
    }
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过用户id获取用户

请求方式：GET

请求URL ：/runtime/plugin/users/{userId}

请求路径参数

参数	必须	数据类型	说明
userId	是	string	用户id

返回结果

{
    "msg": "执行成功",
    "traceId": "9bbadf6bdf0b18ead5169ea6098b634a",
    "code": 0,
    "data": {
        "account": "liuzhenyu",
        "address": "",
        "birthday": "",
        "certificateNumber": "",
        "certificateType": 1,
        "defaultDepartmentId": "c6b6c28f5c99455087de1f63699b1815",
        "defaultDepartmentName": "通产部",
        "departments": [
            {
                "deptFullName": "通产部",
                "id": "c6b6c28f5c99455087de1f63699b1815",
                "isVirtual": false,
                "name": "通产部"
            },
            {
                "deptFullName": "新增不同步一级L->不同步二级L",
                "id": "b387940cac9f4c508773d40425591fb9",
                "isVirtual": false,
                "name": "不同步二级L"
            }
        ],
        "email": "",
        "entryTime": null,
        "extendAttr": "",
        "gender": 2,
        "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
        "id": "17eafd6f5af17171e10c5d541e1235b0",
        "leaveTime": null,
        "name": "产研研发-刘震宇",
        "order": 0,
        "position": "产品专员",
        "positions": [
            "产品专员"
        ],
        "status": 1,
        "telephone": "18676633796",
        "userGroupIds": [],
        "userNo": "",
        "wxUserId": "liuzhenyu"
    }
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过用户账号获取用户

请求方式：GET

请求URL ：/runtime/plugin/users/account/{account}

请求路径参数

参数	必须	数据类型	说明
account	是	string	用户账号

返回结果

{
    "msg": "执行成功",
    "traceId": "c0c50c56db52dfd7e6f4936173b0d085",
    "code": 0,
    "data": {
        "account": "liuzhenyu",
        "address": "",
        "birthday": "",
        "certificateNumber": "",
        "certificateType": 1,
        "defaultDepartmentId": "c6b6c28f5c99455087de1f63699b1815",
        "defaultDepartmentName": "通产部",
        "departments": [
            {
                "deptFullName": "通产部",
                "id": "c6b6c28f5c99455087de1f63699b1815",
                "isVirtual": false,
                "name": "通产部"
            },
            {
                "deptFullName": "新增不同步一级L->不同步二级L",
                "id": "b387940cac9f4c508773d40425591fb9",
                "isVirtual": false,
                "name": "不同步二级L"
            }
        ],
        "email": "",
        "entryTime": null,
        "extendAttr": "",
        "gender": 2,
        "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
        "id": "17eafd6f5af17171e10c5d541e1235b0",
        "leaveTime": null,
        "name": "产研研发-刘震宇",
        "order": 0,
        "position": "产品专员",
        "positions": [
            "产品专员"
        ],
        "status": 1,
        "telephone": "18676633796",
        "userGroupIds": [],
        "userNo": "",
        "wxUserId": "liuzhenyu"
    }
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过用户id集合获取用户集合

请求方式：GET

请求URL ：/runtime/plugin/users

请求参数

参数	必须	数据类型	说明
userIds	是	string	用户id数组

返回结果

{
    "msg": "执行成功",
    "traceId": "d080d4e360cf93bd928034363578c590",
    "code": 0,
    "data": [
        {
            "account": "liuzhenyu",
            "address": "",
            "birthday": "",
            "certificateNumber": "",
            "certificateType": 1,
            "defaultDepartmentId": "c6b6c28f5c99455087de1f63699b1815",
            "defaultDepartmentName": "通产部",
            "departments": [
                {
                    "deptFullName": "通产部",
                    "id": "c6b6c28f5c99455087de1f63699b1815",
                    "isVirtual": false,
                    "name": "通产部"
                },
                {
                    "deptFullName": "新增不同步一级L->不同步二级L",
                    "id": "b387940cac9f4c508773d40425591fb9",
                    "isVirtual": false,
                    "name": "不同步二级L"
                }
            ],
            "email": "",
            "entryTime": null,
            "extendAttr": "",
            "gender": 2,
            "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
            "id": "17eafd6f5af17171e10c5d541e1235b0",
            "leaveTime": null,
            "name": "产研研发-刘震宇",
            "order": 0,
            "position": "产品专员",
            "positions": [
                "产品专员"
            ],
            "status": 1,
            "telephone": "18676633796",
            "userGroupIds": [],
            "userNo": "",
            "wxUserId": "liuzhenyu"
        }
    ]
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过用户账号集合获取用户集合

请求方式：GET

请求URL ：/runtime/plugin/users/account

请求参数

参数	必须	数据类型	说明
accounts	是	string	用户账号数组

返回结果

{
    "msg": "执行成功",
    "traceId": "6863599c2fd5ac69af430028ed259058",
    "code": 0,
    "data": [
        {
            "account": "liuzhenyu",
            "address": "",
            "birthday": "",
            "certificateNumber": "",
            "certificateType": 1,
            "defaultDepartmentId": "c6b6c28f5c99455087de1f63699b1815",
            "defaultDepartmentName": "通产部",
            "departments": [
                {
                    "deptFullName": "通产部",
                    "id": "c6b6c28f5c99455087de1f63699b1815",
                    "isVirtual": false,
                    "name": "通产部"
                },
                {
                    "deptFullName": "新增不同步一级L->不同步二级L",
                    "id": "b387940cac9f4c508773d40425591fb9",
                    "isVirtual": false,
                    "name": "不同步二级L"
                }
            ],
            "email": "",
            "entryTime": null,
            "extendAttr": "",
            "gender": 2,
            "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
            "id": "17eafd6f5af17171e10c5d541e1235b0",
            "leaveTime": null,
            "name": "产研研发-刘震宇",
            "order": 0,
            "position": "产品专员",
            "positions": [
                "产品专员"
            ],
            "status": 1,
            "telephone": "18676633796",
            "userGroupIds": [],
            "userNo": "",
            "wxUserId": "liuzhenyu"
        }
    ]
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过用户名称关键字分页获取用户

请求方式：GET

请求URL ：/runtime/plugin/users/keyword

请求参数

参数	必须	数据类型	说明
keyword	是	string	用户名称关键字
containResigned	是	boolean	是否包含离职，默认就是不包含离职的

返回结果

{
    "msg": "执行成功",
    "traceId": "6863599c2fd5ac69af430028ed259058",
    "code": 0,
    "data": [
        {
            "account": "liuzhenyu",
            "address": "",
            "birthday": "",
            "certificateNumber": "",
            "certificateType": 1,
            "defaultDepartmentId": "c6b6c28f5c99455087de1f63699b1815",
            "defaultDepartmentName": "通产部",
            "departments": [
                {
                    "deptFullName": "通产部",
                    "id": "c6b6c28f5c99455087de1f63699b1815",
                    "isVirtual": false,
                    "name": "通产部"
                },
                {
                    "deptFullName": "新增不同步一级L->不同步二级L",
                    "id": "b387940cac9f4c508773d40425591fb9",
                    "isVirtual": false,
                    "name": "不同步二级L"
                }
            ],
            "email": "",
            "entryTime": null,
            "extendAttr": "",
            "gender": 2,
            "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
            "id": "17eafd6f5af17171e10c5d541e1235b0",
            "leaveTime": null,
            "name": "产研研发-刘震宇",
            "order": 0,
            "position": "产品专员",
            "positions": [
                "产品专员"
            ],
            "status": 1,
            "telephone": "18676633796",
            "userGroupIds": [],
            "userNo": "",
            "wxUserId": "liuzhenyu"
        }
    ]
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 通过部门id获取部门主管集合

请求方式：GET

请求URL ：/runtime/plugin/users/depts/{departmentId}/managers

请求参数

参数	必须	数据类型	说明
departmentId	是	string	部门id

返回结果

{
    "msg": "执行成功",
    "traceId": "6863599c2fd5ac69af430028ed259058",
    "code": 0,
    "data": [
        {
            "account": "liuzhenyu",
            "address": "",
            "birthday": "",
            "certificateNumber": "",
            "certificateType": 1,
            "email": "",
            "entryTime": null,
            "extendAttr": "",
            "gender": 2,
            "headPic": "https://qw.qiweioa.cn:62387/cgi-bin/downloadfile?type=download&fileid=WI5719-YP~anY9ihQkuR0Qny1WBFc9&uin=1688849884266698&filename=icon.png/100",
            "id": "17eafd6f5af17171e10c5d541e1235b0",
            "leaveTime": null,
            "name": "产研研发-刘震宇",
            "order": 0,
            "position": "产品专员",
            "positions": [
                "产品专员"
            ],
            "status": 1,
            "telephone": "18676633796",
            "userGroupIds": [],
            "userNo": "",
            "wxUserId": "liuzhenyu"
        }
    ]
}

返回结果参数说明

参考分页获取企业下用户返回结果参数说明

# 标签API

# 通过标签id获取标签

请求方式：GET

请求URL ：/runtime/plugin/tags/{tagId}

请求路径参数

参数	必须	数据类型	说明
tagId	是	string	标签id

返回结果

{
    "msg": "执行成功",
    "traceId": "b421dada3e6de2a728962a1a7a3339f6",
    "code": 0,
    "data": {
        "deptRefs": [],
        "id": "d422fe4fef8f4bdba1ef58a52fc38c39",
        "name": "蒙千慧1",
        "personRefs": []
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	主键ID
name	string	标签名称
deptRefs	list	标签部门列表
personRefs	list	标签人员列表

# 通过标签id集合获取标签集合

请求方式：GET

请求URL ：/runtime/plugin/tags

请求参数

参数	必须	数据类型	说明
tagIds	是	string	标签id数组

返回结果

{
    "msg": "执行成功",
    "traceId": "1facb9464b21e715ec0eed27496f4e47",
    "code": 0,
    "data": [
        {
            "deptRefs": [],
            "id": "d422fe4fef8f4bdba1ef58a52fc38c39",
            "name": "蒙千慧1",
            "personRefs": []
        },
        {
            "deptRefs": [],
            "id": "df7b685295ff45c0a6ccde0ba21e9bc7",
            "name": "测试同步1",
            "personRefs": []
        }
    ]
}

返回结果参数说明

参考通过标签id获取标签的返回结果参数说明

# 通过标签名称关键字分页获取标签信息

请求方式：GET

请求URL ：/runtime/plugin/tags/keyword

请求参数

参数	必须	数据类型	说明
keyword	是	string	标签名称关键字

返回结果

{
    "msg": "执行成功",
    "traceId": "2f0d29b164ef2b6fb0030cfd0076b665",
    "code": 0,
    "data": [
        {
            "deptRefs": [],
            "id": "d422fe4fef8f4bdba1ef58a52fc38c39",
            "name": "蒙千慧1",
            "personRefs": []
        },
        {
            "deptRefs": [],
            "id": "df7b685295ff45c0a6ccde0ba21e9bc7",
            "name": "测试同步1",
            "personRefs": []
        }
    ]
}

返回结果参数说明

参考通过标签id获取标签的返回结果参数说明

# 角色API

# 获取应用下指定角色的子角色列表(树状结构)

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/roles/{roleId}/sub-role

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
roleId	是	string	角色id

请求参数

参数	必须	数据类型	说明
recursion	否	booleam	是否包含子孙角色

返回结果

{
    "msg": "执行成功",
    "traceId": "4758e133b3cf31407f57a16693207fa2",
    "code": 0,
    "data": [
        {
            "admin": false,
            "applicationId": "63c76c182a25c179a1d5bfc4",
            "child": false,
            "children": [],
            "createTime": 1674895019556,
            "createUserId": "04b37b6a0c0b28d8e6374cf9d1d66082",
            "defaultRole": false,
            "delete": false,
            "hiddenCode": "175dbe87b51146ada7f760fc94b17e76",
            "id": "63d4deabf2dbe24f1a687c29",
            "modelCode": "",
            "name": "测试角色",
            "orderBy": 2,
            "parentId": "63c76c182a25c179a1d5bfc5",
            "tenantId": "d1e5bb5c-a93e-492d-9c4d-12fb07165d0f",
            "updateTime": 1674895019556
        }
    ]
}

返回结果参数说明

字段	字段类型	字段说明
id	string	主键ID
name	string	角色名称
applicationId	string	应用id
defaultRole	boolean	是否默认角色
admin	boolean	是否为管理员
orderBy	int	排序
delete	boolean	是否被删除
parentId	string	父角色id
children	list	子角色集合
child	boolean	是否子角色
createTime	DATE	创建时间
createUserId	string	创建人
tenantId	string	租户id

# 通过应用下指定角色id获取角色信息

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/roles/{roleId}

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
roleId	是	string	角色id

返回结果

{
    "msg": "执行成功",
    "traceId": "9c1645d9d6eaedaf5d5a9cc567398381",
    "code": 0,
    "data": {
        "admin": false,
        "applicationId": "63c76c182a25c179a1d5bfc4",
        "child": false,
        "children": [],
        "createTime": 1674895019556,
        "createUserId": "04b37b6a0c0b28d8e6374cf9d1d66082",
        "defaultRole": false,
        "delete": false,
        "hiddenCode": "175dbe87b51146ada7f760fc94b17e76",
        "id": "63d4deabf2dbe24f1a687c29",
        "modelCode": "",
        "name": "测试角色",
        "orderBy": 2,
        "parentId": "63c76c182a25c179a1d5bfc5",
        "tenantId": "d1e5bb5c-a93e-492d-9c4d-12fb07165d0f",
        "updateTime": 1674895019556
    }
}

返回结果参数说明

参考获取应用下指定角色的子角色列表

# 获取应用下指定角色绑定的部门，用户，标签，角色线信息

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/roles/{roleId}/contacts

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
roleId	是	string	角色id

返回结果

{
    "msg": "执行成功",
    "traceId": "aa45d867a9daac60bbabe6c1cd3101a5",
    "code": 0,
    "data": {
        "userIds": [
            "aaa2dbb86d784bbf4ac59014c77aeab2"
        ],
        "tagIds": [
          "1221"
        ],
        "deptIds": [
          "222"
        ],
        "lineIds": [
          "333"
        ]
    }
}

返回结果参数说明

字段	字段类型	字段说明
userIds	list	用户id数组
tagIds	list	标签id数组
deptIds	list	部门id数组
lineIds	list	角色线id数组

# 获取应用下指定角色关联的全部用户信息

请求方式：GET

请求URL ：/runtime/plugin/applications/{applicationId}/roles/{roleId}/users

请求路径参数

参数	必须	数据类型	说明
applicationId	是	string	应用id
roleId	是	string	角色id

返回结果

{
    "msg": "执行成功",
    "traceId": "30f25585197ebfa3a43d9ee97042b95c",
    "code": 0,
    "data": [
        {
            "account": "15622635691",
            "address": "",
            "birthday": "",
            "certificateNumber": "",
            "certificateType": 1,
            "defaultDepartmentId": "bf11d99fb79345cd8359dbe19ddbcf39",
            "defaultDepartmentName": "测试一组",
            "departments": [
                {
                    "deptFullName": "UI自动化(勿动)->自动化测试一部->测试一组",
                    "id": "bf11d99fb79345cd8359dbe19ddbcf39",
                    "isVirtual": false,
                    "name": "测试一组"
                }
            ],
            "email": "",
            "entryTime": null,
            "extendAttr": "",
            "gender": 1,
            "headPic": "",
            "id": "aaa2dbb86d784bbf4ac59014c77aeab2",
            "leaveTime": null,
            "name": "李旭鸣",
            "order": 0,
            "position": "",
            "positions": [
                ""
            ],
            "status": 1,
            "telephone": "15622635691",
            "userGroupIds": [],
            "userNo": "",
            "wxUserId": "15622635691"
        }
    ]
}

返回结果参数说明

参考用户API => 分页获取企业下用户返回结果参数说明

# 部门API

# 通过部门id获取部门

请求方式：GET

请求URL ：/runtime/plugin/depts/{deptId}

请求路径参数

参数	必须	数据类型	说明
deptId	是	string	部门id

返回结果

{
    "msg": "执行成功",
    "traceId": "48314067360a9c2c3a6cdb21252703e3",
    "code": 0,
    "data": {
        "deptFullName": "市场部门",
        "directParentId": "",
        "directParentName": "",
        "display": true,
        "fullPath": "",
        "id": "63511993e0454439b2f143dfd25df973",
        "isVirtual": false,
        "leaders": [
            "4163af457ab24a12789d7ac968e0dab8",
            "35a2b6fb319eecc7de1531cc5850f570"
        ],
        "leaf": false,
        "name": "市场部门",
        "qwId": "4"
    }
}

返回结果参数说明

字段	字段类型	字段说明
id	string	部门id
name	string	部门名称
deptFullName	string	部门全路径名称
fullPath	string	部门id全路径
directParentId	string	直属上级部门id
directParentName	string	直属上级部门名称
leaders	string	部门负责人id列表
leaf	boolean	是否是叶子节点
display	boolean	部门树是否可用
qwId	string	企业微信部门id
isVirtual	boolean	是否为虚拟部门

# 通过部门id集合获取部门集合

请求方式：GET

请求URL ：/runtime/plugin/depts

请求参数

参数	必须	数据类型	说明
deptIds	是	string	部门id数组

返回结果

{
    "msg": "执行成功",
    "traceId": "ba7ec1ca025df29b9f630d0c129066fe",
    "code": 0,
    "data": [
        {
            "deptFullName": "市场部门",
            "directParentId": "",
            "directParentName": "",
            "display": true,
            "fullPath": "",
            "id": "63511993e0454439b2f143dfd25df973",
            "isVirtual": false,
            "leaders": [],
            "leaf": false,
            "name": "市场部门",
            "qwId": "4"
        },
        {
            "deptFullName": "研发三部",
            "directParentId": "",
            "directParentName": "",
            "display": true,
            "fullPath": "",
            "id": "c45e505686ea47989befa5040b0b726f",
            "isVirtual": false,
            "leaders": [],
            "leaf": false,
            "name": "研发三部",
            "qwId": "5"
        }
    ]
}

返回结果参数说明

参考通过部门ID获取部门返回结果参数说明

# 通过部门id获取子部门集合

请求方式：GET

请求URL ：/runtime/plugin/depts/{deptId}/sub-dept

请求路径参数

参数	必须	数据类型	说明
deptId	是	string	部门id

请求参数

参数	必须	数据类型	说明
recursion	是	boolean	是否包含子孙部门

返回结果

{
    "msg": "执行成功",
    "traceId": "a1cd93285dff75b99f63aab6accfa101",
    "code": 0,
    "data": [
        {
            "deptFullName": "研发三部->aaa",
            "directParentId": "c45e505686ea47989befa5040b0b726f",
            "directParentName": "",
            "display": true,
            "fullPath": "",
            "id": "85f6d67fe8b443a291cde36671757c67",
            "isVirtual": false,
            "leaders": [],
            "leaf": true,
            "name": "aaa",
            "qwId": "343"
        }
    ]
}

返回结果参数说明

参考通过部门ID获取部门返回结果参数说明

# 通过部门id获取父部门

请求方式：GET

请求URL ：/runtime/plugin/depts/{deptId}/parent-dept

请求路径参数

参数	必须	数据类型	说明
deptId	是	string	部门id

返回结果

{
    "msg": "执行成功",
    "traceId": "e912eab15c382d087b10ea1adfd46d45",
    "code": 0,
    "data": {
        "deptFullName": "研发三部",
        "directParentId": "",
        "directParentName": "",
        "display": true,
        "fullPath": "",
        "id": "c45e505686ea47989befa5040b0b726f",
        "isVirtual": false,
        "leaders": [],
        "leaf": false,
        "name": "研发三部",
        "qwId": ""
    }
}

返回结果参数说明

参考通过部门ID获取部门返回结果参数说明

# 通过部门名称关键字分页获取部门

请求方式：GET

请求URL ：/runtime/plugin/depts/keyword

请求参数

参数	必须	数据类型	说明
keyword	是	string	部门关键字

返回结果

{
    "msg": "执行成功",
    "traceId": "0e8c007ffe53251ede57c1ffb3725f62",
    "code": 0,
    "data": [
        {
            "deptFullName": "公共支撑部->测试部门",
            "directParentId": "3f3671c6b52b410e96c51a7b11257500",
            "directParentName": "",
            "display": true,
            "fullPath": "",
            "id": "898598ec09674cca958bf9bce1736a45",
            "isVirtual": false,
            "leaders": [],
            "leaf": true,
            "name": "测试部门",
            "qwId": "166"
        }
    ]
}

返回结果参数说明

参考通过部门ID获取部门返回结果参数说明

# 通过标签id获取标签下的部门

请求方式：GET

请求URL ：/runtime/plugin/depts/tags/{tagId}

请求参数

参数	必须	数据类型	说明
tagId	是	string	标签id

返回结果

{
    "msg": "执行成功",
    "traceId": "d34ddb7003a5f00a72ca92afd2988d13",
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
          {
            "deptFullName": "公共支撑部->测试部门",
            "directParentId": "3f3671c6b52b410e96c51a7b11257500",
            "directParentName": "",
            "display": true,
            "fullPath": "",
            "id": "898598ec09674cca958bf9bce1736a45",
            "isVirtual": false,
            "leaders": [],
            "leaf": true,
            "name": "测试部门",
            "qwId": "166"
        }
        ],
        "pageSize": 20,
        "totalCount": 1,
        "totalPage": 1
    }
}

返回结果参数说明

参考通过部门ID获取部门返回结果参数说明

#

# 附件

# 流程中心数据对象结构说明

流程中心数据对象

{
                "applicationId": "fa46cf347f25403c8a5ad4a011f3222d",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "应用名称",
                "createTime": 1661850632725,
                "currentApprovers": "e43f7f7f8432ed1f31e25d10cf6d76aa",
                "formModelCode": "",
                "id": "6809311004743000066",
                "initiator": "张三",
                "initiatorId": "92b23f7d9731ef205f7622a189eb1cb5",
                "myMark": false,
                "nodeName": "",
                "processDefinitionId": "6809302208650027008",
                "processInstanceId": "6809309492915060736",
                "processLabelId": "",
                "processModelId": "630dcb9035bde02ccfe8f220",
                "processName": "流程名称",
                "processStatus": "PROCESSING",
                "requestPathParams": "{\"processInstanceId\":\"6809309492915060736\",\"applicationId\":\"fa46cf347f25403c8a5ad4a011f3222d\"}",
                "scope": "RELEVANT",
                "startTime": 1661850590000,
                "state": "人工任务4",
                "taskId": "",
                "tenantId": "00e673a185b2401f88566c942fb46c09",
                "title": "流程名_2022083017",
                "updateTime": 1661850632725,
                "userId": "5a995b1dabb8d05cd16794f2ff74d62f"
            }

参数说明：

字段	字段类型	字段说明
applicationId	string	应用id
applicationLogo	string	应用logo
applicationMainColor	string	应用颜色
applicationName	string	应用名称
createTime	date	创建时间
currentApprovers	string	当前处理人
formModelCode	string	模型码
id	string	记录id
initiator	string	发起人姓名
initiatorId	string	发起人id
myMark	boolean	是否标记
nodeName	string	节点名称
processDefinitionId	string	流程定义id
processInstanceId	string	流程实例id
processLabelId	string	流程标签id
processModelId	string	流程模型id
processName	string	流程名称
processStatus	string	流程状态
requestPathParams	string	请求参数对象
scope	string	流程入口标识
startTime	date	开始时间
state	string	当前任务节点名称
taskId	string	任务id
tenantId	string	租户id
title	string	流程实例名称
updateTime	date	更新是时间
userId	string	用户id

# 下一个节点处理人对象结构说明

参数	必须	数据类型	说明
activityDefinitionId	是	String	下个节点定义id
approvers	否	list	下个节点处理人列表

# 指定节点处理人对象结构说明

参数	必须	数据类型	说明
activityDefinitionId	是	string	指定节点定义id
activityName	是	string	指定节点名称
activityType	是	string	指定节点类型
designate	是	boolean	指定节点是否允许调整
designateLimit	是	boolean	指定节点调整限制
designateName	是	string	指定节点路由规则名称
designateType	是	string	指定节点路由规则类型
approvers	是	list	指定节点处理人
success	否	boolean	计算指定节点处理人是否成功

# 审批意见对象

参数	必须	数据类型	说明
htmlContent	是	string	评论内容（html文本）
content	否	list	评论内容（纯文本）
atUserIds	否	list	被@用户id
files	否	string	文件信息
commentOpinionSource	是	string	评论意见来源按钮名称

# 发起流程返回参数对象结构

字段	字段类型	字段说明
id	string	流程实例id
processModelId	string	流程模型id
processDefinitionId	string	流程定义id
processDefinitionKey	string	流程定义key
subject	string	主题
initiator	string	创建人id
initiatorDeptId	string	创建人部门id
startTime	DATE	开始时间
endTime	DATE	结束时间
updateTime	DATE	更新时间
processState	string	流程状态
existSubProcess	boolean	是否存在子流程
completed	boolean	是否完成
suspended	boolean	是否暂停
exception	boolean	是否异常
overTime	boolean	是否超时
costTime	long	消耗时间
applicationId	string	应用id
processName	string	流程名称
initiatorName	string	创建人名称
formInstanceId	string	表单id
formDefinitionId	string	表单定义id
parentInstanceId	string	父流程实例id
parentProcessDefinitionId	string	父流程定义id
parentActivityDefinitionId	string	父节点id
revoked	boolean	撤销标识
returned	boolean	回退
recover	boolean	单步回收
terminated	boolean	终止
tenantId	string	租户id
createTime	date	创建时间
createBy	string	创建人
updateBy	string	更新人
remarks	string	备注

# 流程审批返回结果对象结构

字段	字段类型	字段说明
id	string	任务id
applicationId	string	应用id
processInstanceId	string	流程实例id
processDefinitionId	string	流程定义id
activityDefinitionId	string	节点定义id
activityName	string	节点名称
activityType	string	节点类型
arrangement	int	审批次序
counts	int	处理人数量
executionId	string	执行流id
createTime	DATE	创建时间

# 流程定义返回结果对象结构

字段	字段类型	字段说明
id	string	流程定义id
applicationId	string	应用id
applicationName	string	应用名称
key	string	流程定义key
module	string	模块
name	string	流程名称
processIcon	string	节点流程logo
resourceURL	string	返回url
suspended	boolean	流程状态
version	int	版本号
createDate	DATE	创建时间

# 流程实例的审批历史返回结果对象结构

字段	字段类型	字段说明
id	string	历史记录id
taskId	string	任务id
activityName	string	节点名称
activityType	string	节点类型
activityDefinitionId	string	节点定义id
userId	string	用户名称
userName	string	用户名
deptId	string	部门id
deptName	boolean	部门名称
comment	int	评论
createTime	DATE	操作时间
receiveTime	DATE	接收时间
compareTime	DATE	排序对比时间
type	string	类型
read	boolean	是否已阅

1 / 0