Viewing Historical Iteration Records

Function

URI

GET /v4/iterations/{iteration_id}/histories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
iteration_id	Yes	Integer	Identifies a sprint.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset Minimum: 0 Default: 0
limit	No	Integer	Number of records on each page. The maximum value is 100. Minimum: 1 Maximum: 100 Default: 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 10 Maximum: 32768

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total
histories	Array of IterationHistory objects	History

**Table 5** IterationHistory
Parameter	Type	Description
iteration_id	String	Iteration ID
project_id	String	Project ID
operator	operator object	Change Operator
operate	String	Operation Type (Added, Modified, and Deleted)
operate_time	String	Operated
details	Array of details objects	Detail

**Table 6** operator
Parameter	Type	Description
user_id	String	Indicates the user UUID.
user_name	String	User Name
nick_name	String	Nickname
domain_id	String	Indicates the tenant UUID.
domain_name	String	Tenant Name

**Table 7** details
Parameter	Type	Description
operate_field_name	String	Changed Field
new_value	String	Value After Operation
old_value	String	Value Before Operation

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Description
error_code	String	Error Codes

Example Requests

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

Example Responses

Status code: 200

{
  "total" : 1,
  "histories" : [ {
    "iteration_id" : 123454,
    "project_id" : "19274e1adffb4cc0b866ef6dd3ad0100",
    "operator" : {
      "user_id" : "0a938608ac00f2271f2ec01cccb94c19",
      "user_name" : "Banna",
      "nick_name" : "",
      "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"
    } ]
  } ]
}