文档

GetWorkItemInfo - 获取工作项基本信息

更新时间:

获取工作项的基本信息。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/workitems/{workitemId}

请求参数

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

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

5e706xxxxxx01xxx96
workitemIdstring

工作项 id,同 workitemIdentifier 字段,工作项唯一标识,可以在获取工作项列表的接口 ListWorkItems 中获取

ce2xxxx21580baxxxx633f13

返回参数

名称类型描述示例值
object

工作项请求结果

requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误码

Openapi.RequestError
errorMessagestring

错误信息

error
successboolean

true 或者 false

true
workitemobject

工作项信息

identifierstring

工作项唯一标识

e8bxxxxxxxxxxxxxxxx23
subjectstring

工作项标题

测试工作项
documentstring

工作项内容

html格式
documentFormatstring

工作项内容格式,支持 RICHTEXT 和 MARKDOWN

RICHTEXT
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

工作项在项目中的编号

ABCD-1
gmtCreatelong

创建时间的时间戳,单位毫秒

1640850318000
gmtModifiedlong

修改时间的时间戳,单位毫秒

1640850318000
creatorstring

创建人的阿里云 accountId

19xx7043xxxxxxx914
modifierstring

修改人的阿里云 accountId

19xx7043xxxxxxx914
statusIdentifierstring

状态 id

例:100005
sprintarray

关联的迭代 id

string

迭代唯一标识

81be626abf9b63e291bd......
tagarray

标签 ID 列表

string

tag 的唯一标识

c76e0e4bf64801cfad73......
participantarray

参与人 account id 列表

string

参与人 account id

1561159309......
trackerarray

抄送人的 account id 列表

string

抄送人的 account id

1561159309......
verifierarray

验证者的 account id 列表

string

验证者的 account id

1561159309......
customFieldsobject []

自定义字段列表

fieldIdentifierstring

字段的唯一标识

例:80
fieldFormatstring

字段格式,便于查询数据

例:input
fieldClassNamestring

字段的 className,便于数据查询

例如:date
objectValuestring

值对象列表

null
valuestring

字段值,写入时使用

例:2022-01-06 00:00:00
workitemIdentifierstring

工作项的唯一标识

5daa9a15c7fd55523996......
positionlong

自定义字段值的 position

1
levellong

展示级别,数字范围 1~9,数字越大,颜色越浅。

1
valueListobject []

值对象列表,查询时使用

valuestring

字段值

2022-02-01 00:00:00
valueEnstring

字段英文值,目前只有列表类有英文值

null
displayValuestring

根据语言环境获取当前展示的值

2022-02-01 00:00:00
identifierstring

字段值为对象类型时,值所对应的对象的唯一标识例如:option 表中的 id

2022-02-01 00:00:00
levellong

展示级别,数字范围 1~9,数字越大,颜色越浅。

1
finishTimelong

完成时间

1699366778000
tagDetailsobject []

标签详情

identifierstring

标签唯一标识

8d859b4fce9d86bc324a9cf00c
namestring

标签名称

paymentcenter
colorstring

标签颜色

#1F9AEF

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "Openapi.RequestError",
  "errorMessage": "error",
  "success": true,
  "workitem": {
    "identifier": "e8bxxxxxxxxxxxxxxxx23",
    "subject": "测试工作项",
    "document": "html格式",
    "documentFormat": "RICHTEXT",
    "assignedTo": "19xx7043xxxxxxx914",
    "status": "待处理",
    "statusStageIdentifier": "1",
    "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": "例:100005",
    "sprint": [
      "81be626abf9b63e291bd......"
    ],
    "tag": [
      "c76e0e4bf64801cfad73......"
    ],
    "participant": [
      "1561159309......"
    ],
    "tracker": [
      "1561159309......"
    ],
    "verifier": [
      "1561159309......"
    ],
    "customFields": [
      {
        "fieldIdentifier": "例:80",
        "fieldFormat": "例:input",
        "fieldClassName": "例如:date",
        "objectValue": "null",
        "value": "例:2022-01-06 00:00:00",
        "workitemIdentifier": "5daa9a15c7fd55523996......",
        "position": 1,
        "level": 1,
        "valueList": [
          {
            "value": "2022-02-01 00:00:00",
            "valueEn": "null",
            "displayValue": "2022-02-01 00:00:00",
            "identifier": "2022-02-01 00:00:00",
            "level": 1
          }
        ]
      }
    ],
    "finishTime": 1699366778000,
    "tagDetails": [
      {
        "identifier": "8d859b4fce9d86bc324a9cf00c",
        "name": "paymentcenter",
        "color": "#1F9AEF"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-04-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2024-02-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-11-07OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)