# 说明

新建检查清单,返回新建检查清单的数据。检查清单必须绑定到需求或缺陷。单个父对象最多创建 200 条检查清单。

# SDK 方法名

nodeJs:

SDK使用方式 (opens new window)

插件中使用SDK

方法名::

addCheckList
1

# url

https://api.tapd.cn/check_lists

# 支持格式

JSON/XML(默认JSON格式)

# HTTP请求方式

POST

# 请求数限制

一次插入一条数据。单个父对象最多 200 条检查清单。

# 请求参数

字段名 必选 类型及范围 说明
workspace_id 是 integer 项目ID
name 是 string 标题
relate_entity_type 是 string 关联的 TAPD 对象类型,仅支持 story / bug
relate_entity_id 是 integer 关联的 TAPD 对象 ID
owner 否 string 处理人
cc 否 string 抄送人
creator 否 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 'name=check_item_created_by_api&workspace_id=10104801&relate_entity_type=story&relate_entity_id=1010104801124922063' 'https://api.tapd.cn/check_lists'

# 返回结果

{
    "status": 1,
    "data": {
        "CheckList": {
            "id": "1010104801122100052",
            "workspace_id": "10104801",
            "name": "check_item_created_by_api",
            "status": "open",
            "cc": "",
            "owner": "",
            "begin": null,
            "due": null,
            "creator": "anyechen",
            "created": "2025-02-25 15:44:31",
            "modified": "2025-02-25 15:44:31",
            "completed": null,
            "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

# 检查清单字段说明

检查清单字段说明,请参考:获取检查清单

上次更新: 2026-09-20 11:34:30