使用CreateWorkitemEstimate接口为工作项创建预计工时-云效-阿里云

创建预计工时接口，登记一个工作项预计花费工时信息。

接口说明

创建预计工时接口。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /organization/{organizationId}/workitems/estimate

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
body	object	否	请求 Body
workitemIdentifier	string	是	工作项 id，同 workitemId	1e9903d8b3f1xxxxxf9286ef5
spentTime	string	是	花费工时，最大为 9999	21
type	string	是	工时类型，通过获得工时类型接口来获取，值为每一个类型的 identifier	9144ef6b72d8exxxxx9e61a4d0
description	string	否	描述	描述信息
recordUserIdentifier	string	是	登记人,为用户的 aliyunPk	1316458xxxxx41068

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息。	error
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	Openapi.RequestError
success	boolean	true 或者 false	true 接口调用成功，false 接口调用失败
WorkitemTimeEstimate	object	时间 estimate
identifier	string	工时唯一标识	deafe5f33xxxxx6a259d8dafd
workitemIdentifier	string	工作项 id，唯一标识	1e9903d8b3f1xxxxxf9286ef5
spentTime	long	预计花费工时	11
type	string	工时类型	9144ef6b72d8exxxxx9e61a4d0
description	string	描述	蜜雪冰城甜蜜蜜
recordUser	object	登记人信息
account	string	阿里云账户	1316458xxxxx41068
identifier	string	用户 id	deafe5f33xxxxx6a259d8dafd
realName	string	用户姓名	王五
nickName	string	用户昵称	王五
avatar	string	头像链接	https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
stamp	string	普通用户或者用户组	null 代表普通用户
nameEn	string	用户拼音	wangwu
gender	string	性别	保留字段
mobile	string	电话号码	无效字段，保留
email	string	邮箱信息	xxxxxxcc@xxx.com
nickNamePinyin	string	昵称拼音	wangwu
realNamePinyin	string	实际名称拼音	wangwu
displayNickName	string	展示昵称	wangwu
displayRealName	string	展示实际名称	wangwu
displayName	string	展示名称	王五
dingTalkId	string	钉钉 id	fdsad12xxx11
tbRoleId	string	角色 id	9144ef6b72d8exxxxx9e61a4d0
isDisabled	boolean	是否不可见	true/false

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "WorkitemTimeEstimate": {
    "identifier": "deafe5f33xxxxx6a259d8dafd",
    "workitemIdentifier": "1e9903d8b3f1xxxxxf9286ef5",
    "spentTime": 11,
    "type": "9144ef6b72d8exxxxx9e61a4d0",
    "description": "蜜雪冰城甜蜜蜜",
    "recordUser": {
      "account": "1316458xxxxx41068",
      "identifier": "deafe5f33xxxxx6a259d8dafd",
      "realName": "王五",
      "nickName": "王五",
      "avatar": "https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200",
      "stamp": "null 代表普通用户",
      "nameEn": "wangwu",
      "gender": "保留字段",
      "mobile": "无效字段，保留",
      "email": "xxxxxxcc@xxx.com",
      "nickNamePinyin": "wangwu",
      "realNamePinyin": "wangwu",
      "displayNickName": "wangwu",
      "displayRealName": "wangwu",
      "displayName": "王五",
      "dingTalkId": "fdsad12xxx11\n",
      "tbRoleId": "9144ef6b72d8exxxxx9e61a4d0",
      "isDisabled": true
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史