文档

GetWorkItemActivity - 查询工作项动态

查询工作项动态信息。

调试

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

授权信息

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

请求语法

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

请求参数

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

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

5ebbc0228123212b59xxxxx
workitemIdstring

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

e8bxxxxxxxxxxxxxxxx23

返回参数

名称类型描述示例值
object
requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误信息

error
errorCodestring

错误码

Openapi.RequestError
successboolean

true 或者 false

true
activitiesobject []

动态信息

eventTypestring

事件类型

workitem.updated
actionTypestring

动作类型

update
eventTimelong

事件时间

1640867079624
resourceIdentifierstring

操作对象

e8bxxxxxxxxxxxxxxxx23
operatorstring

操作者

19xx7043xxxxxxx914
eventIdlong

事件 id

3201131
parentEventIdlong

父事件 id

3201132
propertyobject

修改属性

propertyNamestring

属性 key

subject
propertyTypestring

类型

null
propertyIdentifierstring

资源 id

subject
displayNamestring

属性的展示名

标题
oldValueobject []

更新前的值

resourceTypestring

修改值的类型,同 propertyName

Sprint
plainValuestring

旧值

bed1cca179badeb501a72d1194
displayValuestring

旧值的显示值

Sprint-221124
newValueobject []

更新后的值

resourceTypestring

修改值的类型,同 propertyName

Sprint
plainValuestring

新值

bed1cca179badeb501a72d1194
displayValuestring

新值的显示值

Sprint-221124

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "activities": [
    {
      "eventType": "workitem.updated",
      "actionType": "update",
      "eventTime": 1640867079624,
      "resourceIdentifier": "e8bxxxxxxxxxxxxxxxx23",
      "operator": "19xx7043xxxxxxx914",
      "eventId": 3201131,
      "parentEventId": 3201132,
      "property": {
        "propertyName": "subject",
        "propertyType": "null",
        "propertyIdentifier": "subject",
        "displayName": "标题"
      },
      "oldValue": [
        {
          "resourceType": "Sprint",
          "plainValue": "bed1cca179badeb501a72d1194",
          "displayValue": "Sprint-221124"
        }
      ],
      "newValue": [
        {
          "resourceType": "Sprint",
          "plainValue": "bed1cca179badeb501a72d1194",
          "displayValue": "Sprint-221124"
        }
      ]
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-10-28OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