# 更新任务

用于对工作流任务进行编辑

注意事项:

  • 更新后任务的执行、参与人需要有该工作流的查看权限,否则将会更新失败。
  • 路径参数user_id和查询参数user_id_type需要匹配,否则提示“用户不存在”

# 请求

基本
HTTP URL https://hi-qa.weizhipin.com/open-apis/workflow/v1/task/update/:task_id
HTTP Method POST
支持的应用类型 自建应用
权限要求开启任一权限即可 [工作流]-[创建/编辑/查询任务]

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)

名称 类型 描述
task_id string 任务id

# 查询参数(url后?&拼接的参数)

名称 类型 描述
user_id_type string 请求参数内用户 ID 类型示例值:"open_id"
可选值有:
open_id:用户的 open id
union_id:用户的 union id
user_id:用户的 user id
默认值:open_id
当值为 user_id时,存在字段权限要求,未开通则会调用失败:
请参见[应用权限管理]-[通讯录]- [获取用户ID]

# 请求体

名称 类型 必填 描述
uuid string 由开发者生成的唯一字符串序列,用于发送消息请求去重;持有相同uuid的请求1小时内至多成功执行一次,示例值:"a0d69e201dd1-458b-k525-dfeca4015204" 数据校验规则: 最大长度:50 字符
update_strategy int 更新策略 1、全量更新:所有字段将会被覆盖,若有字段不填时将会被清空;2、部分更新:仅传入的字段会进行更新,其余字段保持不变
update_user_type int 更新操作者用户类型 1系统 2用户 当前只支持用户维度
update_user_id string 更新操作者用户id update_user_type值为2时必填,需要有编辑任务的权限,否则将会更新失败
workflow_id string 工作流id 若不填视为将任务更新无工作流的任务
workflow_group_id string 工作流任务分组id 需要同时传工作流id,若不填视为将任务更新无工作流的任务
task_title string 任务标题 至多1000字
task_description string 任务描述 至多1000字
task_tag array 任务标签 可传入多个值,英文逗号分隔,若标签不存在则会被创建
executor string 任务执行人用户id,需要与查询参数中的user_id_type类型保持一致
begin_date string 任务开始日期 示例值 2023-06-01 11:22,可以不带时分传入
end_date string 任务截止日期 示例值 2023-06-01 11:22,可以不带时分传入
participant array 参与人用户id列表 数组,可传入多个参与人,需要与查询参数中的user_id_type类型保持一致
img_key string 图片附件,数组,至多可传入9个图片
file_url string 文件附件,数组,至多可传入9个文件
custom_fields_json string 自定义字段json json格式字符串,按照key_value的规范进行传入,若有必填的自定义字段字段未填写时,会更新失败
status int 状态字段,2:完成 3:重置

# 请求体示例

{
    "uuid": "776fe2d2-v51e-8e6i-7036-d016pcp12m0y",
    "update_strategy": 1,
    "update_user_type": 2,
    "update_user_id": "11111118022",
    "workflow_id": "59dcfda1cf29679bhkwffPjxqjXKaKiey8vO6q-1z5LNXTH",
    "workflow_group_id": "099aa425749b578g0EeD_3lyqndLKehe3sqZaqUiz9KJWjH",
    "task_title": "xxx",
    "task_description": "xxx",
    "executor": "11111118022",
    "begin_date": "2023-10-01 11:22",
    "end_date": "2023-11-01 11:22",
    "status": 3
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 响应

# 响应体

{
  "code": "0",
  "traceId": "",
  "data": true,
  "msg": "操作成功"
}
1
2
3
4
5
6

如果响应非成功状态,请对照 错误码文档

最后更新于 : 3/4/2024, 3:29:16 PM