/rest/greenhopper/1.0/integration/teamcalendars/sprint/list用法
时间: 2023-06-15 12:06:38 浏览: 218
这是 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/integration/teamcalendars/sprint/list有哪些参数,怎么配置
`/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/sprint/picker是jira的接口,示例用法
这个接口用于获取当前用户的所有Sprint列表,可以通过以下示例用法进行调用:
```python
import requests
# Jira服务器的地址和项目ID
jira_url = "https://your-jira-url.com"
project_id = "PROJ-123"
# Jira登录凭证
auth = ("your_jira_username", "your_jira_password")
# 构造请求URL
url = f"{jira_url}/rest/greenhopper/1.0/sprint/picker?&includeHistoricSprints=true&includeFutureSprints=true&projectKeyOrId={project_id}"
# 发送请求
response = requests.get(url, auth=auth)
# 解析响应数据
if response.ok:
data = response.json()
sprints = data["suggestions"]
for sprint in sprints:
print(f"Sprint ID: {sprint['id']}, Name: {sprint['name']}")
else:
print("Failed to get sprint list.")
```
以上示例代码中的`jira_url`是你的Jira服务器地址,`project_id`是你要查询的Jira项目的ID或Key。`auth`是Jira登录凭证,使用Jira的用户名和密码即可。构造请求URL时,需要指定`includeHistoricSprints`和`includeFutureSprints`参数来控制是否包含历史和未来的Sprint。最后,解析响应数据并输出Sprint的ID和名称。
阅读全文