Querying the Sprint List
Function
This API is used to query the sprint list.
Calling Method
For details, see Calling APIs.
URI
GET /v4/projects/{project_id}/versions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: 32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Returned result of the sprint query. |
status |
String |
Definition: Response status of the current sprint list. Value range: success: The response is successful. error: The response failed. |
Parameter |
Type |
Description |
---|---|---|
versions |
Array of versions objects |
Definition: Returned sprints. |
total_count |
Integer |
Definition: Total number of sprints. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Unique ID of a sprint. Value range: N/A |
name |
String |
Definition: Sprint name. Value range: N/A |
status |
String |
Definition: Current status of a sprint. Value range: 0: not started 1: ongoing 2: closed |
project_id |
String |
Definition: Unique ID of the project to which a sprint belongs. Value range: N/A |
due_date |
String |
Definition: End date of a sprint (in timestamp format, for example, 1756656000000). Value range: N/A |
effective_date |
String |
Definition: Date when a sprint takes effect (in timestamp format, for example, 1756656000000). Value range: N/A |
created_on |
String |
Definition: Time when a sprint is created (in timestamp format, for example, 1756656000000). Value range: N/A |
updated_on |
String |
Definition: Last update time of a sprint (in timestamp format, for example, 1756656000000). Value range: N/A |
start_date |
String |
Definition: Start date of a sprint (in timestamp format, for example, 1756656000000). Value range: N/A |
is_current |
String |
Definition: Whether the sprint is the current version. Value range: N/A |
program_version_id |
String |
Definition: ID of the associated program version. Value range: N/A |
done_ratio |
Integer |
Definition: Sprint progress, in percentage. Value range: N/A |
is_deleted |
Integer |
Definition: Whether the sprint has been deleted. Value range: 0 (not deleted) 1 (deleted) |
status_option |
Array of status_option objects |
Definition: Sprint status option list. Value range: N/A |
project |
project object |
Definition: Project to which a sprint belongs. Value range: N/A |
issue_info |
issue_info object |
Definition: Statistics about sprint-related issues. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Sprint status ID. Value range: N/A |
name |
String |
Definition: Sprint status name. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition: Name of the project to which a sprint belongs. Value range: N/A |
id |
Integer |
Definition: ID of the project to which a sprint belongs. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Definition: Total number of issues. Value range: N/A |
type_info |
Array of strings |
Definition: Statistics on different types of issues. Value range: N/A |
closed |
String |
Definition: Number of closed issues. Value range: N/A |
un_closed |
String |
Definition: Number of unclosed issues. Value range: N/A |
Example Requests
{endpoint}/v4/projects/{5192de5eb435430c8cd41c6ae6028848}/versions
Example Responses
Status code: 200
OK (The request has succeeded).
{ "result" : { "versions" : [ { "id" : 26664788, "name" : "111", "status" : "0", "sharing" : "none", "createFromProgramVersion" : false, "project_id" : "35138974", "due_date" : "1756656000000", "effective_date" : "1756656000000", "created_on" : "1754387539000", "updated_on" : "1754387539000", "start_date" : "1755446400000", "is_current" : "3", "program_version_id" : "-1", "done_ratio" : 0, "is_deleted" : 0, "status_option" : [ { "id" : "0", "name" : "To Do" }, { "id" : "1", "name" : "Doing" }, { "id" : "2", "name" : "Done" } ], "project" : { "name" : "DevOps Full-Process Sample Project XXXX", "id" : 35138974 }, "issue_info" : { "total" : 0, "type_info" : [ ], "closed" : "0", "un_closed" : "0" } }, { "id" : 26664721, "name" : "Changing the sprint name", "status" : "1", "sharing" : "none", "createFromProgramVersion" : false, "project_id" : "35138974", "due_date" : "1754064000000", "effective_date" : "1754064000000", "created_on" : "1754375187000", "updated_on" : "1754380989000", "start_date" : "1752854400000", "is_current" : "1", "program_version_id" : "-1", "done_ratio" : 0, "is_deleted" : 0, "status_option" : [ { "id" : "0", "name" : "To Do" }, { "id" : "1", "name" : "Doing" }, { "id" : "2", "name" : "Done" } ], "project" : { "name" : "DevOps Full-Process Sample Project XXXX", "id" : 35138974 }, "issue_info" : { "total" : 0, "type_info" : [ ], "closed" : "0", "un_closed" : "0" } }, { "id" : 26658716, "name" : "Sprint 1", "description" : "", "status" : "2", "sharing" : "none", "createFromProgramVersion" : false, "project_id" : "35138974", "due_date" : "1750348800000", "effective_date" : "1750348800000", "created_on" : "1753084463000", "updated_on" : "1754379665000", "start_date" : "1749398400000", "is_current" : "2", "program_version_id" : "-1", "done_ratio" : 100, "is_deleted" : 0, "status_option" : [ { "id" : "0", "name" : "To Do" }, { "id" : "1", "name" : "Doing" }, { "id" : "2", "name" : "Done" } ], "project" : { "name" : "DevOps Full-Process Sample Project XXXX", "id" : 35138974 }, "issue_info" : { "total" : 11, "type_info" : [ { "total" : 5, "name" : "Task", "closed" : "5", "id" : "2", "un_closed" : "0" }, { "total" : 3, "name" : "Bug", "closed" : "3", "id" : "3", "un_closed" : "0" }, { "total" : 3, "name" : "Story", "closed" : "3", "id" : "7", "un_closed" : "0" } ], "closed" : "11", "un_closed" : "0" } } ], "total_count" : 3 }, "status" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK (The request has succeeded). |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot