UpdateSprint,更新迭代-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
项目协作	迭代	读写

请求语法

中心版

PUT https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/{projectId}/sprints/{id}

Region版

PUT https://{domain}/oapi/v1/projex/projects/{projectId}/sprints/{id}

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
projectId	string	path	是	项目唯一标识。	589c53d622cc8521793e08****
id	string	path	是	迭代唯一标识。	892153d622cc8521793e08****
organizationId	string	path	是：中心版否：Region版	organizationId。
-	object	body	否
capacityHours	integer	body	否	迭代的工时容量（小时）。
description	string	body	否	迭代描述。
endDate	string	body	否	结束日期。
name	string	body	是	迭代名称。
operatorId	string	body	否	操作者的 userId，个人 token 时该参数无效。	user-xxx
owners	array[string]	body	否	迭代负责人列表。
startDate	string	body	否	开始日期。

请求示例

中心版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/589c53d622cc8521793e08****/sprints/892153d622cc8521793e08****' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "capacityHours": 0,
        "description": "",
        "endDate": "",
        "name": "",
        "operatorId": "user-xxx",
        "owners": [
            
        ],
        "startDate": ""
    }'

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****/sprints/892153d622cc8521793e08****' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "capacityHours": 0,
        "description": "",
        "endDate": "",
        "name": "",
        "operatorId": "user-xxx",
        "owners": [
            
        ],
        "startDate": ""
    }'

返回参数

无

错误码

访问错误码中心查看 API 相关错误码。