通用OpenAPI接口说明

1.通讯录OpenAPI接口说明

1.1. 部门接口

1.1.1 根据部门ID获取指定部门

功能描述

根据部门ID取指定部门

请求说明

请求方式：GET 请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/{departmentId}

请求参数

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

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "name": ""
         "parentId": ""
         "parentName": ""
         "fullName": ""
      }
}

返回参数说明

以部门数据结构说明为准

1.1.2 获取指定部门的子级部门列表

功能描述

获取指定部门的子级部门列表

请求说明

请求方式：GET 请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/{departmentId}/children

请求参数

参数	必须	数据类型	说明
departmentId	是	string	部门id
recursion	是	boolean	是否递归查询

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data":  [
    			{
             "id": ""
             "name": ""
             "parentId": ""
             "parentName": ""
             "fullName": ""
      		}
      ]
}

返回参数

以部门数据结构说明说明为准

1.1.3 获取直属上级部门

功能描述

获取直属上级部门

请求说明

请求方式：GET 请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/{departmentId}/parent

请求参数

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

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "name": ""
         "parentId": ""
         "parentName": ""
         "fullName": ""
      }
}

返回参数

以部门数据结构说明说明为准

1.1.4 获取根部门信息

功能描述

获取该租户下的根部门信息

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/root

请求参数

无

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": [
    {
      "fullName": "设计",
      "id": "4381bb13feb94df5a59a0ea046519ee8",
      "name": "设计",
      "parentId": "",
      "parentName": "设计"
    }
  ]
}

返回参数

以部门数据结构说明说明为准

1.1.5 根据部门ID批量获取部门列表

功能描述

根据部门ID获取批量部门列表

请求说明

请求方式：GET 请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/list (opens new window)

请求参数

参数	必须	数据类型	说明
departmentIds	是	Array	部门id

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": [
    {
      "fullName": "设计",
      "id": "4381bb13feb94df5a59a0ea046519ee8",
      "name": "设计",
      "parentId": "",
      "parentName": "设计"
    }
  ]
}

返回参数

以部门数据结构说明说明为准

1.1.6 根据企业微信部门ID批量获取部门列表

功能描述

根据企业微信部门ID获取批量部门列表

请求说明

请求方式：GET 请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/departments/list/by_qwids (opens new window)

请求参数

参数	必须	数据类型	说明
qwDeptIds	是	Array	部门id

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": [
    {
      "fullName": "设计",
      "id": "4381bb13feb94df5a59a0ea046519ee8",
      "name": "设计",
      "parentId": "",
      "parentName": "设计",
      "qwId": ""
    }
  ]
}

返回参数

以部门数据结构说明说明为准

部门数据结构说明

字段	字段类型	字段说明
id	string	部门ID
name	string	部门名称
parentId	string	父级部门ID
parentName	string	父级部门名称
fullName	string	部门挂靠全称

1.2. 用户信息接口

1.2.1 根据账号名获取用户

功能描述

根据账号名获取用户

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/users/account

请求参数

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

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "account":""
         "name": ""
         "gender": 1
         "telephone": ""
         "defaultDepartmentId": ""
         "defaultDepartmentName": ""
         "departmentIds": []
      }
}

返回参数

以用户数据结构说明为准

1.2.2 根据用户ID获取用户

功能描述

根据用户ID获取用户

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/users/{userId}

请求参数

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

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": 
      {  
         "id": ""
         "account":""
         "name": ""
         "gender": 1
         "telephone": ""
         "defaultDepartmentId": ""
         "defaultDepartmentName": ""
         "departmentIds": []
      }
}

返回参数

以用户数据结构说明为准

1.2.3 根据用户ID批量获取用户

功能描述

根据用户ID批量获取用户

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/users/list

请求参数

参数	必须	数据类型	说明
userIds	是	Array	用户ID集合

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data": [
      {  
         "id": ""
         "account":""
         "name": ""
         "gender": 1
         "telephone": ""
         "defaultDepartmentId": ""
         "defaultDepartmentName": ""
         "departmentIds": []
      }
    ]
}

返回参数

以用户数据结构说明为准

1.2.4 根据部门ID获取用户集合(分页)

功能描述

根据部门ID获取用户集合(分页)

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/users

请求参数

