ListEffortRecords,获取实际工时明细_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 获取实际工时明细。

适用版本

标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID 。
产品
资源
所需权限
产品
资源
所需权限
项目协作
实际工时
只读

请求语法

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

请求头

参数	类型	是否必填	描述	示例值

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

请求参数

参数	类型	位置	是否必填	描述	示例值

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	工作项唯一标识。
organizationId	string	path	是	organizationId。	5ebbc0228123212b59xxxxx

请求示例

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

返回参数

参数	类型	描述	示例值

参数	类型	描述	示例值
-	array
-	object
actualTime	number	时间工时。	1.5
creator	object
id	string	用户 id。	user-id-xxx
name	string	名称。	name-xxx
description	string	描述。	test
gmtCreate	string	创建时间。
gmtEnd	string	工作的结束日期。
gmtModified	string	修改时间。
gmtStart	string	工作的开始日期。
id	string	id。	id-xxx
modifier	object
id	string	用户 id。	user-id-xxx
name	string	名称。	name-xxx
owner	object
id	string	用户 id。	user-id-xxx
name	string	名称。	name-xxx
workType	string	工作类别。	后端开发
workitemId	string	工作项 id。	workitem-id-xxx

返回示例

[
    {
        "actualTime": 1.5,
        "creator": {
            "id": "user-id-xxx",
            "name": "name-xxx"
        },
        "description": "test",
        "gmtCreate": "",
        "gmtEnd": "",
        "gmtModified": "",
        "gmtStart": "",
        "id": "id-xxx",
        "modifier": {
            "id": "user-id-xxx",
            "name": "name-xxx"
        },
        "owner": {
            "id": "user-id-xxx",
            "name": "name-xxx"
        },
        "workType": "后端开发",
        "workitemId": "workitem-id-xxx"
    }
]

错误码

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

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