通过 OpenAPI 创建迭代。
适用版本 | 标准版 |
服务接入点与授权信息
获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)。
获取个人访问令牌,具体操作,请参见获取个人访问令牌。
获取organizationId,请前往组织管理后台的基本信息页面获取组织 ID 。
产品
资源
所需权限
产品
资源
所需权限
项目协作
迭代
读写
请求语法
POST https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/{id}/sprints
请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
id | string | path | 是 | 项目唯一标识。 | project-id-xxx |
organizationId | string | path | 是 | organizationId。 | 5ebbc0228123212b59xxxxx |
- | object | body | 否 | ||
capacityHours | integer | body | 否 | 迭代的工时容量(小时)。 | 100 |
description | string | body | 否 | 迭代描述。 | 迭代信息 |
endDate | string | body | 否 | 结束日期。 | 1740018075 |
name | string | body | 是 | 迭代名称。 | test |
operatorId | string | body | 否 | 操作者的 userId,个人 token 时该参数无效。 | user-xxx |
owners | array[string] | body | 是 | 迭代负责人列表。 | ["user1","user2"] |
startDate | string | body | 否 | 开始日期。 | 1740018075 |
请求示例
curl -X 'POST' \
'https://test.rdc.aliyuncs.com/oapi/v1/projex/organizations/{organizationId}/projects/project-id-xxx/sprints' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"capacityHours": 0,
"description": "迭代信息",
"endDate": "1740018075",
"name": "test",
"operatorId": "user-xxx",
"owners": [
"user1","user2"
],
"startDate": ""
}'
返回参数
参数 | 类型 | 描述 | 示例值 |
参数 | 类型 | 描述 | 示例值 |
- | object | ||
id | string | id。 | 1111 |
返回示例
{
"id": "1111"
}
错误码
访问错误码中心查看 API 相关错误码。
该文章对您有帮助吗?