调用create创建工作项_云效-阿里云帮助中心

调试

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

请求语法

POST /organization/organizationId/workitems/create HTTP/1.1
Content-Type:application/json

{
  "subject" : "String",
  "description" : "String",
  "descriptionFormat" : "String",
  "assignedTo" : "String",
  "space" : "String",
  "spaceIdentifier" : "String",
  "spaceType" : "String",
  "category" : "String",
  "workitemType" : "String",
  "fieldValueList" : [ {
    "fieldIdentifier" : "String",
    "value" : "String",
    "workitemIdentifier" : "String"
  } ],
  "sprint" : [ "String" ],
  "tracker" : [ "String" ],
  "participant" : [ "String" ],
  "verifier" : [ "String" ],
  "parent" : "String"
}

请求参数

表 1. 请求Path参数
参数名称	类型	是否必选	示例	说明
organizationId	String	是	5ebbc0228123212b59xxxxx	企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】

表 2. 请求Body参数
参数名称	类型	是否必选	示例	说明
subject	String	是	测试工作项	工作项标题
description	String	否	测试内容	工作项内容
descriptionFormat	String	否	RICHTEXT	内容格式，目前只支持RICHTEXT格式
assignedTo	String	是	19xxxx31947xxxx	工作项负责人的id，或者企业中的用户名
space	String	是	asd345xxxxx9q9845xxxxx34	项目id唯一标识
spaceIdentifier	String	是	asd345xxxxx9q9845xxxxx34	同space字段，项目id唯一标识
spaceType	String	是	Project	资源类型
category	String	是	Req	工作项的类型id，比如：Bug、Task对应id
workitemType	String	是	9uyxxxxxre573f561dxxn40	工作项小类型id
fieldValueList	Array	是		自定义字段
fieldIdentifier	String	是	6aexxxxxa1d98c09c60xxxx16	字段唯一标识，优先级字段必填
value	String	是	77c7fb03c4186c8691d6...	字段值，写入时使用。优先级字段必填
workitemIdentifier	String	否	null	工作项的唯一标识，暂用不到
sprint	Array of String	否	81be62xxxxxb63e291bdcxxxxa4	迭代唯一标识id
tracker	Array of String	否	1561159309......	抄送人account id
participant	Array of String	否	1561159309......	参与人account id
verifier	Array of String	否	1561159309......	验证者的account id
parent	String	否	3a0c9cdd24ae1e1995b8...	父项工作项唯一标识

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "String",
  "errorMsg" : "String",
  "errorCode" : "String",
  "success" : Boolean,
  "workitem" : {
    "identifier" : "String",
    "subject" : "String",
    "document" : "String",
    "assignedTo" : "String",
    "status" : "String",
    "statusStageIdentifier" : "String",
    "spaceIdentifier" : "String",
    "spaceName" : "String",
    "spaceType" : "String",
    "logicalStatus" : "String",
    "categoryIdentifier" : "String",
    "parentIdentifier" : "String",
    "workitemTypeIdentifier" : "String",
    "updateStatusAt" : Long,
    "serialNumber" : "String",
    "gmtCreate" : Long,
    "gmtModified" : Long,
    "creator" : "String",
    "modifier" : "String",
    "statusIdentifier" : "String"
  }
}

响应参数

