Skip to content

更新待办任务

用于通过开发者接口更新待办任务。

请求说明

请求地址配置域名+/o/woa + /api/v1/task_center/developer/tasks/
请求方法PUT
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求更新待办信息(kso.task.write)

请求头

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorizationaccess_token(企业授权获取的token)

路径参数(Path)

名称参数类型是否必填说明
taskidinteger待办ID

请求体(Body)

名称参数类型是否必填说明
prefixstring前缀(最大长度20)
subjectstring标题(最大长度200)
descriptionstring描述(最大长度500)
categoryinteger分类ID
due_timeinteger截止时间(毫秒)
finish_timeinteger完成时间(毫秒)
display_timeinteger展示时间(毫秒)
linkobject跳转链接
∟ pc_urlstringPC跳转链接
∟ app_urlstringAPP跳转链接
statusinteger状态1:未完成2:已完成
readinteger已读状态1:未读2:已读
tags[]string标签KEY
priorityinteger优先级
notify_configobject通知设置
∟ switchbool通知开关(默认开)
∟ reminders[]object提醒设置(最多设置1条提醒)
∟ ∟before_due_timeinteger截止前N分钟提醒
extrastring附加信息(最大长度500)

响应体(Response)

名称类型说明
resultstring更新结果ok: 成功

请求参数示例

{
  "prefix": "【前缀】",
  "subject" : "待办test",
  "description" : "描述内容",
  "category": 1,
  "status": 2, // 2:已完成;1:未完成
  "read": 2, // 2:已读;1:未读
  "due_time" : 1692872880831, // 待办截止时间
  "finish_time" : 1692872880831, // 待办完成时间
  "display_time": 1692872880831, // 预留展示时间
  "link" : {
    "pc_url" : "",
    "app_url" : ""
  },
  "tags": ["10", "11"], // 对应后台filter_key
  "priority" : 20, // 优先级
  "notify_config" : {}, // 提醒设置
  "extra": ""
}

响应体示例

{
  "result": "ok"
}