- 概述
- 鉴权
- 全局
- 个人
- 组织
- 安全
- 通用
- 产品管理 Product
- 项目管理 Project
- 项目
- Scrum
- Kanban
- 瀑布
- 工作项
- 发布
- 项目配置中心
- 项目配置
- 工作项配置
- 创建一个工作项标签
- 部分更新一个工作项标签
- 获取全部工作项标签列表
- 删除一个工作项标签
- 创建一个工作项类型
- 部分更新一个工作项类型
- 获取全部工作项类型列表
- 删除一个工作项类型
- 创建一个工作项状态
- 部分更新一个工作项状态
- 获取全部工作项状态列表
- 向状态方案中添加一个工作项状态
- 获取状态方案中的工作项状态列表
- 在状态方案中移除一个工作项状态
- 向状态方案中添加一个工作项状态流转
- 获取状态方案中的工作项状态流转列表
- 在状态方案中移除一个工作项状态流转
- 创建一个工作项属性
- 部分更新一个工作项属性
- - 获取一个工作项属性
- 获取全部工作项属性列表
- 获取工作项属性方案列表
- 向属性方案中添加一个工作项属性
- 获取属性方案中的工作项属性列表
- 在属性方案中移除一个工作项属性
- 测试管理 Testhub
- 知识管理 Wiki
- DevOps 数据集成
创建一个迭代
POST
https://open.pingcode.com/v1/project/projects/{project_id}/sprints
最后修改时间:2024-01-22 09:04:45
责任人:未设置
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Path 参数
project_id
string
必需
示例值:
{{project_id}}
Body 参数application/json
name
string
迭代的名称。
start_at
number
迭代开始的时间。
end_at
number
迭代结束的时间。
assignee_id
string
迭代负责人的id。
description
string
迭代的描述。
status
string
可选
category_ids
array[string]
可选
示例
{
"name": "Sprint 2",
"start_at": 1589791860,
"end_at": 1589791860,
"assignee_id": "a0417f68e846aae315c85d24643678a9",
"description": "This is sprint 2",
"status": "pending",
"category_ids": [
"676a460a0fd987b7ea320887"
]
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://open.pingcode.com/v1/project/projects/{{project_id}}/sprints' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Sprint 2",
"start_at": 1589791860,
"end_at": 1589791860,
"assignee_id": "a0417f68e846aae315c85d24643678a9",
"description": "This is sprint 2",
"status": "pending",
"category_ids": [
"676a460a0fd987b7ea320887"
]
}'
返回响应
🟢200成功
application/json
Body
id
string
必需
url
string
必需
project
object
必需
id
string
必需
url
string
必需
identifier
string
必需
name
string
必需
type
string
必需
name
string
必需
start_at
integer
必需
end_at
integer
必需
status
string
必需
assignee
object
必需
id
string
必需
url
string
必需
name
string
必需
display_name
string
必需
avatar
string
必需
description
string
必需
completed_story_points
integer
必需
started_story_points
integer
必需
categories
array [object {3}]
必需
id
string
可选
url
string
可选
name
string
可选
示例
{
"id": "5ecf7b74eaab845a2aa53132",
"url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/sprints/5ecf7b74eaab845a2aa53132",
"project": {
"id": "5eb623f6a70571487ea47000",
"url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000",
"identifier": "SCR",
"name": "Scrum项目",
"type": "scrum"
},
"name": "Sprint 2",
"start_at": 1589791860,
"end_at": 1589791860,
"status": "pending",
"assignee": {
"id": "a0417f68e846aae315c85d24643678a9",
"url": "https://rest_api_root/v1/directory/users/a0417f68e846aae315c85d24643678a9",
"name": "john",
"display_name": "John",
"avatar": "https://s3.amazonaws.com/bucket/b46ef40c-e22e-4ecf-a599-cace9fba839a_160x160.png"
},
"description": "This is sprint 2",
"completed_story_points": 0,
"started_story_points": 0,
"categories": [
{
"id": "676a460a0fd987b7ea320887",
"url": "https://rest_api_root/v1/project/projects/5eb623f6a70571487ea47000/sprint_categories/676a460a0fd987b7ea320887",
"name": "Category 1"
}
]
}