• SDK 方法名
  • nodeJs
  • python
  • golang
• SDK 方法名
• 获取空间下检查清单
  • curl 使用 Basic Auth 鉴权调用示例
  • 返回结果
• 检查清单重要字段说明

说明

返回符合查询条件的检查清单（分页显示，默认一页30条）

SDK 方法名

nodeJs:

SDK使用方式 (opens new window)

插件中使用SDK

方法名::

getCheckLists

url

https://api.tapd.cn/check_lists

支持格式

JSON/XML（默认JSON格式）

HTTP请求方式

GET

请求数限制

默认返回 30 条。可通过传 limit 参数设置，最大取 200。也可以传 page 参数翻页

请求参数

字段名	必选	类型及范围	说明	特殊规则
workspace_id	是	integer	空间ID
id	否	integer	ID	支持多ID查询
name	否	string	标题
status	否	string	状态。open：未完成，done：已完成
owner	否	string	处理人
cc	否	string	抄送人
creator	否	string	创建人
begin	否	date	预计开始
due	否	date	预计结束	支持时间查询
created	否	datetime	创建时间	支持时间查询
modified	否	datetime	最后修改时间	支持时间查询
completed	否	datetime	完成时间	支持时间查询
relate_entity_type	否	string	关联的TAPD对象类型，有 bug/story
relate_entity_id	否	string	关联的TAPD对象 ID
custom_field_two	否	string	备注（检查清单默认备注字段）
custom_field_*	否	string或者integer	自定义字段参数
limit	否	integer	设置返回数量限制，默认为30
page	否	integer	返回当前数量限制下第N页的数据，默认为1（第一页）
order	否	string	排序规则，规则：字段名 ASC或者DESC，然后 urlencode	如按创建时间逆序：order=created%20desc
fields	否	string	设置获取的字段，多个字段间以','逗号隔开

调用示例及返回结果

获取空间下检查清单

curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/check_lists?workspace_id=10104801'

返回结果

{
    "status": 1,
    "data": [
        {
            "CheckList": {
                "id": "1010104801122100052",
                "workspace_id": "10104801",
                "name": "fire",
                "status": "open",
                "cc": "",
                "owner": "",
                "begin": null,
                "due": null,
                "creator": "anyechen",
                "created": "2025-02-25 15:44:31",
                "modified": "2025-02-25 15:46:35",
                "completed": null,
                "custom_field_two": "",
                "relate_entity_type": "bug",
                "relate_entity_id": "1010104801138325641"
            }
        }
    ],
    "info": "success"
}

检查清单字段说明

检查清单重要字段说明

字段	说明
id	ID
workspace_id	项目ID
name	标题
status	状态(open:未完成，done:已完成)
owner	处理人
cc	抄送人
creator	创建人
begin	预计开始
due	预计结束
created	创建时间
modified	最后修改时间
completed	完成时间
custom_field_two	备注（检查清单默认备注字段）
relate_entity_type	关联的TAPD对象类型
relate_entity_id	关联的TAPD对象ID