Querying the Release/Sprint Plan List
Function
This API is used to query the release/sprint plan list.
Calling Method
For details, see Calling APIs.
URI
GET /v1/planservice/projects/{project_id}/plans/query
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key_word |
Yes |
String |
Definition: Release/Sprint name. Constraints: N/A Options: N/A Default value: N/A |
updated_time_interval |
Yes |
String |
Definition: Release/Sprint update time, which is a Unix timestamp (unit: millisecond). Examples: 1576114296000 and 1576114396000 Constraints: Regular expression: ([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})? Options: N/A 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 |
Definition: Status information. Options: N/A |
message |
String |
Definition: Prompt information. Options: N/A |
result |
Array of PlanVO objects |
Definition: Plan list. |
page |
page object |
Definition: Plan list page. |
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 |
Parameter |
Type |
Description |
---|---|---|
page |
Integer |
Definition: Page number. Options: N/A |
size |
Integer |
Definition: Number of pages. Options: N/A |
count |
Integer |
Definition: Number of records displayed on the current page. 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/{project_id}/plans/query?key_word=gzy&updated_time_interval=1706845235000,1706845835000
Example Responses
Status code: 200
OK
{ "status" : "success", "message" : null, "result" : [ { "id" : "956200745322848257", "title" : "IR-01", "category" : "PI", "description" : "Description", "state" : "In use", "status" : "ended", "children" : null, "created_by" : "a360371833bf4c558f796fd707b44daf", "modified_by" : "a360371833bf4c558f796fd707b44daf", "plan_start_date" : "1706845715000", "plan_end_date" : "1706845715000", "created_date" : "1706845715000", "parent_id" : "956239067176935424", "baseline" : "baselined", "workload" : "workload", "owner" : "a360371833bf4c558f796fd707b44daf" } ], "page" : { "page" : 1, "size" : 10, "count" : 1 } }
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