UpdateWorkitemField - 更新工作项字段

更新时间: 2023-09-25 19:29:44

更新工作项字段,可以支持批量更新多个字段。

接口说明

批量更新工作项字段,只支持工作项上下文字段以及自定义字段,不能更新工作项本身属性(描述,标题,状态等,这些字段选择更新工作项属性字段)。

调试

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

调试

授权信息

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

请求语法

POST /organization/{organizationId}/workitems/updateWorkitemField

请求参数

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

企业id

60ee8a814690c27532d412f8
bodyobject

请求Body

workitemIdentifierstring

工作项id,同workitemId,工作项唯一标识

9144ef6b72d8exxxxx9e61a4d0
updateWorkitemPropertyRequestobject []

更新工作项属性请求,数组形式

fieldIdentifierstring

需要更新的工作项字段id,可以从获取工作项所有字段接口获取相应的数据

tag
fieldValuestring

需要更新字段的属性值 (注:1.如果是人员类型的值必须要填写aliyunPK。2.如果是含有待选值的字段,填写相应的待选值的id。 3.如果多个值,需要用" , "进行分割,拼接成一个字符串。

个人属性

返回参数

名称类型描述示例值
object
requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

error
errorCodestring

错误码

Openapi.RequestError
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

编号

1
gmtCreatelong

创建时间

1640850318000
gmtModifiedlong

修改时间

1640850318000
creatorstring

创建人

19xx7043xxxxxxx914
modifierstring

修改人

19xx7043xxxxxxx914
statusIdentifierstring

状态唯一标识id

28
sprintIdentifierstring

迭代的id

75528f17703e92e5a568......

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "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": "1",
    "gmtCreate": 1640850318000,
    "gmtModified": 1640850318000,
    "creator": "19xx7043xxxxxxx914",
    "modifier": "19xx7043xxxxxxx914",
    "statusIdentifier": "28",
    "sprintIdentifier": "75528f17703e92e5a568......"
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 云效2020 相关技术圈