参数	必须	数据类型	说明
departmentId	是	string	部门ID
page	是	Integer	页码
pageSize	是	Integer	每页数据条数

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data":  {  
         "currPage": 0,
         "list": [
          {
            "id": ""
            "account":""
            "name": ""
            "gender": 1
            "telephone": ""
            "defaultDepartmentId": ""
            "defaultDepartmentName": ""
            "departmentIds": []
      			}
    			],
        "pageSize": 10,
        "totalCount": 1,
        "totalPage": 1
      }
}

返回参数

以用户数据结构说明为准

1.2.5 根据关键字获取用户集合(分页)

功能描述

根据关键字获取用户集合(分页)

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/users/search

请求参数

参数	必须	数据类型	说明
keyword	是	string	关键字(模糊查询)
isResigned	否	boolean	是否包含离职人员(默认包含)
page	否	Integer	当前页码(默认1，即默认第一页)
pageSize	否	Integer	每页数据条数(默认10, 最大1000)

返回结果

{
  "msg": "执行成功",
  "code": 0,
  "data":  {  
         "currPage": 0,
         "list": [
          {
            "id": ""
            "account":""
            "name": ""
            "gender": 1
            "telephone": ""
            "defaultDepartmentId": ""
            "defaultDepartmentName": ""
            "departmentIds": []
      			}
    			],
        "pageSize": 10,
        "totalCount": 1,
        "totalPage": 1
      }
}

返回参数

以用户数据结构说明为准

用户数据结构说明

字段	字段类型	字段说明
id	string	主键ID
name	string	名称
account	string	账号
gender	int	性别
telephone	string	手机号码
defaultDepartmentId	string	默认部门ID
defaultDepartmentName	string	默认部门名称
departmentIds	list	用户所在所有部门Id

2.通用流程OpenAPI接口说明

2.1.流程实例

2.1.1 查询指定用户的待办任务实例集合

功能描述

查询指定用户的待办任务实例集合（应用id非必须，可直接查询所有应用）

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/general/portal/process_instances/task_instances/todos

请求参数

参数	必须	数据类型	说明
userId	是	string	相关用户id
applicationId	否	string	相关应用id
page	否	int	当前页(默认为0)
pageSize	否	int	显示条数(默认为10)
order	否	string	排序类型, 固定参数:RECENT(最近排序) |
EARLIEST(最早排序)

返回结果

{
  "msg": "执行成功",
     "code": 0,
    "data": {
        "currPage": 1,
        "list": [ 
          {
                "applicationId": "60b882a10cf2a********",
                "applicationLogo": "",
                "applicationMainColor": "",
                "applicationName": "测试",
                "approving": false,
                "batchApprove": false,
                "createTime": 16388888888,
                "currentApprovers": "",
                "endTime": null,
                "formModelCode": "",
                "forwardStatus": "0",
                "id": "601591*********",
                "initiator": "测试",
                "initiatorId": "b2c26e0438a65476****************",
                "myMark": true,
                "nodeId": "obj_03",
                "nodeName": "",
                "processDefinitionId": "61ad7c1bfab8****************",
                "processInstanceId": "6015917398****************",
                "processModelId": "61ad7c08fab****************",
                "processName": "人员部门测试",
                "processStatus": "PROCESSING",
                "reason": "",
                "recTime": 1638759841212,
                "requestPathParams": "{\"processInstanceId\":\"601591739830********\",\"applicationId\":\"60b882a10cf2a********\",\"taskId\":\"60b882a10cf2a********\"}",
                "scope": "TODO",
                "state": "人工任务",
                "taskId": "60b882a10cf2a********",
                "title": "人员部门测试_2021120611",
                "type": "userTask",
                "updateTime": null,
                "userId": "60b882a10cf2a****************"
            }
        ],
        "pageSize": 10,
        "totalCount": 193,
        "totalPage": 20
    }
}

返回参数

以流程实例数据结构说明为准

2.1.2 查询指定用户的已办任务实例集合

功能描述

查询指定用户的已办任务实例集合（应用id非必须，可直接查询所有应用）

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/general/portal/process_instances/task_instances/have_dones (opens new window)

请求参数

