创建工作项,可以用于创建项目下的工作项,包含(需求、缺陷、任务、风险、主题等)。
接口说明
填些的字段信息可以参考:获取工作项字段信息 以及 获取项目下工作项类型接口 两个接口。
描述区上传图片,整个描述区大小不能超过 5M,建议只上传小于 1M 的图片,请在接口 description 字段中插入如下格式: <img src="data:image/png;base64,*************************"/> 其中**为图片内容的 base64 编码,png 为图片的格式,按实际图片格式填写即可
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /organization/{organizationId}/workitem
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
body | object | 否 | 请求 Body | |
subject | string | 是 | 工作项标题 | 测试工作项 |
description | string | 否 | 描述,描述区上传图片,推荐只上传小于 1M 的图片,请在接口 description 字段中插入如下格式: <img src="data:image/png;base64,*************************"/> 其中**为图片内容的 base64 编码,png 为图片的格式,按实际图片格式填写即可 | 测试内容 |
assignedTo | string | 是 | 负责人 id | 19xxxx31947xxxx |
spaceIdentifier | string | 是 | 项目唯一标识 | asd345xxxxx9q9845xxxxx34 |
category | string | 是 | 工作项的类型 id,枚举值为:Req、Bug、Task、Topic | Req |
workitemTypeIdentifier | string | 是 | 工作项类型 id,可以通过获取工作项类型接口,查看对应项目下有哪些工作项类型可以选择 | 9uy29901re573f561d69jn40 |
fieldValueList | array<object> | 否 | 字段值列表,可以通过获取工作项字段列表接口获取对应工作项类型有哪些字段可以设置 | |
object | 否 | 字段值列表,可以通过获取工作项字段列表接口获取对应工作项类型有哪些字段可以设置 | ||
fieldIdentifier | string | 否 | 字段唯一标识 | 6aexxxxxa1d98c09c60xxxx16 |
value | string | 否 | 字段值 | 10 |
parentIdentifier | string | 否 | 父工作项 id | 11223331122 |
versions | array | 否 | 版本列表,填写版本的唯一标识列表 | |
string | 否 | 版本唯一标识 | [1111,1223] | |
sprintIdentifier | string | 否 | 迭代的唯一标识 id | 455532323455 |
tags | array | 否 | 标签列表,填写标签唯一标识列表 | |
string | 否 | 标签唯一标识,标签 id | ||
trackers | array | 否 | 抄送人 account id 列表 | |
string | 否 | 抄送人 account id | 1123344 | |
participants | array | 否 | 参与人 account id 列表 | |
string | 否 | 参与人 account id | 1234454 | |
verifier | string | 否 | 验证者的 account id | 1561159309...... |
返回参数
workitemIdentifier 为成功创建工作项后对应的工作项 id
示例
正常返回示例
JSON
格式
{
"requestId": "EAE03103-5497-58D1-9169-E524DDE8604C",
"errorCode": "InvalidTagGroup.IdNotFound",
"errorMessage": "SYSTEM_UNKNOWN_ERROR",
"success": "true",
"workitemIdentifier": "11234455454355"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Openapi.RequestError | request error | OpenAPI请求数据错误 |
403 | Operate.NoPermission | NoPermission | 没有权限 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-09-10 | OpenAPI 错误码发生变更 | 查看变更详情 |