文档

CreateWorkitemV2 - 创建工作项(需求/缺陷/任务)

更新时间:

创建工作项,可以用于创建项目下的工作项,包含(需求、缺陷、任务、风险、主题等)。

接口说明

填些的字段信息可以参考:获取工作项字段信息 以及 获取项目下工作项类型接口 两个接口。

描述区上传图片,整个描述区大小不能超过 5M,建议只上传小于 1M 的图片,请在接口 description 字段中插入如下格式: <img src="data:image/png;base64,*************************"/> 其中**为图片内容的 base64 编码,png 为图片的格式,按实际图片格式填写即可

调试

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

授权信息

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

请求语法

POST /organization/{organizationId}/workitem

请求参数

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

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

5ebbc0228123212b59xxxxx
bodyobject

请求 Body

subjectstring

工作项标题

测试工作项
descriptionstring

描述,描述区上传图片,推荐只上传小于 1M 的图片,请在接口 description 字段中插入如下格式: <img src="data:image/png;base64,*************************"/> 其中**为图片内容的 base64 编码,png 为图片的格式,按实际图片格式填写即可

测试内容
assignedTostring

负责人 id

19xxxx31947xxxx
spaceIdentifierstring

项目唯一标识

asd345xxxxx9q9845xxxxx34
categorystring

工作项的类型 id,枚举值为:Req、Bug、Task、Topic

Req
workitemTypeIdentifierstring

工作项类型 id,可以通过获取工作项类型接口,查看对应项目下有哪些工作项类型可以选择

9uy29901re573f561d69jn40
fieldValueListarray<object>

字段值列表,可以通过获取工作项字段列表接口获取对应工作项类型有哪些字段可以设置

object

字段值列表,可以通过获取工作项字段列表接口获取对应工作项类型有哪些字段可以设置

fieldIdentifierstring

字段唯一标识

6aexxxxxa1d98c09c60xxxx16
valuestring

字段值

10
parentIdentifierstring

父工作项 id

11223331122
versionsarray

版本列表,填写版本的唯一标识列表

string

版本唯一标识

[1111,1223]
sprintIdentifierstring

迭代的唯一标识 id

455532323455
tagsarray

标签列表,填写标签唯一标识列表

string

标签唯一标识,标签 id

[1112,3344]
trackersarray

抄送人 account id 列表

string

抄送人 account id

1123344
participantsarray

参与人 account id 列表

string

参与人 account id

1234454
verifierstring

验证者的 account id

1561159309......

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

EAE03103-5497-58D1-9169-E524DDE8604C
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

InvalidTagGroup.IdNotFound
errorMessagestring
  • 当 success 为 false,返回业务错误信息;

  • 当 success 为 true,返回空值。

SYSTEM_UNKNOWN_ERROR
successstring

true 或者 false

true
workitemIdentifierstring

工作项 id,唯一标识

11234455454355

workitemIdentifier 为成功创建工作项后对应的工作项 id

示例

正常返回示例

JSON格式

{
  "requestId": "EAE03103-5497-58D1-9169-E524DDE8604C",
  "errorCode": "InvalidTagGroup.IdNotFound",
  "errorMessage": "SYSTEM_UNKNOWN_ERROR",
  "success": "true",
  "workitemIdentifier": "11234455454355"
}

错误码

HTTP status code错误码错误信息描述
400Openapi.RequestErrorrequest errorOpenAPI请求数据错误
403Operate.NoPermissionNoPermission没有权限

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

变更历史

变更时间变更内容概要操作
2023-09-10OpenAPI 错误码发生变更查看变更详情