参数	必须	数据类型	说明
userId	是	string	相关用户id
applicationId	否	string	相关应用id
page	否	int	当前页(默认为0)
pageSize	否	int	显示条数(默认为10)
order	否	string	排序类型, 固定参数:RECENT(最近排序)|
EARLIEST(最早排序)

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "6171195b2b5****************",
                "applicationName": "测试",
                "createTime": 1640066148000,
                "currentApproves": "",
                "endTime": 1640066164995,
                "id": "606080238****************",
                "initiator": "测试",
                "initiatorId": "b2c26e0438a65****************",
                "myMark": false,
                "nodeId": "obj_03",
                "nodeName": "",
                "processDefinitionId": "61a724be117****************",
                "processInstanceId": "606080176****************",
                "processModelId": "61a724ad117f68****************",
                "processName": "测试",
                "recTime": 1640066164995,
                "scope": 2,
                "taskId": "606080179****************",
                "title": "测试_2021122113",
                "type": "userTask",
                "userId": "b2c26e0438a65****************"
            }
        ],
        "pageSize": 1,
        "totalCount": 1180,
        "totalPage": 1180
    }
}

返回参数

以流程实例数据结构说明为准

2.1.3 查询指定用户我的发起实例集合

功能描述

查询指定用户我的发起实例集合（应用id非必须，可直接查询所有应用）

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/general/portal/process_instances/task_instances/initiates (opens new window)

请求参数

参数	必须	数据类型	说明
userId	是	string	相关用户id
applicationId	否	string	相关应用id
page	否	int	当前页(默认为0)
pageSize	否	int	显示条数(默认为10)
order	否	string	排序类型, 固定参数:RECENT(最近排序)|
EARLIEST(最早排序)

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "applicationId": "6171195b2b57f4****************",
                "applicationName": "测试",
                "createTime": 1640066148000,
                "currentApproves": "b2c26e0438a6547****************",
                "endTime": null,
                "id": "60608017****************",
                "initiator": "测试",
                "initiatorId": "b2c26e0438a6547****************",
                "myMark": false,
                "nodeId": "",
                "nodeName": "",
                "processDefinitionId": "61a724b****************",
                "processInstanceId": "60608017****************",
                "processModelId": "61a724ad1****************",
                "processName": "测试",
                "scope": 3,
                "taskId": "",
                "title": "测试_2021122113",
                "updateTime": 1640066147970,
                "userId": "b2c26e0438a6547****************"
            }
        ],
        "pageSize": 1,
        "totalCount": 871,
        "totalPage": 871
    }
}

返回参数

以流程实例数据结构说明为准

2.2 流程实例数据结构说明

2.2.1 共有参数说明

字段	字段类型	字段说明
id	string	流程任务ID
applicationId	string	应用Id
applicationName	string	applicationName
taskId	string	任务Id
title	string	标题
processInstanceId	string	流程实例Id
processName	string	流程名称
nodeName	string	节点名称
processDefinitionId	string	流程定义Id
processModelId	string	流程模型Id
scope	int	流程任务类型(待办-1, 已办-2, 发起人-3)
nodeId	string	节点Id
initiatorId	string	发起人Id
initiator	string	发起人
endTime	long	完成时间
createTime	long	创建时间
userId	string	用户id

2.2.2 待办实例参数说明

字段	字段类型	字段说明
type	string	待办类型
recTime	long	接受时间
myMark	boolean	是否标记
forwardStatus	string	转交状态（0-未转交；1-正在转交中；2-转交失败）

2.2.3 已办实例参数说明

字段	字段类型	字段说明
type	string	待办类型
recTime	long	接受时间
myMark	boolean	是否标记
currentApproves	string	当前处理人

2.2.4 已办实例参数说明

字段	字段类型	字段说明
updateTime	long	更新时间
myMark	boolean	是否标记
currentApproves	string	当前处理人

3. 通用应用OpenAPI说明

3.1 应用相关

3.1.1 获取租户下应用集合

功能描述

获取当前租户下应用集合

请求说明

请求方式：GET

请求URL ：http://qiqiao.hbrhdl.com/plus/cgi-bin/open/applications (opens new window)

请求参数

参数	必须	数据类型	说明
page	是	int	当前页
pageSize	是	int	显示条数

返回结果

{
    "msg": "执行成功",
    "traceId": null,
    "code": 0,
    "data": {
        "currPage": 1,
        "list": [
            {
                "createTime": 1640058797496,
                "createUserId": "8620e9*********************",
                "id": "b28f396e0*********************",",
                "name": "测试应用",
                "updateTime": 1640058797496
            }
        ],
        "pageSize": 1,
        "totalCount": 254,
        "totalPage": 254
    }
}

3.2 返回参数说明

字段	字段类型	字段说明
id	string	应用Id
name	string	应用名称
createUserId	string	创建人id
createTime	long	创建时间时间戳 1560742691863
updateTime	long	更新时间时间戳 1560742691863