Obtaining Sprints of a Specified Project

Updated on 2025-05-22 GMT+08:00

View PDF

Function

Obtain Project Iteration

URI

GET /v4/projects/{project_id}/iterations

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the 32-bit ID of the devcloud project. Minimum: 32 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
updated_time_interval	No	String	Update iteration time (query start time and query end time).
include_deleted	No	Boolean	Indicates whether deleted iterations are included. The default value is false, indicating that deleted iterations are not included.

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 Iterations
iterations	Array of iterations objects	Iteration information

**Table 5** iterations
Parameter	Type	Description
description	String	Indicates the description of the sprint.
end_time	String	Indicates the end date of the sprint.
id	Integer	Identifies a sprint.
name	String	Indicates the title of the sprint.
begin_time	String	Indicates the start date of the sprint.
status	String	Iteration Status
updated_time	Long	Iteration update time, which is a long integer timestamp.
deleted	Boolean	Indicates whether the iteration has been deleted. The options are false (not deleted) and true (deleted).

Status code: 400

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

Status code: 401

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

Example Requests

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/iterations

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/iterations

Example Responses

Status code: 200

{
  "total" : 3,
  "iterations" : [ {
    "description" : "description",
    "end_time" : "2019-10-17",
    "id" : 9725885,
    "name" : "Completed HTML",
    "begin_time" : "2019-10-10",
    "status" : "0",
    "updated_time" : 1640231944000,
    "deleted" : false
  } ]
}