查询规划列表
功能介绍
分页查询当前项目用户可见的所有规划。
调用方法
请参见如何调用API。
URI
POST /v3/plan/{project_id}/managements
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
search |
否 |
String |
参数解释: 分组名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
user_ids |
否 |
Array of strings |
参数解释: 创建人的uuid列表,用户通过获取当前用户信息接口获取,响应消息体中的user_id字段的值就是用户32位uuid。 约束限制: 不涉及。 |
sort |
否 |
String |
参数解释: 查询数据的排序规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
page_no |
是 |
Integer |
参数解释: 当前页数。 约束限制: 不涉及。 取值范围: 最小1,最大9999。 默认取值: 1。 |
type |
否 |
String |
参数解释: 规划类型。 约束限制: 不涉及。 取值范围: gantt(甘特), mind(思维导图)。 默认取值: 不涉及。 |
page_size |
是 |
Integer |
参数解释: 每页行数。 约束限制: 不涉及。 取值范围: 最小1,最大200。 默认取值: 1。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
plans |
Array of PlanVO objects |
参数解释: 项目规划列表。 |
total |
Long |
参数解释: 查询到的项目规划总条数。 取值范围: 不涉及。 |
minds |
Long |
参数解释: 查询到的类型为思维导图的规划条数。 取值范围: 不涉及。 |
gantts |
Long |
参数解释: 查询到的类型为甘特图的规划条数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 规划列表的结果。 |
status |
String |
参数解释: 请求的处理状态。 取值范围: success:成功。 error:失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 规划的id。 取值范围: 不涉及。 |
name |
String |
参数解释: 规划的标题。 取值范围: 不涉及。 |
type |
String |
参数解释: 规划类型。 取值范围: gantt(甘特) mind(思维导图) |
project_id |
String |
参数解释: 所属项目的id。 取值范围: 不涉及。 |
creator |
creator object |
参数解释: 创建人的信息。 |
请求示例
POST https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/managements { "sort" : "", "search" : "", "page_no" : 1, "page_size" : 15, "type" : "gantt", "user_ids" : [ "a360371833bf4c558f796fd707b44daf" ] }
响应示例
状态码:200
查询项目下当前用户可见的所有规划返回数据。
{ "result" : { "plans" : [ { "id" : "bf56512ab4e544c29d03d068711ca56a", "name" : "甘特测试", "type" : "gantt", "project_id" : "919bb351ef424e2daaf3dd80c179fae9", "creator" : { "user_id" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "nick_name" : "张三丰", "first_name" : "devcloud_devcloud_s00404480_01" }, "updater" : { "user_id" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "4e919d73499648e3b0292cd3cbef806a", "nick_name" : "张三丰", "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代码示例
SDK代码示例如下。
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) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询项目下当前用户可见的所有规划返回数据。 |
错误码
请参见错误码。