UpdateWorkItem - 更新工作项信息

更新时间: 2023-09-25 19:27:58

更新工作项信息。

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/update

请求参数

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

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

5ebbc0228123212b59xxxxx
bodyobject

更新的信息

propertyKeystring

要更新的字段identifier,可以从ListWorkItemAllFields获取

subject
propertyValuestring

更新后的值

newValue
identifierstring

工作项id,同workitemIdentifier,workitemId字段,工作项唯一标识

e8b2xxxxxx2abdxxxxxxxx23
fieldTypestring

更新字段的类型,subject代表修改标题; status代表修改是状态字段 ;document代表的是修改描述字段;user代表的是修改用户类型字段(包括负责人、参与人等用户类型的字段);customField代表的是自定义字段 ;其中user对应的propertykey对应有三种workitem.tracke/ ak.issue.member/assignedTo ; customField字段类型中property值需要通过ListWorkItemAllFields来获取type类型为customField对应的identifier,其余的propertykey和Fieldtype是一样的。

subject

返回参数

名称类型描述示例值
object

工作项请求结果

requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

error
successboolean

true或者false

true
workitemobject

工作项信息

identifierstring

工作项唯一标识

e8bxxxxxxxxxxxxxxxx23
subjectstring

工作项标题

测试工作项
documentstring

工作项内容

html格式
assignedTostring

负责人

19xx7043xxxxxxx914
statusstring

状态名称

待处理
statusStageIdentifierstring

状态阶段id

1
spaceIdentifierstring

所属项目id

e8b26xxxxx6e76aa20xxxxx23
spaceNamestring

所属项目名称

需求项目
spaceTypestring

项目类型

Project
logicalStatusstring

逻辑状态

NORMAL
categoryIdentifierstring

工作项的类型id

Req
parentIdentifierstring

父工作项id

e8bxxxxxxxxxxxxxxxx24
workitemTypeIdentifierstring

工作项类型id

9uxxxxxxre573f5xxxxxx0
updateStatusAtlong

状态更新时间

1640850328000
serialNumberstring

工作项编号

ACFS-1
gmtCreatelong

创建时间

1640850318000
gmtModifiedlong

修改时间

1640850318000
creatorstring

创建人

19xx7043xxxxxxx914
modifierstring

修改人

19xx7043xxxxxxx914
statusIdentifierstring

状态id

111000
sprintIdentifierstring

迭代id

75528f17703e92e5a568......

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "error",
  "success": true,
  "workitem": {
    "identifier": "e8bxxxxxxxxxxxxxxxx23",
    "subject": "测试工作项",
    "document": "html格式",
    "assignedTo": "19xx7043xxxxxxx914",
    "status": "待处理",
    "statusStageIdentifier": "1",
    "spaceIdentifier": "e8b26xxxxx6e76aa20xxxxx23",
    "spaceName": "需求项目",
    "spaceType": "Project",
    "logicalStatus": "NORMAL",
    "categoryIdentifier": "Req",
    "parentIdentifier": "e8bxxxxxxxxxxxxxxxx24",
    "workitemTypeIdentifier": "9uxxxxxxre573f5xxxxxx0",
    "updateStatusAt": 1640850328000,
    "serialNumber": "ACFS-1",
    "gmtCreate": 1640850318000,
    "gmtModified": 1640850318000,
    "creator": "19xx7043xxxxxxx914",
    "modifier": "19xx7043xxxxxxx914",
    "statusIdentifier": "111000",
    "sprintIdentifier": "75528f17703e92e5a568......"
  }
}

错误码

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

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

阿里云首页 云效2020 相关技术圈