服务接入点与授权信息
|
产品 |
资源 |
所需权限 |
|
测试管理 |
测试计划 |
只读 |
请求语法
Region版
POST https://{domain}/oapi/v1/projex/testPlan/list请求头
|
参数 |
类型 |
是否必填 |
描述 |
示例值 |
|
x-yunxiao-token |
string |
是 |
个人访问令牌。 |
pt-0fh3****0fbG_35af****0484 |
请求参数
|
参数 |
类型 |
位置 |
是否必填 |
描述 |
示例值 |
|
page |
integer |
query |
否 |
分页参数，第几页，默认为1。 |
|
|
perPage |
integer |
query |
否 |
分页参数，每页大小，最大1000，默认为1000。 |
|
|
sprintIdentifier |
string |
query |
否 |
迭代 identifier，传入则只返回该迭代下的测试计划。 |
|
|
projectIdentifier |
string |
query |
否 |
项目 identifier；与 sprintIdentifier 同时传入时用于校验迭代是否属于该项目；仅传此项则按项目筛选测试计划。 |
|
|
status |
string |
query |
否 |
测试计划状态，可选值 TODO,DOING,DONE。可多选，以逗号分割。 |
DOING,DONE |
|
name |
string |
query |
否 |
测试计划名称（模糊条件）。 |
请求示例
Region版
curl -X 'POST' \
'https://{domain}/oapi/v1/projex/testPlan/list?page={page}&perPage={perPage}&sprintIdentifier={sprintIdentifier}&projectIdentifier={projectIdentifier}&status={status}&name={name}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回参数
|
参数 |
类型 |
描述 |
示例值 |
| - |
array |
||
| - |
object |
||
|
gmtCreate |
string |
创建时间的时间戳。 |
|
|
managers |
array[string] |
测试计划管理员 id。 |
|
|
spaceIdentifier |
string |
关联项目 id。 |
|
|
testPlanIdentifier |
string |
测试计划 id。 |
返回示例
[
{
"gmtCreate": "",
"managers": [
],
"name": "",
"spaceIdentifier": "",
"testPlanIdentifier": ""
}
]响应头
|
参数 |
描述 |
示例值 |
|
x-next-page |
下一页。 |
|
|
x-page |
当前页。 |
|
|
x-per-page |
每页数据条数。 |
|
|
x-prev-page |
上一页。 |
|
|
x-total |
总数据量。 |
|
|
x-total-pages |
总分页数。 |
错误码
访问错误码中心查看 API 相关错误码。