创建工作项。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /organization/{organizationId}/workitems/create
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 5ebbc0228123212b59xxxxx |
body | object | 否 | 请求结构。 | |
subject | string | 是 | 工作项标题 | 测试工作项 |
description | string | 否 | 工作项内容 | 测试内容 |
descriptionFormat | string | 否 | 内容格式,支持 RICHTEXT 和 MARKDOWN 格式,默认为 RICHTEXT | RICHTEXT |
assignedTo | string | 是 | 工作项负责人的 id,或者企业中的用户名 | 19xxxx31947xxxx |
space | string | 是 | 项目 ID 唯一标识,同 projectId | asd345xxxxx9q9845xxxxx34 |
spaceIdentifier | string | 是 | 同 space 字段,项目 ID 唯一标识 | asd345xxxxx9q9845xxxxx34 |
spaceType | string | 是 | 资源类型 | Project |
category | string | 是 | 工作项的类型 id,比如:Bug、Task 对应 id | Req |
workitemType | string | 是 | 工作项小类型 id | 9uyxxxxxre573f561dxxn40 |
fieldValueList | array<object> | 否 | 自定义字段 | |
object | 否 | 需要先通过获取工作项字段的接口:ListWorkItemAllFields 查看哪些字段是必填,isRequired 为 true 的则为必填。 【优先级】,虽然是自定义字段,但是必填 | ||
fieldIdentifier | string | 否 | 字段唯一标识,优先级字段必填 | 6aexxxxxa1d98c09c60xxxx16 |
value | string | 否 | 字段值,写入时使用。优先级字段必填 | 77c7fb03c4186c8691d6... |
workitemIdentifier | string | 否 | 工作项的唯一标识,暂用不到 | null |
sprint | array | 否 | 要关联迭代 | |
string | 否 | 迭代唯一标识 id | 81be62xxxxxb63e291bdcxxxxa4 | |
tracker | array | 否 | 抄送人 account id | |
string | 否 | 抄送人 account id | 1561159309...... | |
participant | array | 否 | 参与人 account id | |
string | 否 | 参与人 account id | 1561159309...... | |
verifier | array | 否 | 验证者的 account id | |
string | 否 | 验证者的 account id | 1561159309...... | |
parent | string | 否 | 父项工作项唯一标识 | 3a0c9cdd24ae1e1995b8... |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"errorMsg": "error",
"errorCode": "Openapi.RequestError",
"success": true,
"workitem": {
"identifier": "e8bxxxxxxxxxxxxxxxx23",
"subject": "测试工作项",
"document": "html格式",
"assignedTo": "19xx7043xxxxxxx914",
"status": "待处理",
"statusStageIdentifier": "100005",
"spaceIdentifier": "e8b26xxxxx6e76aa20xxxxx23",
"spaceName": "需求项目",
"spaceType": "Project",
"logicalStatus": "NORMAL",
"categoryIdentifier": "Req",
"parentIdentifier": "e8bxxxxxxxxxxxxxxxx24",
"workitemTypeIdentifier": "9uxxxxxxre573f5xxxxxx0",
"updateStatusAt": 1640850328000,
"serialNumber": "ABCD-1",
"gmtCreate": 1640850318000,
"gmtModified": 1640850318000,
"creator": "19xx7043xxxxxxx914",
"modifier": "19xx7043xxxxxxx914",
"statusIdentifier": "28",
"sprintIdentifier": "75528f17703e92e5a568......",
"documentFormat": "RICHTEXT"
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Openapi.RequestError | request error | OpenAPI请求数据错误 |
403 | Operate.NoPermission | NoPermission | 没有权限 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-19 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-12-05 | OpenAPI 错误码发生变更 | 查看变更详情 |