根据快照版本ID和特性集ID查询特性,会根据传入的特性集ID检索所有的子特性集 - ShowSnapshotsFeature
功能介绍
根据快照版本ID和特性集ID查询特性,会根据传入的特性集ID检索所有的子特性集。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
GET /v1/ipdprojectservice/projects/{project_id}/snapshots-feature/query
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 32个字符,由英文字母和数字组成。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| snapshot_version_id | 是 | String | 特性集快照版本ID |
| feature_set_id | 是 | String | 特性集ID,会根据当前id往下检索,传入根节点ID,则查询所有的特性集数据 |
| offset | 否 | Integer | 参数解释: 分页起始位置,从0开始,需为limit的整数倍。 约束限制: 取值为limit的倍数。 取值范围: ≥ 0。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 每页返回的数据条数。 约束限制: 不涉及。 取值范围: 1~200。 默认取值: 20。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | IssueEntityPageResult object | 参数解释: 工作项树形列表接口。 |
| status | String | 参数解释: 返回状态。 取值范围: |
| message | String | 参数解释: 查询失败的原因。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| issues | Array of IssueInfoVO objects | 参数解释: 工作项列表。 |
| total | Integer | 参数解释: 工作项总数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 需要更新的工作项ID。 取值范围: 不涉及。 |
| title | String | 参数解释: 工作项标题。 取值范围: 不涉及。 |
| description | String | 参数解释: 工作项描述字段。 取值范围: 不涉及。 |
| type | String | 参数解释: 工作项大分类定义。 取值范围: requirement(研发需求),bug(缺陷),task(任务),feature(特性),raw_requirement(原始需求)。 |
| number | String | 参数解释: 工作项编号。 取值范围: 不涉及。 |
| category | String | 参数解释: 工作项类型。 取值范围: 支持多种工作项类型,使用英文逗号分隔。 |
| parent_id | String | 参数解释: 父工作项ID。 取值范围: 不涉及。 |
| project_id | String | 参数解释: 项目的32位UUID,项目唯一标识。 取值范围: 不涉及 |
| status | String | 参数解释: 工作项状态code。 取值范围: Start:初始态。 Analyse:待分析。 Develop:开发中。 Test:测试中。 Finish:已完成。 |
| state | String | 参数解释: 工作项的生命周期。 取值范围: |
| assignee | UserEntity object | 参数解释: 工作项责任人。 |
| assigned_cc | Array of UserEntity objects | 参数解释: 工作项抄送人,支持多个抄送人。同一工作项最多支持50个抄送人。 |
| created_by | UserEntity object | 参数解释: 工作项创建人。 |
| created_time | String | 参数解释: 工作项创建时间,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| modified_by | UserEntity object | 参数解释: 工作项最近更新人。 |
| modified_time | String | 参数解释: 工作项最近更新时间,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| plan_end_date | String | 参数解释: 工作项计划结束日期,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| close_time | String | 参数解释: 工作项关闭时间,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| workload | String | 参数解释: 工作项计划工时,保留一位小数,取值范围为0~999999999.9。 取值范围: 0~999999999.9。 |
| workload_sum | String | 参数解释: 工作项实际工时。 取值范围: 0~999999999.9。 |
| tenant_id | String | 参数解释: 工作项所属租户ID,可通过查询树状工作项接口获取,响应消息体中的tenant_id字段的值就是工作项所属租户ID。 取值范围: 不涉及。 |
| link | String | 参数解释: 工作项关联项ID。 取值范围: 不涉及。 |
| suspended | Boolean | 参数解释: 工作项是否已挂起。 取值范围: true,false。 |
| status_modified_time | String | 参数解释: 工作项状态改变时间,可用于计算工作项在当前状态停留天数,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| labels | Array of LabelEntity objects | 参数解释: 工作项标签。 |
| custom_fields | Array of FieldCodeValuePair objects | 参数解释: 工作项自定义字段映射,用户添加的系统字段也在此列。 { "code":"字段code", "value":"字段值" }。 |
| children | Array of IssueInfoVO objects | 参数解释: 工作项的子工作项集合。 |
| path | String | 参数解释: 子工作项的路径。 取值范围: 不涉及。 |
| ir2feature | String | 参数解释: IR和SF的关联字段。 |
| need_break | String | 参数解释: 工作项是否需要分解。 取值范围: |
| break_status | String | 参数解释: 分解状态。 已分解(decomposed) 未分解(undecomposed) 不涉及( --)。 取值范围: decomposed,undecomposed,--。 |
| baseline | String | 参数解释: 工作项基线状态。 取值范围: |
| priority | String | 参数解释: 工作项优先级,部分工作项有此字段。 取值范围: |
| related_network_security | String | 参数解释: 是否涉及网络安全。 取值范围: |
| collaboratives | String | 参数解释: 研发需求协同信息,协同任务ID,可通过查询树状工作项接口获取,响应消息体中的collaboratives字段的值就是研发需求协同信息,协同任务ID。 取值范围: 不涉及。 |
| business_domain | String | 参数解释: 领域字段。 取值范围: |
| plan_pi | String | 参数解释: 工作项发布计ID。 取值范围: 不涉及。 |
| plan_iteration | String | 参数解释: 工作项完成的迭代计划ID,在Bug中为修复迭代计划ID。 取值范围: 不涉及。 |
| change_status | String | 参数解释: 工作项变更状态。 变更评审中(change-reviewing) 已变更(changed) 未变更(unchange或null)。 取值范围: change-reviewing,changed,unchange,null。 |
| no_break_reason | String | 参数解释: 无需分解原因。 取值范围: 0~512个字符。 |
| submitted_by | Array of UserEntity objects | 参数解释: 工作项提出人。 |
| ir2rr | String | 参数解释: IR关联的RR ID,多选时用英文逗号分隔。 取值范围: 不涉及。 |
| feature_set | String | 参数解释: 特性集ID。 取值范围: 不涉及。 |
| expected_repair_date | String | 参数解释: 期望修复时间。预设字段中,仅Bug有此字段,unix时间戳,单位:毫秒。 取值范围: 不涉及。 |
| found_pi | String | 参数解释: 缺陷发现发布计划ID,预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| found_iteration | String | 参数解释: 缺陷发现迭代计划ID,预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| reason_analysis | String | 参数解释: 分析原因。 取值范围: 0~50000个字符。 |
| repair_solution | String | 参数解释: 修复方案。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| test_report | String | 参数解释: 测试报告。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| sys_no_repair_reason | String | 参数解释: 无需修复原因。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| sys_activation_reason | String | 参数解释: 激活原因。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| sys_return_reason | String | 参数解释: 退回原因。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| test_failures_times | Integer | 参数解释: 回归不通过次数。预设字段中,仅Bug有此字段。 取值范围: 不涉及。 |
| close_type | String | 参数解释: 关闭类型。预设字段中,仅Bug有此字段,可选值为problem_solved,problem_to_requirement,duplicate_problem,not_a_problem。分别对应问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭。 取值范围: problem_solved,problem_to_requirement,duplicate_problem,not_a_problem。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 用户ID,可通过查询项目成员列表接口获取,响应消息体中的id字段的值就是用户ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 用户名称。 取值范围: 2~64个字符。 |
| nick_name | String | 参数解释: 用户昵称。 取值范围: 2~30个字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 标签ID,可通过查询标签列表接口获取,响应消息体中的id字段的值就是标签ID。 取值范围: 18~19个字符的数字字符串。 |
| category_types | Array of strings | 参数解释: 标签所属工作项类型编码。 |
| label_type | String | 参数解释: 标签所属工作项类型,对应工作项的type字段,枚举类型。 取值范围: |
| color | String | 参数解释: 标签颜色RGB。 取值范围: 可选颜色代码与对应中文描述如下: |
| title | String | 参数解释: 标签标题。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 工作项自定义字段code值。可选值可以通过查询字段模板列表接口获取,响应体中的code就是字段唯一标识。 取值范围: 不涉及。 |
| value | String | 参数解释: 工作项自定义字段值。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述,对error_code的补充解释。 取值范围: 不涉及。 |
请求示例
根据快照版本ID和特性集ID查询特性
GET https://{endpoint}/v1/ipdprojectservice/projects/b7262b36cfa84b09a27f7896e1fdefc6/snapshots-feature/query?snapshot_version_id=982005155140513792&feature_set_id=981644262727655424&offset=0&limit=1 响应示例
状态码:200
工作项数据通用返回体
{
"status" : "success",
"message" : null,
"result" : {
"issues" : [ {
"category" : "SF",
"id" : "981645249521557504",
"title" : "SF",
"description" : "<p>【特性背景】</p><p><br></p><p>【特性价值】</p><p><br></p><p>【特性详情】</p>",
"type" : "feature",
"number" : "SF20240401737955",
"project_id" : "b7262b36cfa84b09a27f7896e1fdefc6",
"status" : "Start",
"state" : "正在工作",
"assignee" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"created_time" : "1711972065000",
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "测试账号"
},
"modified_time" : "1712019887000",
"tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
"link" : "",
"status_modified_time" : "1711972065000",
"custom_fields" : [ ],
"path" : "/981645249521557504",
"priority" : "中",
"feature_set" : "981644805718056960"
} ],
"total" : 5
}
} 状态码:400
请求失败的响应。例如无操作权限、项目不存在。
{
"error_code" : "PM.02174103",
"error_msg" : "无操作权限"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 工作项数据通用返回体 |
| 400 | 请求失败的响应。例如无操作权限、项目不存在。 |
错误码
请参见错误码。