Help Center/ CodeArts Req/ API Reference/ API/ Iteration of the Scrum Project/ Viewing Historical Records of a Sprint
Updated on 2025-09-10 GMT+08:00

Viewing Historical Records of a Sprint

Function

This API is used to view sprint histories.

Calling Method

For details, see Calling APIs.

URI

GET /v4/iterations/{iteration_id}/histories

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

iteration_id

Yes

Integer

Definition:

Sprint ID. You can obtain the sprint list of a project using the Obtaining the Sprint List of a Specified Project API.

Constraints:

Regular expression: \d+

Options:

Minimum value: 0.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition:

Offset.

Constraints:

N/A

Options:

Minimum value: 0.

Default value:

0

limit

No

Integer

Definition:

Number of data records on each page.

Constraints:

N/A

Options:

Minimum value: 1. Maximum value: 100.

Default value:

10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain the token by calling theObtaining a User TokenIAM API. In the returned response header, X-Subject-Token is the desired user token.

Constraints:

Mandatory.

Range:

Minimum length: 10 character. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

histories

Array of IterationHistory objects

Definition:

History records.

total

Integer

Definition:

Total number.

Options:

N/A

Table 5 IterationHistory

Parameter

Type

Description

details

Array of details objects

Definition:

Operation details.

iteration_id

String

Definition:

Sprint ID.

Options:

N/A

operate

String

Definition:

Operation type.

Options:

Create

Modify

Delete

operate_time

String

Definition:

Operation time.

Options:

N/A

operator

operator object

Definition:

Change operator.

project_id

String

Definition:

Project ID.

Options:

N/A

Table 6 details

Parameter

Type

Description

new_value

String

Definition:

Value after operation.

Options:

N/A

old_value

String

Definition:

Value before operation.

Options:

N/A

operate_field_name

String

Definition:

Modified field.

Options:

N/A

Table 7 operator

Parameter

Type

Description

domain_id

String

Definition:

Tenant UUID.

Options:

N/A

domain_name

String

Definition:

Tenant name.

Options:

N/A

nick_name

String

Definition:

Alias.

Options:

N/A

user_id

String

Definition:

User UUID.

Options:

N/A

user_name

String

Definition:

Username.

Options:

N/A

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Get https://{endpoint}/v4/iterations/11225793/histories

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "histories" : [ {
    "iteration_id" : 123454,
    "project_id" : "19274e1adffb4cc0b866ef6dd3ad0100",
    "operator" : {
      "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
      "user_name" : "Banna",
      "nick_name" : "Red Sea",
      "domain_id" : "9b33eb1d219140fea54d3b5ac689b073",
      "domain_name" : "devcloud_test"
    },
    "operate" : "NEW",
    "operate_time" : "1665473746000",
    "details" : [ {
      "operate_field_name" : "name",
      "old_value" : null,
      "new_value" : "test"
    }, {
      "operate_field_name" : "description",
      "old_value" : null,
      "new_value" : null
    }, {
      "operate_field_name" : "end_time",
      "old_value" : null,
      "new_value" : "1664380800000"
    }, {
      "operate_field_name" : "status",
      "old_value" : null,
      "new_value" : "0"
    }, {
      "operate_field_name" : "begin_time",
      "old_value" : null,
      "new_value" : "1663776000000"
    }, {
      "operate_field_name" : "program_version_id",
      "old_value" : null,
      "new_value" : "-1"
    } ]
  } ]
}

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

    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();
        ListIterationHistoriesRequest request = new ListIterationHistoriesRequest();
        request.withIterationId({iteration_id});
        try {
            ListIterationHistoriesResponse response = client.listIterationHistories(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 = ListIterationHistoriesRequest()
        request.iteration_id = {iteration_id}
        response = client.list_iteration_histories(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListIterationHistoriesRequest{}
	request.IterationId = int32({iteration_id})
	response, err := client.ListIterationHistories(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.