Skip to content

更新待办任务

适用版本>=v7.0.2411b.20241128

接口说明:更新待办任务

请求说明

请求地址配置域名+/openapi+/v7/todo/tasks/{task_id}/update
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求管理待办信息(应用授权) kso.task.readwrite

请求头(Header)

Header参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

路径参数(Path)

名称类型是否必填说明
task_idstring<= 1024 characters.task_id

请求体(Body)

名称类型是否必填说明
actionsobject[]<= 1024 items,操作行为
keystring<= 1024 items,回调key
linkobject跳转url
mobile_urlstring<= 3000 characters,移动端跳转链接
pc_urlstring<= 3000 characters,pc跳转链接
modalobject弹窗设置
descstring<= 1024 characters,弹窗提示文本
titlestring<= 1024 characters,弹窗标题
requiredbool是否必须填写理由
stylestringEnum: "normal" "secondary" "disable",按钮样式
textstring<= 1024 characters,按钮文本
category_idstring<= 1024 items,待办分类id
descriptionstring[ 1 .. 500 ] characters,待办描述
display_timeinteger展示时间(预留,单位:毫秒)
due_timeinteger截止时间(单位:毫秒)
ext_attrsobject[]<= 1024 items,预留扩展字段
finish_timeinteger完成时间(单位:毫秒)
is_readbool是否已读
linkobject跳转url
mobile_urlstring<= 3000 characters,移动端跳转链接
pc_urlstring<= 3000 characters,pc跳转链接
notify_configobject提醒设置
remindersobject[]<= 1024 items,推送人设置
before_due_timeinteger截止前(单位:分钟)
switchbool<= 1000 characters,推送开关(默认开)
priorityinteger优先级id
statusstringEnum: "todo" "finish",待办状态
tagsstring[]<= 1024 items [ items <= 1024 characters ]
titleobject待办标题
prefixstring<= 20 characters,前缀
subjectstring<= 200 characters,主题

请求体示例

json
{
  "actions": [
    {
      "key": "string",
      "link": {
        "mobile_url": "string",
        "pc_url": "string"
      },
      "modal": {
        "desc": "string",
        "title": "string"
      },
      "style": {},
      "text": "string"
    }
  ],
  "category_id": "string",
  "description": "string",
  "display_time": 0,
  "due_time": 0,
  "ext_attrs": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "finish_time": 0,
  "is_read": true,
  "link": {
    "mobile_url": "string",
    "pc_url": "string"
  },
  "notify_config": {
    "reminders": [
      {
        "before_due_time": 0
      }
    ],
    "switch": true
  },
  "priority": 0,
  "status": {},
  "tags": ["string"],
  "title": {
    "prefix": "string",
    "subject": "string"
  }
}

响应体(Response)

名称类型说明
codeintegercode
moreobject更多的错误信息
msgstringmsg

响应体示例

json
{
  "code": 0,
  "more": {},
  "msg": "string"
}