表 3. 响应Body参数
参数名称	类型	示例	说明
requestId	String	ASSDS-ASSASX-XSAXSA-XSAXSAXS	请求id，每次请求都是唯一值，便于后续排查问题
errorMsg	String	error	错误信息
errorCode	String	Openapi.RequestError	错误码
success	Boolean	true	true或者false
workitem	Object		工作项信息
identifier	String	e8bxxxxxxxxxxxxxxxx23	工作项唯一标识
subject	String	测试工作项	工作项标题
document	String	html格式	工作项内容
assignedTo	String	19xx7043xxxxxxx914	负责人的的阿里云accountId
status	String	待处理	状态名称
statusStageIdentifier	String	100005	状态阶段id
spaceIdentifier	String	e8b26xxxxx6e76aa20xxxxx23	所属项目id
spaceName	String	需求项目	所属项目名称
spaceType	String	Project	项目类型
logicalStatus	String	NORMAL	逻辑状态
categoryIdentifier	String	Req	工作项的类型id
parentIdentifier	String	e8bxxxxxxxxxxxxxxxx24	父工作项id
workitemTypeIdentifier	String	9uxxxxxxre573f5xxxxxx0	工作项类型id
updateStatusAt	Long	1640850328000	状态更新时间
serialNumber	String	ABCD-1	编号
gmtCreate	Long	1640850318000	创建时间的时间戳，单位毫秒
gmtModified	Long	1640850318000	修改时间的时间戳，单位毫秒
creator	String	19xx7043xxxxxxx914	创建人的阿里云accountId
modifier	String	19xx7043xxxxxxx914	修改人的阿里云accountId
statusIdentifier	String	28	状态唯一标识id
sprintIdentifier	String	75528f17703e92e5a568......	迭代的唯一标识id

示例1

{
    "subject":"测试需求",
    "description":"111",
    "descriptionFormat":"RICHTEXT",
    "assignedTo":"1967043931......",
    "assignedToIdentifier":"1967043931......",
    "spaceIdentifier":"8fb83debd69a6c7c6626......",
    "space":"8fb83debd69a6c7c6626......",
    "spaceType":"Project",
    "workitemTypeIdentifier":"9uy29901re573f561d......",
    "categoryIdentifier":"Req",
    "parent":"3a0c9cdd24ae1e1995b8...",
    "workitemType":"9uy29901re573f561d......",
    "category":"Req",
    "fieldValueList":[
        {
            "fieldIdentifier":"79",
            "value":"2022-02-19 00:00:00",
            "displayName":"计划开始时间"
        },
        {
            "fieldIdentifier":"80",
            "value":"2022-02-22 00:00:00",
            "displayName":"计划完成时间"
        },
        {
            "fieldIdentifier":"priority",
            "value":"77c7fb03c4186c8691d6......",
            "displayName":"优先级"
        }
    ],
    "attachmentIdList":[

    ],
    "cloneFrom":null,
    "participant":[
        "1967043931......,1967043931......"
    ],
    "tracker":[
        "1967043931......,1967043931......"
    ],
    "sprint":[
        "d1c676bcdfeba0e68432......"
    ],
    "tag":[
        "c76e0e4bf64801cfad73......"
    ]
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "success" : true,
  "errorCode" : "",
  "workitem" : {
    "identifier" : "3a0c9cdd24ae1e1995b8...",
    "statusStageIdentifier" : "1",
    "gmtModified" : 1643006693000,
    "creator" : "1967043931...",
    "serialNumber" : "ABCD-1",
    "spaceType" : "Project",
    "subject" : "1234567",
    "document" : "test",
    "modifier" : "1967043931...",
    "spaceIdentifier" : "7fb72727f32143574f7a...",
    "workitemTypeIdentifier" : "9uy29901re573f561d...",
    "categoryIdentifier" : "Req",
    "gmtCreate" : 1643006693191,
    "assignedTo" : "1967043931...",
    "spaceName" : "test00001",
    "logicalStatus" : "NORMAL",
    "status" : "待处理",
    "statusIdentifier" : "100005"
  },
  "errorMsg" : ""
}

错误码


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

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

开发者资源

SDK
阿里云为您提供多种语言的SDK，帮助您快速通过API集成阿里云的产品和服务，推荐您使用SDK调用API，已免除您手动签名验证。
OpenAPI Explorer
快速检索，可视化调试API，在线命令行工具，同步动态生成可执行的SDK代码示例。
阿里云CLI
阿里云资产管理和配置工具，可通过命令方式同时管理多个阿里云产品和服务，简单快捷，是您上云好帮手。