Updated on 2026-10-13 GMT+08:00

Viewing Sprint Details

Function

This API is used to view sprint details.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsreq:iteration:get

Read

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

GET /v4/iterations/{iteration_id}

Table 1 Path Parameters

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

≥ 1 digit

Range

Min.: 0.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

The value contains 10 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

begin_time

String

Definition:

Sprint start time: YYYY-MM-DD.

Options:

N/A

charts

Array of Chart objects

Definition:

Burndown chart.

closed_total

Integer

Definition:

Number of closed tickets.

Options:

N/A

created_time

String

Definition:

Sprint creation time.

Options:

N/A

end_time

String

Definition:

Sprint end time: YYYY-MM-DD.

Options:

N/A

have_task

Boolean

Definition:

Whether there is a task.

Options:

true: yes

false: no

iteration_id

Integer

Definition

Sprint ID.

Range

N/A

name

String

Definition:

Sprint title.

Options:

N/A

opened_total

Integer

Definition:

Number of open tickets.

Options:

N/A

progress

String

Definition:

Work progress.

Options:

N/A

status

String

Definition:

Sprint status.

Value range:

0: not started

1: ongoing

2: ended

total

Integer

Definition:

Total number of tickets.

Options:

N/A

updated_time

String

Definition:

Sprint update time.

Options:

N/A

Table 4 Chart

Parameter

Type

Description

date

String

Definition:

Statistics collection time.

Options:

N/A

finished_num

Integer

Definition:

Number of completed stories.

Options:

N/A

iteration_id

Integer

Definition

Sprint ID.

Range

N/A

project_num_id

Integer

Definition

Project ID.

Range

N/A

remaining_num

Integer

Definition:

Number of uncompleted stories.

Options:

N/A

total

Integer

Definition:

Total number of stories.

Options:

N/A

Status code: 400

Table 5 Response body parameters

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

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error description.

Value range:

N/A

request_id

String

Definition

Request ID, which is automatically generated by the system.

Range

N/A

Example Requests

GET https://{endpoint}/v4/iterations/11225793

Example Responses

Status code: 200

{
  "begin_time" : "2020-07-12",
  "charts" : [ {
    "date" : "2020-09-12",
    "finished_num" : 1,
    "iteration_id" : 3789,
    "project_num_id" : 36587463,
    "remaining_num" : 3,
    "total" : 4
  } ],
  "closed_total" : 1,
  "created_time" : "2020-06-30 09:10:03",
  "end_time" : "2020-07-19",
  "have_task" : false,
  "iteration_id" : 35789,
  "name" : "Sprint 1",
  "opened_total" : 3,
  "progress" : "25%",
  "total" : 4,
  "updated_time" : "2020-06-30 09:10:03",
  "status" : "0"
}

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
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 ShowIterationV4Solution {

    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();
        ShowIterationV4Request request = new ShowIterationV4Request();
        request.withIterationId({iteration_id});
        try {
            ShowIterationV4Response response = client.showIterationV4(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
# 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 = ShowIterationV4Request()
        request.iteration_id = {iteration_id}
        response = client.show_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
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.ShowIterationV4Request{}
	request.IterationId = int32({iteration_id})
	response, err := client.ShowIterationV4(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

200

OK

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.