新增待办任务(新)
功能介绍
用于集成WeLink待办,在待办模块展示用户待处理的任务事项入口和用户发起的申请单入口。
接口约束
- 认证方式: access_token,请参考获取access_token
- 权限申请:开发者在调用本接口前,需要到开发者后台申请接口权限,申请流程请参考接口权限申请
调试
您可以在API Explorer中调试该接口。
URL
POST https://open.welink.huaweicloud.com/api/todo/v3/addtask
请求消息
请求头部见表1
表1请求头部
| 参数 | 是否必选 | 参数类型 | 描述(值) |
|---|---|---|---|
| x-wlk-Authorization | 是 | String | access_token |
| Content-Type | 是 | String | application/json |
请求参数见表2
表2请求参数
| 参数 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| taskId | 是 | String | 租户应用任务id |
| taskTitle | 是 | String | 待办任务标题 |
| userId | 是 | String | 待办任务的当前处理人账号 |
| userNameCn | 是 | String | 待办任务的当前处理人中文名字 |
| userNameEn | 是 | String | 待办任务的当前处理人英文名字 |
| detailsUrl | 是 | String | 待办详情查看路径,用于WeLink移动端打开 |
| detailsUrlPc | 否 | String | 待办详情查看路径,用于WeLink PC端拉起本地浏览器(如Chrome)打开。仅支持http,https协议,若不支持浏览器打开,则不用传 |
| appName | 是 | String | 应用名称 |
| applicantUserId | 是 | String | 任务申请人id |
| applicantUserNameCn | 是 | String | 任务申请人中文名字 |
| applicantUserNameEn | 是 | String | 任务申请人英文名字 |
| isMsg | 否 | Int | 是否发送消息通知。传0表示不发送消息,传1表示发送公众号消息,默认为0 |
| isShowApplicantUserName | 否 | Boolean | 是否显示申请人。传true表示展示申请人,传false表示不展示申请人,默认为true |
| applicantId | 是 | String | 申请ID,同一条申请,需同时推送给多人,则该值相同 |
| businessCode | 否 | String | 业务编号,用于待办页面展示,方便用户区分,格式支持字母,数字 |
响应消息
正常返回结果:
{ "code": "0", "message": "新增待办任务成功!", "data": { "taskId": "202008fangiia", "uuid": "374731891993001984", "taskTitle": "周五上午请假", "userId": "zhangsan@dd", "userNameCn":"张三", "userNameEn":"zhangsan", "detailsUrl": "https://welink.example.cn/todo/v1/appList", "detailsUrlPc":"https://open.welink.huaweicloud.com/docs?type=internal", "appName": "请假申请", "lastModifyTime": "2020-08-27 18:00:00", "createTime": "2019-08-27 18:00:00", "tenantId": "8C109D2A76604639BAAA582C75779WDS", "applicantUserId": "lisi@dd", "applicantUserNameCn": "李四", "applicantUserNameEn": "lisi", "isMsg":1, "isShowApplicantUserName":true, "applicantId":"202008fangjia1", "businessCode":"202101111556shenpibianma" } }
请求示例
- 请求参数示例
{ "taskId": "202008fangiia", "taskTitle": "周五上午请假", "userId": "zhangsan@dd", "userNameCn":"张三", "userNameEn":"zhangsan", "detailsUrl": "https://example.com/app/detail/5", "detailsUrlPc":"https://open.welink.huaweicloud.com/docs?type=internal", "appName": "请假", "applicantUserId": "lisi@dd", "applicantUserNameCn": "李四", "applicantUserNameEn": "lisi", "isMsg": 1, "isShowApplicantUserName":true, "applicantId":"202008fangjia1", "businessCode":"202101111556shenpibianma" }
- 请求URL示例
curl -X POST 'https://open.welink.huaweicloud.com/api/todo/v3/addtask' -H 'Accept-Charset: UTF-8' -H 'Content-Type: application/json' -H 'x-wlk-Authorization: access_token' -d '{"请求参数 json格式"}'
返回值
返回参数说明:
| 参数 | 必选 | 参数类型 | 说明 |
|---|---|---|---|
| code | 是 | String | 数据正常返回“0”,如果发生错误,会返回对应的错误码 |
| message | 是 | String | 返回信息,包括接口请求发生错误时的详细信息 |
| data | 否 | Object | 调用成功时表示调用结果,详见data数据结构。 |
data 数据结构
| 参数 | 必选 | 参数类型 | 说明 |
|---|---|---|---|
| taskId | 是 | String | 租户应用任务id |
| uuid | 是 | String | 待办唯一主键 |
| taskTitle | 是 | String | 审批任务标题。 |
| userId | 是 | String | 任务的当前处理人的账号id |
| userNameCn | 是 | String | 任务的当前处理人的中文名字 |
| userNameEn | 是 | String | 任务的当前处理人的英文名字 |
| appName | 是 | String | 应用名称 |
| detailsUrl | 是 | String | 待办详情查看路径,用于WeLink 移动侧打开 |
| detailsUrlPc | 否 | String | 待办详情查看路径,用于WeLink PC侧打开 |
| applicantUserId | 是 | String | 申请人账号id |
| applicantUserNameCn | 是 | String | 申请人中文名字 |
| applicantUserNameEn | 是 | String | 申请人英文名称 |
| tenantId | 是 | String | 租户ID |
| isShowApplicantUserName | 否 | Boolean | 申请人显示标识 |
| isMsg | 否 | Int | 发送消息通知标识 |
| applicantId | 是 | String | 申请ID,同一条申请,推送多人,该值相同 |
| businessCode | 否 | String | 业务编号,用于待办页面展示,方便用户区分 |
错误码
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 55002 | 没有操作权限 |
| 55012 | 认证服务异常 |
| 55014 | token认证失败 |
| 55010 | 待办ID已存在 |
| 55015 | 申请ID已存在 |