文档

CreateWorkitemEstimate - 创建工作项预计工时接口

更新时间:

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

接口说明

创建预计工时接口。

调试

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

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/estimate

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

5ebbc0228123212b59xxxxx
bodyobject

请求 Body

workitemIdentifierstring

工作项 id,同 workitemId

1e9903d8b3f1xxxxxf9286ef5
spentTimestring

花费工时,最大为 9999

21
typestring

工时类型,通过获得工时类型接口来获取,值为每一个类型的 identifier

9144ef6b72d8exxxxx9e61a4d0
descriptionstring

描述

描述信息
recordUserIdentifierstring

登记人,为用户的 aliyunPk

1316458xxxxx41068

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息。

error
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

Openapi.RequestError
successboolean

true 或者 false

true 接口调用成功,false 接口调用失败
WorkitemTimeEstimateobject

时间 estimate

identifierstring

工时唯一标识

deafe5f33xxxxx6a259d8dafd
workitemIdentifierstring

工作项 id,唯一标识

1e9903d8b3f1xxxxxf9286ef5
spentTimelong

预计花费工时

11
typestring

工时类型

9144ef6b72d8exxxxx9e61a4d0
descriptionstring

描述

蜜雪冰城甜蜜蜜
recordUserobject

登记人信息

accountstring

阿里云账户

1316458xxxxx41068
identifierstring

用户 id

deafe5f33xxxxx6a259d8dafd
realNamestring

用户姓名

王五
nickNamestring

用户昵称

王五
avatarstring

头像链接

https://tcs-devops.aliyuncs.com/thumbnail/112m7150e256dbba0d6456bafbb65c81f90d/w/200/h/200
stampstring

普通用户或者用户组

null 代表普通用户
nameEnstring

用户拼音

wangwu
genderstring

性别

保留字段
mobilestring

电话号码

无效字段,保留
emailstring

邮箱信息

xxxxxxcc@xxx.com
nickNamePinyinstring

昵称拼音

wangwu
realNamePinyinstring

实际名称拼音

wangwu
displayNickNamestring

展示昵称

wangwu
displayRealNamestring

展示实际名称

wangwu
displayNamestring

展示名称

王五
dingTalkIdstring

钉钉 id

fdsad12xxx11
tbRoleIdstring

角色 id

9144ef6b72d8exxxxx9e61a4d0
isDisabledboolean

是否不可见

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错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

变更历史

变更时间变更内容概要操作
暂无变更历史