ListEstimatedEfforts,获取预计工时明细-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
项目协作	预计工时	只读

请求语法

中心版

GET https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/estimatedEfforts

Region版

GET https://{domain}/oapi/v1/projex/workitems/{id}/estimatedEfforts

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	工作项唯一标识。
organizationId	string	path	是：中心版否：Region版	organizationId。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/estimatedEfforts' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/workitems/{id}/estimatedEfforts' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
creator	object
id	string	用户 id。	674d96abd497cd558d68****
name	string	名称。	name-xxx
description	string	描述。	test
gmtCreate	string	创建时间。
gmtModified	string	修改时间。
id	string	id。	id-xxx
modifier	object
id	string	用户 id。	674d96abd497cd558d68****
name	string	名称。	name-xxx
owner	object
id	string	用户 id。	674d96abd497cd558d68****
name	string	名称。	name-xxx
spentTime	number	预计工时。	1.5
workType	string	工作项类别。	后端开发
workitemId	string	工作项 id。	beda1775d1c3eca7dbdff5****

返回示例

[
    {
        "creator": {
            "id": "674d96abd497cd558d68****",
            "name": "name-xxx"
        },
        "description": "test",
        "gmtCreate": "",
        "gmtModified": "",
        "id": "id-xxx",
        "modifier": {
            "id": "674d96abd497cd558d68****",
            "name": "name-xxx"
        },
        "owner": {
            "id": "674d96abd497cd558d68****",
            "name": "name-xxx"
        },
        "spentTime": 1.5,
        "workType": "后端开发",
        "workitemId": "beda1775d1c3eca7dbdff5****"
    }
]

错误码

访问错误码中心查看 API 相关错误码。