查询待办任务
获取待办任务
请求说明
| 请求地址 | https://openapi.wps.cn/v7/todo/tasks/{task_id} |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1 |
| 权限要求 | 查询和管理待办任务(应用授权) kso.task.readwrite查询待办任务(应用授权) kso.task.read |
请求头(Header)
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用:application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
| X-Kso-Id-Type | string | 否 | ID 类型,可选值为 internal 或 external,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id |
路径参数(Path)
| 名称 | 参数类型 | 说明 |
|---|---|---|
| task_id | string | 待办任务 id |
请求地址示例
[GET] https://openapi.wps.cn/v7/todo/tasks/{task_id}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ actions | array[object] | 操作行为 |
| ∟ ∟ key | string | 回调 key |
| ∟ ∟ link | object | 跳转 url |
| ∟ ∟ ∟ mobile_url | string | 移动端跳转链接 |
| ∟ ∟ ∟ pc_url | string | pc 跳转链接 |
| ∟ ∟ modal | object | 弹窗设置 |
| ∟ ∟ ∟ desc | string | 弹窗提示文本 |
| ∟ ∟ ∟ title | string | 弹窗标题 |
| ∟ ∟ ∟ required | boolean | 必须填写原因 |
| ∟ ∟ style | string[enum] | 按钮样式normal:普通样式;secondary:辅助样式;disable:禁用样式 |
| ∟ ∟ text | string | 按钮文本 |
| ∟ category_id | string | 待办分类 id |
| ∟ create_time | integer | 创建时间(单位:毫秒) |
| ∟ creator | string | 创建者 |
| ∟ description | string | 待办描述 |
| ∟ display_time | integer | 展示时间(预留,单位:毫秒) |
| ∟ due_time | integer | 截止时间(单位:毫秒) |
| ∟ executor | string | 执行人 |
| ∟ ext_attrs | array[object] | 预留扩展字段 |
| ∟ ∟ name | string | 属性名 |
| ∟ ∟ value | string | 属性值 |
| ∟ finish_time | integer | 完成时间(单位:毫秒) |
| ∟ id | string | 待办任务 id |
| ∟ link | object | 待办任务跳转链接 |
| ∟ ∟ mobile_url | string | 移动端跳转链接 |
| ∟ ∟ pc_url | string | pc 跳转链接 |
| ∟ notify_config | object | 提醒设置 |
| ∟ ∟ reminders | array[object] | 推送人设置 |
| ∟ ∟ ∟ before_due_time | integer | 提前推送时间(单位:分) |
| ∟ ∟ switch | boolean | 推送开关(默认开) |
| ∟ priority | integer | 优先级 id |
| ∟ start_time | integer | 开始时间(单位:毫秒) |
| ∟ status | string[enum] | 待办状态 todo:未完成;finish:已完成 |
| ∟ tags | array[string] | 标签 |
| ∟ title | object | 待办标题 |
| ∟ ∟ prefix | string | 前缀 |
| ∟ ∟ subject | string | 主题 |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"actions": [
{
"key": "string",
"link": {
"mobile_url": "string",
"pc_url": "string"
},
"modal": {
"desc": "string",
"title": "string",
"required": false
},
"style": "string[enum]",
"text": "string"
}
],
"category_id": "string",
"create_time": 0,
"creator": "string",
"description": "string",
"display_time": 0,
"due_time": 0,
"executor": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"finish_time": 0,
"id": "string",
"link": {
"mobile_url": "string",
"pc_url": "string"
},
"notify_config": {
"reminders": [
{
"before_due_time": 0
}
],
"switch": false
},
"priority": 0,
"start_time": 0,
"status": "string[enum]",
"tags": [
"string"
],
"title": {
"prefix": "string",
"subject": "string"
}
},
"msg": "string"
}