# 说明

计算符合查询条件的需求数量并返回

# url

https://api.tapd.cn/stories/count

# 支持格式

JSON/XML(默认JSON格式)

# HTTP请求方式

GET

# 请求数限制

只返回需求数量

# 请求参数

字段名 必选 类型及范围 说明 特殊规则
id integer ID 支持多ID查询
name string 标题 支持模糊匹配
priority string 优先级。为了兼容自定义优先级,请使用 priority_label 字段,详情参考:如何兼容自定义优先级
priority_label string 优先级。推荐使用这个字段
business_value integer 业务价值
status string 状态 支持枚举查询
label string 标签查询 支持枚举查询,5月30号上线
version string 版本
module string 模块
test_focus string 测试重点
size integer 规模
owner string 处理人 支持模糊匹配
cc string 抄送人 支持模糊匹配
creator string 创建人 支持模糊匹配
developer string 开发人员
begin date 预计开始 支持时间查询
due date 预计结束 支持时间查询
created datetime 创建时间 支持时间查询
modified datetime 最后修改时间 支持时间查询
completed datetime 完成时间 支持时间查询
iteration_id integer 迭代 支持不等于查询
effort string 预估工时
effort_completed string 完成工时
remain float 剩余工时
exceed float 超出工时
category_id integer 需求分类 支持枚举查询
workitem_type_id integer 需求类别ID 支持枚举查询
release_id integer 发布计划
source string 来源
type string 类型
parent_id integer 父需求
children_id string 子需求
description string 详细描述 支持模糊匹配
workspace_id integer 项目ID
custom_field_* string或者integer 自定义字段参数,具体字段名通过接口 获取需求自定义字段配置 获取 支持枚举查询
custom_plan_field_* string或者integer 自定义计划应用参数,具体字段名通过接口 获取自定义计划应用 获取

# 调用示例及返回结果

# 获取项目下需求的数量

# curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/stories/count?workspace_id=10158231'

# 返回结果

{
    "status": 1,
    "data": {
        "count": 7
    },
    "info": "success"
}
1
2
3
4
5
6
7

# 获取项目下优先级为 High 需求的数量

# curl 使用 Basic Auth 鉴权调用示例

curl -u 'api_user:api_password' 'https://api.tapd.cn/stories/count?workspace_id=10158231&priority=4'

# 返回结果

{
    "status": 1,
    "data": {
        "count": 4
    },
    "info": "success"
}
1
2
3
4
5
6
7

# 需求优先级(priority)取值字段说明

为了兼容自定义优先级,请使用 priority_label 字段,详情参考:如何兼容自定义优先级下面取值将不再使用

取值 字面值
4 High
3 Middle
2 Low
1 Nice To Have
上次更新: 2024-06-13 11:02:15