服務存取點與授權資訊
|
產品 |
資源 |
要求的權限 |
|
測試管理 |
測試計劃 |
唯讀 |
請求文法
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 相關錯誤碼。