Querying the Plan List
Function
This API is used to query all plans visible to users in the current project in pagination mode.
Calling Method
For details, see Calling APIs.
URI
POST /v3/plan/{project_id}/managements
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 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
search |
No |
String |
Definition: Group name. Constraints: N/A Value range: N/A Default value: N/A |
user_ids |
No |
Array of strings |
Definition: Creator UUID list. You can obtain the value using the Obtaining the Current User Information API. The value of user_id in the response message body is the 32-character UUID of the user. Constraints: N/A |
sort |
No |
String |
Definition: Sorting rule of the queried data. Constraints: N/A Value range: N/A Default value: N/A |
page_no |
Yes |
Integer |
Definition: Current page number. Constraints: N/A Value range: Minimum value: 1. Maximum value: 9,999. Default value: 1 |
type |
No |
String |
Definition: Plan type. Constraints: N/A Value range: gantt (Gantt chart) mind (mind map) Default value: N/A |
page_size |
Yes |
Integer |
Definition: Number of rows on each page. Constraints: N/A Value range: Minimum value: 1. Maximum value: 200. Default value: 1 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
plans |
Array of PlanVO objects |
Definition: Project plan list. |
total |
Long |
Definition: Total number of queried project plans. Options: N/A |
minds |
Long |
Definition: Number of plans whose type is mind map. Options: N/A |
gantts |
Long |
Definition: Number of plans whose type is Gantt chart. Options: N/A |
Parameter |
Type |
Description |
---|---|---|
result |
result object |
Definition: Plan list. |
status |
String |
Definition: Processing status of a request. Value range: success: successful error: failed |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Plan ID. Value range: N/A |
name |
String |
Definition: Plan title. Value range: N/A |
type |
String |
Definition: Plan type. Value range: gantt (Gantt chart) mind (mind map) |
project_id |
String |
Definition: Project ID. Value range: N/A |
creator |
creator object |
Definition: Creator information. |
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
Definition: User ID of the creator. Value range: N/A |
domain_id |
String |
Definition: Tenant ID. Value range: N/A |
nick_name |
String |
Definition: Creator alias. Value range: N/A |
first_name |
String |
Definition: Username of the creator. Value range: N/A |
Example Requests
POST https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/managements { "sort" : "", "search" : "", "page_no" : 1, "page_size" : 15, "type" : "gantt", "user_ids" : [ "a360371833bf4c558f796fd707b44daf" ] }
Example Responses
Status code: 200
Query all plan data visible to the current user in the project.
{ "result" : { "plans" : [ { "id" : "bf56512ab4e544c29d03d068711ca56a", "name" : "Gantt test", "type" : "gantt", "project_id" : "919bb351ef424e2daaf3dd80c179fae9", "creator" : { "user_id" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "nick_name" : "Sam", "first_name" : "devcloud_devcloud_s00404480_01" }, "updater" : { "user_id" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "nick_name" : "Sam", "first_name" : "devcloud_devcloud_s00404480_01" }, "created_on" : "1749730042000", "updated_on" : "1749730527000", "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png" } ], "total" : "1", "minds" : "0", "gantts" : "1" }, "status" : "success" }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ShowScrumPlansByConditionSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ShowScrumPlansByConditionRequest request = new ShowScrumPlansByConditionRequest(); request.withProjectId("{project_id}"); body.withBody("{sort=, search=, page_no=1, page_size=15, type=gantt, user_ids=[a360371833bf4c558f796fd707b44daf]}"); request.withBody(listBodyBody); try { ShowScrumPlansByConditionResponse response = client.showScrumPlansByCondition(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowScrumPlansByConditionRequest() request.project_id = "{project_id}" request.body = listBodyBody response = client.show_scrum_plans_by_condition(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowScrumPlansByConditionRequest{} request.ProjectId = "{project_id}" bodyBody:= "{sort=, search=, page_no=1, page_size=15, type=gantt, user_ids=[a360371833bf4c558f796fd707b44daf]}" request.Body = listBodyBody response, err := client.ShowScrumPlansByCondition(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Query all plan data visible to the current user in the project. |
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