查询需求关联的用例
功能介绍
查询需求关联的用例
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/iterators/{iterator_uri}/issues/cases/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
|
iterator_uri |
是 |
String |
迭代uri |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workitem_list |
是 |
Array of WorkItemInfo objects |
关联需求 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
work_item_id |
是 |
String |
参数解释 工作项编号 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
|
has_child |
是 |
Boolean |
参数解释 是否有子需求 约束限制 不涉及 取值范围 不涉及 默认取值 true:是 false:否 |
|
is_open |
是 |
Boolean |
参数解释 是否展开 约束限制 不涉及 取值范围 不涉及 默认取值 true:是 false:否 |
|
child_list |
否 |
Array of WorkItemInfo objects |
参数解释 子需求 约束限制 不涉及 取值范围 不涉及 默认取值 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
success|error |
|
result |
ResultValueListString object |
请求返回的数据 |
|
error |
ApiError object |
错误信息 |
|
request_id |
String |
由接口调用方传入，建议使用UUID保证请求的唯一性。 |
|
server_address |
String |
本次请求的受理的服务地址。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
Array of strings |
实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
每页展示条数 |
|
page_no |
Integer |
页码 |
|
has_more |
Boolean |
是否有更多 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 接口调用失败错误码 取值范围: 不涉及 |
|
error_msg |
String |
参数解释: 接口调用失败错误信息 取值范围: 不涉及 |
请求示例
post https://{endpoint}/v4/2e8b14eb90d54b6c9bc4c0b5cde1f449/iterators/2e8b14eb90/issues/cases/batch-query
{
"workitem_list": [
{
"value": "[{\"work_item_id\":2356888,\"has_child\":false,\"is_open\":false,\"child_list\":[]}]",
}
]
}
响应示例
状态码：200
OK
{
"status" : "string",
"result" : {
"total" : 0,
"value" : [ "string" ],
"reason" : "string",
"page_size" : 0,
"page_no" : 0,
"has_more" : true
},
"error" : { },
"request_id" : "string",
"server_address" : "string"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
