Viewing Iteration Details

Function

URI

GET /v4/iterations/{iteration_id}

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

Request Parameters

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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
begin_time	String	Iteration end time, in the format of year-month-day.
charts	Array of Chart objects	Burndown Chart
closed_total	Integer	Number of Closed Work Orders
created_time	String	Iteration Creation Time
end_time	String	Iteration start time, in the format of year-month-day.
have_task	Boolean	Indicates whether a task exists.
iteration_id	Integer	Identifies a sprint.
name	String	Indicates the title of the sprint.
opened_total	Integer	Number of Open Work Orders
progress	String	Progress
total	Integer	Total Number of Work Orders
updated_time	String	Iteration Update Time
status	String	Iteration status. The options are as follows: 0: not started; 1: in progress; 2: ended.

**Table 4** Chart
Parameter	Type	Description
date	String	Statistics period
finished_num	Integer	Complete story work orders.
iteration_id	Integer	Identifies a sprint.
project_num_id	Integer	Project ID
remaining_num	Integer	Number of Uncompleted Stories
total	Integer	Total number of stories

Status code: 400

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

Status code: 401

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

Example Requests

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

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-31 09:10:03",
  "end_time" : "2020-07-19",
  "have_task" : false,
  "iteration_id" : 35789,
  "name" : "Iteration 1",
  "opened_total" : 3,
  "progress" : "25%",
  "total" : 4,
  "updated_time" : "2020-06-31 09:10:03",
  "status" : "0"
}