服務存取點與授權資訊
產品 | 資源 | 要求的權限 |
專案協作 | 迭代 | 唯讀 |
請求文法
Region版
GET https://{domain}/oapi/v1/projex/projects/{projectId}/sprints/{id}要求標頭
參數 | 類型 | 是否必填 | 描述 | 樣本值 |
x-yunxiao-token | string | 是 | 個人存取權杖。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 樣本值 |
projectId | string | path | 是 | 專案唯一標識。 | 589c53d622cc8521793e08**** |
id | string | path | 是 | 迭代唯一標識。 | 892153d622cc8521793e08**** |
請求樣本
Region版
curl -X 'GET' \
'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****/sprints/892153d622cc8521793e08****' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回參數
參數 | 類型 | 描述 | 樣本值 |
| - | object | ||
capacityHours | integer | 迭代工時容量(小時)。 | 100 |
| creator | object | 負責人。 | |
id | string | 使用者 id。 | 674d96abd497cd558d68**** |
name | string | 使用者名稱。 | user-name-xxx |
description | string | 描述。 | test |
endDate | string | 結束日期。 | |
gmtCreate | string | 建立時間的時間戳記。 | |
gmtModified | string | 更新時間的時間戳記。 | |
id | string | id。 | 1111 |
locked | boolean | 是否被鎖定。 | false |
| modifier | object | 負責人。 | |
id | string | 使用者 id。 | 674d96abd497cd558d68**** |
name | string | 使用者名稱。 | user-name-xxx |
name | string | 名稱。 | sprint-test |
| owners | array | 負責人。 | |
| - | object | 負責人。 | |
id | string | 使用者 id。 | 674d96abd497cd558d68**** |
name | string | 使用者名稱。 | user-name-xxx |
startDate | string | 開始日期。 | |
status | string | 狀態, TODO,DOING,ARCHIVED,分別對應未開始,進行中,已完成。 | TODO |
返回樣本
{
"capacityHours": 100,
"creator": {
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
},
"description": "test",
"endDate": "",
"gmtCreate": "",
"gmtModified": "",
"id": "1111",
"locked": false,
"modifier": {
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
},
"name": "sprint-test",
"owners": [
{
"id": "674d96abd497cd558d68****",
"name": "user-name-xxx"
}
],
"startDate": "",
"status": "TODO"
}錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。