导出根据项目查询jira中sprint列表的接口说明文档
时间: 2023-06-15 19:06:55 浏览: 150
接口文档说明文件
3星 · 编辑精心推荐
以下是根据项目查询Jira中Sprint列表的接口说明文档:
## 接口名称
查询项目Sprint列表
## 接口描述
查询指定Jira项目中所有Sprint的列表信息。
## HTTP请求方式
GET
## URL
```http
https://your.jira.domain/rest/agile/1.0/board/{boardId}/sprint?state={state}
```
其中:
- `your.jira.domain`:你的Jira域名。
- `boardId`:Jira项目的board ID。
- `state`:可选参数,Sprint的状态,包括`active`、`closed`和`future`。
## 请求参数
无
## 响应参数
| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| id | integer | Sprint的ID |
| name | string | Sprint的名称 |
| state | string | Sprint的状态,包括`active`、`closed`和`future` |
| startDate | string | Sprint的开始日期,格式为`yyyy-MM-dd` |
| endDate | string | Sprint的结束日期,格式为`yyyy-MM-dd` |
| completeDate | string | Sprint的完成日期,格式为`yyyy-MM-dd`(仅当Sprint状态为`closed`时才有值) |
## 响应示例
```json
{
"sprints": [
{
"id": 1,
"name": "Sprint 1",
"state": "active",
"startDate": "2022-01-01",
"endDate": "2022-01-14",
"completeDate": null
},
{
"id": 2,
"name": "Sprint 2",
"state": "closed",
"startDate": "2022-01-15",
"endDate": "2022-01-28",
"completeDate": "2022-01-28"
}
]
}
```
## 备注
- 如果没有传递`state`参数,则返回所有状态的Sprint列表。
- 如果Jira项目没有Sprint,则返回空列表。
阅读全文