获取工作流的详情及每条流转线的详情
功能介绍
获取工作流的详情及每条流转线的详情。
调用方法
请参见如何调用API。
URI
GET /v1/ipdprojectservice/projects/{project_id}/workflow-template
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,^[A-Za-z0-9]{32}$。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
issue_category | 是 | String | 参数解释: 工作项类型。 约束限制: 正则表达式:"^(RR|IR|AR|SR|Bug|FE|Task|US|Epic|SF)"。 取值范围: RR、IR、AR、SR、Bug、FE、Task、US、Epic、SF 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
result | WorkflowTemplateVO object | 参数解释: 查询结果。 取值范围: 不涉及。 |
status | String | 参数解释: 状态码。 取值范围: 不涉及。 |
message | String | 参数解释: 响应信息。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
processNodes | Array of WorkflowTemplateNodesVO objects | 参数解释: 状态流中的状态信息。 取值范围: 不涉及。 |
processFlows | Array of WorkflowTemplateFlowsVO objects | 参数解释: 状态流中的流转线信息。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
before_rule_validator | Array of WorkflowTemplateConfigsVO objects | 参数解释: 流转前校验配置。 取值范围: 不涉及。 |
before_rule_configs | Array of WorkflowTemplateConfigsVO objects | 参数解释: 流转中界面配置。 取值范围: 不涉及。 |
from_code | String | 参数解释: 流转线的入口状态。 取值范围: 不涉及。 |
to_code | String | 参数解释: 流转线的出口状态。 取值范围: 不涉及。 |
请求示例
GEThttps://{endpoint}/v1/ipdprojectservice/projects/39d30be0842e4e5d8e28ee7e1712c6a2/workflow-template?issue_category=RR 响应示例
状态码:200
成功响应
{
"status" : "success",
"message" : null,
"result" : {
"process_nodes" : [ {
"code" : "Analyse",
"name" : "分析"
} ],
"process_flows" : [ {
"code" : "Analyse2ToBeConfirmed",
"name" : "退回",
"from_code" : "Analyse",
"to_code" : "ToBeConfirmed",
"before_rule_configs" : [ ],
"before_rule_validator" : [ ]
} ]
}
} 状态码
状态码 | 描述 |
|---|---|
200 | 成功响应 |
错误码
请参见错误码。

