# 说明
更新检查清单，返回更新后的数据。完成和重新开启检查清单通过本接口更新 status 完成，无需单独调用工作流接口。
# url
https://api.tapd.cn/check_lists
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
POST
# 请求数限制
每次只允许更新一条数据
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| id | 是 | integer | 检查清单 ID |
| workspace_id | 是 | integer | 项目ID |
| name | 否 | string | 标题 |
| status | 否 | string | 状态。open：未完成；done：已完成。传入 done 会写入完成时间，传入 open 会清空完成时间 |
| owner | 否 | string | 处理人 |
| current_user | 否 | string | 变更人 |
| cc | 否 | string | 抄送人 |
| begin | 否 | date | 预计开始 |
| due | 否 | date | 预计结束 |
| custom_field_two | 否 | string | 备注（检查清单默认备注字段） |
| cus_{$自定义字段别名} | 否 | string | 自定义字段值，参数名会由后台自动转义为 custom_field_*，如：cus_备注 |
| custom_field_* | 否 | string或者integer | 自定义字段参数 |
# 调用示例及返回结果
# 将检查清单标记为已完成
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' -d 'id=1010104801122100052&workspace_id=10104801&status=done' 'https://api.tapd.cn/check_lists'
# 返回结果
{
"status": 1,
"data": {
"CheckList": {
"id": "1010104801122100052",
"workspace_id": "10104801",
"name": "check_item_created_by_api",
"status": "done",
"cc": "",
"owner": "",
"begin": null,
"due": null,
"creator": "anyechen",
"created": "2025-02-25 15:44:31",
"modified": "2025-02-25 16:10:12",
"completed": "2025-02-25 16:10:12",
"custom_field_two": "",
"relate_entity_type": "story",
"relate_entity_id": "1010104801124922063"
}
},
"info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 检查清单字段说明
检查清单字段说明，请参考：获取检查清单