Querying Release/Sprint Plan Details
Function
This API is used to query release/sprint plan details.
Calling Method
For details, see Calling APIs.
URI
GET /v1/planservice/projects/{project_id}/plans/{plan_id}
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: Regular expression: ^[A-Za-z0-9]{32}$ Options: N/A Default value: N/A |
plan_id |
Yes |
String |
Description: unique ID of a release/sprint. You can obtain the value using the API for querying the release/sprint plan list in section "IPD Project Plan Management". The value of the id field in the response message body is the release/sprint ID. Constraints: Regular expression: ^([0-9]{18,19})$ Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
x-auth-token |
Yes |
String |
Definition: User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A Value range: 10–32,768 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Status information. |
message |
String |
Prompt message. |
result |
PlanVO object |
Return value of the created plan. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: ID (ID of a release, sprint, or milestone). Options: N/A |
title |
String |
Definition: Title. Options: N/A |
category |
String |
Definition: Type. The value is of the enumerated type. Options: PI, Iteration, and PlanMilestone |
description |
String |
Definition: Description Options: N/A |
state |
String |
Definition: Discard flag. The value is of the enumerated type. Options: In use, Discarded, and Deleted |
status |
String |
Definition: Status. The value is of the enumerated type. Options: planned, going, and ended |
children |
Array of PlanVO objects |
Definition: Sub-project sprint information. |
created_by |
String |
Definition: Creator. Options: N/A |
modified_by |
String |
Definition: Updater. Options: N/A |
plan_start_date |
Long |
Definition: Plan start time, which is a Unix timestamp (unit: millisecond). Options: N/A |
plan_end_date |
Long |
Definition: Plan completion time, which is a Unix timestamp (unit: millisecond). Options: N/A |
created_date |
Long |
Definition: Creation time, which is a Unix timestamp (unit: millisecond). Options: N/A |
parent_id |
String |
Definition: Parent work item ID. Options: N/A |
baseline |
String |
Definition: Baseline status. The value is of the enumerated type. Options: baselined, unbaseline, and baseline-reviewing |
workload |
String |
Definition: Estimated workload. Options: N/A |
owner |
String |
Definition: Owner ID. Options: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
GET https://{endpoint}/v1/planservice/projects/22f601108007420da5a90b4a30c09f83/plans/1113849585474641920
Example Responses
Status code: 200
OK
{ "status" : "success", "message" : "Success", "result" : { "id" : "123e4567e89b12d3a456426614174000", "title" : "Project Milestone 1", "category" : "PlanMilestone", "description" : "This is an important milestone of the project.", "state" : "In use", "status" : "planned", "children" : [ { "id" : "123e4567e89b12d3a456426614174000", "title" : "Sprint 1", "category" : "Iteration", "description" : "Sprint 1 description.", "state" : "In use", "status" : "planned", "children" : [ ], "created_by" : "user1", "modified_by" : "user1", "plan_start_date" : 1633072800000, "plan_end_date" : 1635751200000, "created_date" : 1633072800000, "parent_id" : "123e4567e89b12d3a456426614174000", "baseline" : "unbaseline", "workload" : "10 person-days", "owner" : "user2" } ], "created_by" : "admin", "modified_by" : "admin", "plan_start_date" : 1630466400000, "plan_end_date" : 1633072800000, "created_date" : 1630466400000, "parent_id" : null, "baseline" : "unbaseline", "workload" : "20 person-days", "owner" : "user1" } }
Status code: 400
The error message is returned.
{ "error_msg" : "Invalid project_id or other parameters", "error_code" : "AS.0001" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
The error message is returned. |
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