查询看板项目的工作项流转配置 - ShowWorkItemWorkflowConfig
功能介绍
查询看板项目的工作项流转配置
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/work-items/workflow/config
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
board_id |
是 |
String |
看板id |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
workflows |
Array of WorkItemStatusFlowVo objects |
流转数据 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
assign_to |
String |
处理人的uuid |
|
comment |
String |
评论内容 |
|
direct_to |
Array of StatusFlowDirectToVo objects |
流转到的数据 |
|
field_type |
Boolean |
参数解释: 是否是字段值。 取值范围:
|
|
name |
String |
状态名称 |
|
parent_id |
String |
父状态的uuid |
|
parent_name |
String |
父状态的名称 |
|
parent_type |
String |
参数解释: 父工作项状态。 取值范围: START:初始态 IN_PROGRESS:进行中 END:已结束 |
|
required_assign |
Boolean |
处理人是否必填 |
|
required_notes |
Boolean |
评论是否必填 |
|
status_id |
String |
状态id |
|
status_type |
String |
参数解释: 工作项状态。 取值范围: START:初始态 IN_PROGRESS:进行中 END:已结束 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
enabled |
Boolean |
是否已开启状态流转, true: 开启, false 没开启 |
|
name |
String |
状态名称 |
|
parent_id |
String |
父状态的uuid |
|
parent_name |
String |
父状态的名称 |
|
parent_type |
String |
参数解释: 父工作项状态。 取值范围: START:初始态 IN_PROGRESS:进行中 END:已结束 |
|
status_id |
String |
状态id |
|
status_type |
String |
参数解释: 工作项状态类型。 取值范围: START:初始态 IN_PROGRESS:进行中 END:已结束 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items/workflow/config?board_id=5aef890d5a2d45b2b22f3e307e785715
响应示例
状态码:200
OK
{
"workflows" : [ {
"parent_name" : "进行中",
"parent_type" : "IN_PROGRESS",
"status_id" : "d25fe91f7f6b489db5f804e66ac3b360",
"name" : "研发",
"status_type" : "IN_PROGRESS",
"direct_to" : [ {
"parent_name" : "进行中",
"parent_type" : "IN_PROGRESS",
"status_id" : "d25fe91f7f6b489db5f804e66ac3b360",
"name" : "研发",
"status_type" : "IN_PROGRESS",
"enabled" : false,
"parent_id" : "beda5e42974c42a09e142faa1dc0fc98"
} ],
"assign_to" : "a360371833bf4c558f796fd707b44daf",
"comment" : "A transfer to B",
"required_assign" : false,
"required_notes" : false,
"field_type" : false,
"parent_id" : "beda5e42974c42a09e142faa1dc0fc98"
} ]
}
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 |
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 ShowWorkItemWrokflowConfigSolution { 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(); ShowWorkItemWrokflowConfigRequest request = new ShowWorkItemWrokflowConfigRequest(); request.withProjectId("{project_id}"); try { ShowWorkItemWrokflowConfigResponse response = client.showWorkItemWrokflowConfig(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 |
# 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 = ShowWorkItemWrokflowConfigRequest() request.project_id = "{project_id}" response = client.show_work_item_wrokflow_config(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 |
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.ShowWorkItemWrokflowConfigRequest{} request.ProjectId = "{project_id}" response, err := client.ShowWorkItemWrokflowConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。