更新待办任务
适用版本>=v7.0.2411b.20241128
接口说明:更新待办任务
请求说明
| 请求地址 | 配置域名+/openapi+/v7/todo/tasks/{task_id}/update |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 管理待办信息(应用授权) kso.task.readwrite |
请求头(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 | 否 | <= 1024 characters.task_id |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| actions | object[] | 否 | <= 1024 items,操作行为 |
| ∟ key | string | 否 | <= 1024 items,回调key |
| ∟ link | object | 否 | 跳转url |
| ∟ ∟ mobile_url | string | 是 | <= 3000 characters,移动端跳转链接 |
| ∟ ∟ pc_url | string | 是 | <= 3000 characters,pc跳转链接 |
| ∟ modal | object | 否 | 弹窗设置 |
| ∟ ∟ desc | string | 是 | <= 1024 characters,弹窗提示文本 |
| ∟ ∟ title | string | 是 | <= 1024 characters,弹窗标题 |
| ∟ ∟ required | bool | 否 | 是否必须填写理由 |
| ∟ style | string | 否 | Enum: "normal" "secondary" "disable",按钮样式 |
| ∟ text | string | 是 | <= 1024 characters,按钮文本 |
| category_id | string | 否 | <= 1024 items,待办分类id |
| description | string | 否 | [ 1 .. 500 ] characters,待办描述 |
| display_time | integer | 否 | 展示时间(预留,单位:毫秒) |
| due_time | integer | 否 | 截止时间(单位:毫秒) |
| ext_attrs | object[] | 否 | <= 1024 items,预留扩展字段 |
| finish_time | integer | 否 | 完成时间(单位:毫秒) |
| is_read | bool | 否 | 是否已读 |
| link | object | 否 | 跳转url |
| ∟ mobile_url | string | 是 | <= 3000 characters,移动端跳转链接 |
| ∟ pc_url | string | 是 | <= 3000 characters,pc跳转链接 |
| notify_config | object | 否 | 提醒设置 |
| ∟ reminders | object[] | 否 | <= 1024 items,推送人设置 |
| ∟ ∟ before_due_time | integer | 否 | 截止前(单位:分钟) |
| ∟ switch | bool | 否 | <= 1000 characters,推送开关(默认开) |
| priority | integer | 否 | 优先级id |
| status | string | 否 | Enum: "todo" "finish",待办状态 |
| tags | string[] | 否 | <= 1024 items [ items <= 1024 characters ] |
| title | object | 否 | 待办标题 |
| ∟ prefix | string | 否 | <= 20 characters,前缀 |
| ∟ subject | string | 是 | <= 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)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| more | object | 更多的错误信息 |
| msg | string | msg |
响应体示例
json
{
"code": 0,
"more": {},
"msg": "string"
}