调用GetWorkItemActivity查询工作项动态_云效(Apsara Devops)-阿里云帮助中心

查询工作项动态信息。

调试

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

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
workitemId	string	是	工作项 id，同 workitemIdentifier，工作项唯一标识	e8bxxxxxxxxxxxxxxxx23

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息	error
errorCode	string	错误码	Openapi.RequestError
success	boolean	true 或者 false	true
activities	array<object>	动态信息
	object
eventType	string	事件类型	workitem.updated
actionType	string	动作类型	update
eventTime	long	事件时间	1640867079624
resourceIdentifier	string	操作对象	e8bxxxxxxxxxxxxxxxx23
operator	string	操作者	19xx7043xxxxxxx914
eventId	long	事件 id	3201131
parentEventId	long	父事件 id	3201132
property	object	修改属性
propertyName	string	属性 key	subject
propertyType	string	类型	null
propertyIdentifier	string	资源 id	subject
displayName	string	属性的展示名	标题
oldValue	array<object>	更新前的值
	object	值实体
resourceType	string	修改值的类型，同 propertyName	Sprint
plainValue	string	旧值	bed1cca179badeb501a72d1194
displayValue	string	旧值的显示值	Sprint-221124
newValue	array<object>	更新后的值
	object	值实体
resourceType	string	修改值的类型，同 propertyName	Sprint
plainValue	string	新值	bed1cca179badeb501a72d1194
displayValue	string	新值的显示值	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	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

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

变更历史

变更时间	变更内容概要	操作
2022-10-28	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情