CreateEffortRecord,登记实际工时-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

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

请求语法

中心版

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

Region版

POST https://{domain}/oapi/v1/projex/workitems/{id}/effortRecords

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	工作项唯一标识。
organizationId	string	path	是：中心版否：Region版	organizationId。
-	object	body	否
actualTime	number	body	是	实际工时。	1.5
description	string	body	否	工作描述。	描述内容
gmtEnd	string	body	是	工作开始结束日期。
gmtStart	string	body	是	工作开始日期。
operatorId	string	body	否	操作者的 useId，个人 token 时该参数无效。	操作者的 useId，个人 token 时该参数无效
workType	string	body	否	工作类型。	后端开发

请求示例

中心版

curl -X 'POST' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/effortRecords' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "actualTime": 1.5,
        "description": "描述内容",
        "gmtEnd": "",
        "gmtStart": "",
        "operatorId": "操作者的useId，个人token时该参数无效",
        "workType": "后端开发"
    }'

Region版

curl -X 'POST' \
  'https://{domain}/oapi/v1/projex/workitems/{id}/effortRecords' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "actualTime": 1.5,
        "description": "描述内容",
        "gmtEnd": "",
        "gmtStart": "",
        "operatorId": "操作者的useId，个人token时该参数无效",
        "workType": "后端开发"
    }'

返回参数

参数	类型	描述	示例值
-	object
id	string	id。	id-xxx

返回示例

{
    "id": "id-xxx"
}

错误码

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