獲取工作項列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /organization/{organizationId}/listWorkitems HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| organizationId | string | 是 | 企業標識，也稱企業 id，字符串形式，可在云效訪問鏈接中獲取，如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
| spaceType | string | 是 | 資源類型 | Project |
| spaceIdentifier | string | 是 | 項目 id，同 projectId，項目唯一標識 id | 8fb83debd69a6c7c6626...... |
| category | string | 是 | 工作項大類型，需求為 Req，缺陷為 Bug，任務為 Task，風險為 Risk，原始訴求為 Request，主題為 Topic | Req |
| nextToken | string | 否 | 第一頁值不需要填寫，后面每一頁的值需要從前一次調用結果中獲取到此字段，然后獲取后面的分頁數據 | "" |
| maxResults | string | 否 | 每頁最大返回數量，0-200，默認值 20 | 20 |
| conditions | string | 否 | 過濾條件，可以參考頁面上的工作項列表中請求 workitem/list 的搜索參數。 注意：里面的人員 id，要為阿里云 accountID，即賬號 ID | {"conditionGroups":[]} |
| extraConditions | string | 否 | 額外條件，當該字段不為空時，conditions 也不能為空 | {"conditionGroups":[]} |
| groupCondition | string | 否 | 分組條件，可以參考頁面上的工作項列表中請求 workitem/list 的搜索參數。 注意：里面的人員 id，要為阿里云 accountID，即賬號 ID | {"fieldIdentifier":"tag","className":"tag","format":"multiList","value":["c76e0e4bf64801cfad73......"],"operator":"EQUALS"} |
| orderBy | string | 否 | 排序順序，可以參考頁面上的工作項列表中請求 workitem/list 的搜索參數。 注意：里面的人員 id，要為阿里云 accountID，即賬號 ID | {"fieldIdentifier":"status","format":"list","order":"desc","className":"status"} |
| searchType | string | 否 | 搜索類型，默認是 LIST，還可支持樹形 TREE 等類型，具體更多參見頁面請求的參數。 | LIST |
返回參數
示例
正常返回示例
JSON格式
{
"totalCount": 10,
"nextToken": "\"\"",
"maxResults": 20,
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorMsg": "error",
"errorCode": "Openapi.RequestError",
"success": true,
"workitems": [
{
"identifier": "e8bxxxxxxxxxxxxxxxx23",
"subject": "測試工作項",
"document": "xxx",
"assignedTo": "19xx7043xxxxxxx914",
"status": "待處理",
"statusStageIdentifier": "1",
"spaceIdentifier": "e8b26xxxxx6e76aa20xxxxx23",
"spaceName": "需求項目",
"spaceType": "Project",
"logicalStatus": "NORMAL",
"categoryIdentifier": "Req",
"parentIdentifier": "e8bxxxxxxxxxxxxxxxx24",
"workitemTypeIdentifier": "9uxxxxxxre573f5xxxxxx0",
"updateStatusAt": 1640850328000,
"serialNumber": "ABCD-1",
"gmtCreate": 1640850318000,
"gmtModified": 1640850318000,
"creator": "19xx7043xxxxxxx914",
"modifier": "19xx7043xxxxxxx914",
"statusIdentifier": "100005",
"sprintIdentifier": "75528f17703e92e5a568......",
"finishTime": 1699366778000
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Openapi.RequestError | request error | OpenAPI請求數據錯誤 |
| 403 | Operate.NoPermission | NoPermission | 沒有權限 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-11-07 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |