/rest/greenhopper/1.0/integration/teamcalendars/sprint/list有哪些参数,怎么配置
时间: 2023-09-18 13:05:45 浏览: 83
`/rest/greenhopper/1.0/integration/teamcalendars/sprint/list` 是 Jira Agile REST API 中用于获取团队日历中的所有冲刺的 API。它可以使用以下参数进行配置:
1. `jql`:用于过滤要获取的冲刺的 JQL 查询。例如,可以使用 `jql=sprint in openSprints()` 获取所有打开的冲刺。
2. `boardId`:用于指定要获取的冲刺所属的看板的 ID。
3. `jiraKey`:用于指定要获取的冲刺所属的 Jira 项目的键。
4. `sprintId`:用于指定要获取的特定冲刺的 ID。
5. `startAt`:用于指定返回的结果集中的起始位置。默认值为 0。
6. `maxResults`:用于指定返回的结果集的最大数量。默认值为 50,最大值为 200。
例如,可以使用以下 URL 获取看板 ID 为 10 的所有打开的冲刺:
```
/rest/greenhopper/1.0/integration/teamcalendars/sprint/list?jql=sprint%20in%20openSprints()&boardId=10
```
相关问题
/rest/greenhopper/1.0/integration/teamcalendars/sprint/list用法
这是 Jira 中的一个 REST API,用于获取团队日历中所有已完成和未完成的迭代。以下是使用方法:
- 发送 GET 请求到 URL:/rest/greenhopper/1.0/integration/teamcalendars/sprint/list
- 必须使用 Jira 账户进行身份验证,因此需要在请求头中添加 Authorization 字段。
- 可以添加以下参数:
- jql:用于过滤迭代的 JQL 查询语句。
- boardId:用于指定所属看板的 ID。
- includeHistoricSprints:一个布尔值,用于指定是否包含历史迭代。
- includeFutureSprints:一个布尔值,用于指定是否包含未来迭代。
- 请求成功后,将返回一个 JSON 格式的响应,其中包含所有满足条件的迭代信息,如迭代名称、开始和结束日期、状态等。
注意:此 API 需要在 Jira 中启用“团队日历”插件才能正常工作。
/rest/greenhopper/1.0/sprint/picker这个接口有哪些参数,这些参数怎么配置
`/rest/greenhopper/1.0/sprint/picker`这个接口是 Jira Agile 的一个 REST API,用来获取 Agile Board 上所有的 sprint 列表,具体的参数如下:
- `boardId`:表示要获取 sprint 列表的 Agile Board 的 ID,必选参数。
- `startAt`:表示从 sprint 列表的哪个位置开始返回 sprint 列表,默认值为 0。
- `maxResults`:表示最多返回多少个 sprint 列表,默认值为 50。
这些参数可以通过在请求 URL 中添加查询参数的方式来进行配置,例如:
```
https://your-jira-site/rest/greenhopper/1.0/sprint/picker?boardId=1&startAt=0&maxResults=100
```
其中,`boardId` 参数是必选的,表示要获取 sprint 列表的 Agile Board 的 ID。`startAt` 和 `maxResults` 参数是可选的,分别表示从 sprint 列表的哪个位置开始返回 sprint 列表和最多返回多少个 sprint 列表。如果不指定这两个参数,则默认返回第 1 页的前 50 个 sprint 列表。
需要注意的是,为了能够访问这个接口,你需要具有相应的权限。如果你没有权限访问该接口,会返回 403 Forbidden 错误。
阅读全文