Updating Sprints of a Scrum Project
Function
This API is used to update Scrum project sprints.
Calling Method
For details, see Calling APIs.
URI
PUT /v4/projects/{project_id}/iterations/{iteration_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| iteration_id | Yes | String | Definition: Sprint ID. You can obtain the sprint ID of a specific project using the Obtaining the Sprint List of a Specified Project API. Constraints: Regular expression: \d+ Options: Minimum value: 0. Default value: N/A |
| project_id | Yes | String | Definition: 32-character UUID of a project, which must be unique. Obtain the value by calling the API for Querying the Project List. The value of project_id in the response message body is the project ID. Constraints: Regular expression: [A-Za-z0-9]{32} Value range: N/A Default value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| begin_time | Yes | String | Definition: Start time: YYYY–MM–DD. Constraints: Regular expression: [1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) Options: N/A Default value: N/A |
| description | No | String | Definition: Description. Constraints: Maximum: 50,000 characters. Options: N/A Default value: N/A |
| end_time | Yes | String | Definition: End time: YYYY–MM–DD. Constraints: Regular expression: [1-9]\d{3}-(0?[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) Options: N/A Default value: N/A |
| name | Yes | String | Definition: Title. Constraints: N/A Options: N/A Default value: N/A |
| over_type | No | String | Definition: Work item processing upon the end of a sprint. Constraints: over_type is required when status is updated to 2. Value range: close (All work items are closed.) empty (Work items that are not closed are placed in the block.) Default value: N/A |
| status | No | String | Definition: Sprint status. Constraints: The status cannot be changed across sprints. Value range: 0: not started 1: ongoing 2: ended Default value: N/A |
Response Parameters
Status code: 204
No Content
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition: Error code. Value range: N/A |
| error_msg | String | Definition: Error description. Value range: N/A |
Example Requests
Put https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/iteration/11225793
{
"end_time" : "2018-07-05",
"name" : "sttes32s3",
"begin_time" : "2018-1-31",
"description" : ""
} Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class UpdateIterationV4Solution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); UpdateIterationV4Request request = new UpdateIterationV4Request(); request.withProjectId("{project_id}"); request.withIterationId({iteration_id}); UpdateIterationRequestV4 body = new UpdateIterationRequestV4(); body.withName("sttes32s3"); body.withEndTime("2018-07-05"); body.withDescription(""); body.withBeginTime("2018-1-31"); request.withBody(body); try { UpdateIterationV4Response response = client.updateIterationV4(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateIterationV4Request() request.project_id = "{project_id}" request.iteration_id = {iteration_id} request.body = UpdateIterationRequestV4( name="sttes32s3", end_time="2018-07-05", description="", begin_time="2018-1-31" ) response = client.update_iteration_v4(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.UpdateIterationV4Request{} request.ProjectId = "{project_id}" request.IterationId = int32({iteration_id}) descriptionUpdateIterationRequestV4:= "" request.Body = &model.UpdateIterationRequestV4{ Name: "sttes32s3", EndTime: "2018-07-05", Description: &descriptionUpdateIterationRequestV4, BeginTime: "2018-1-31", } response, err := client.UpdateIterationV4(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot