开发者社区 问答 正文

当actionType为associate时,阿里云OpenAPI如何查询具体关联的内容?

云效api 查询工作项动态信息 api,当actionType为associate时阿里云OpenAPI如何查询具体关联的内容?af7b22d3c88a2f5e2891b4332a606b3c.png

展开
收起
三分钟热度的鱼 2024-04-03 22:58:43 56 分享 版权
阿里云 AI 助理回答

在云效API中,查询工作项动态信息的接口为 GetWorkItemActivity,其主要功能是获取工作项的动态记录。当 actionTypeassociate 时,表示该动态记录与工作项的关联操作相关。以下是具体的操作步骤和说明:


1. 接口基本信息

  • 接口名称: GetWorkItemActivity
  • 请求方法: GET
  • 请求路径:
    /organization/{organizationId}/workitems/{workitemId}/getActivity
    
    • {organizationId}: 企业标识(组织ID),可在云效访问链接中获取。
    • {workitemId}: 工作项唯一标识,即工作项ID。

2. 请求参数

参数名类型是否必填描述
organizationIdstring企业标识,也称企业ID,字符串形式。
workitemIdstring工作项ID,同 workitemIdentifier,工作项唯一标识。

3. 返回参数解析

返回结果是一个动态记录列表,每条记录包含以下关键字段:
- actionType: 动作类型,可能值包括 createdupdateddeleteassociateunassociate 等。
- eventType: 事件类型,例如 workitem.association.changed 表示工作项关联发生变化。
- property: 属性信息,包含 propertyIdpropertyNamepropertyType
- relatedResource: 相关资源信息,包含 resourceIdresourceType
- 当 actionTypeassociate 时,relatedResource 字段会提供具体的关联内容,例如关联的工作项ID或资源类型。


4. 查询具体关联内容的步骤

actionTypeassociate 时,可以通过以下步骤获取具体的关联内容:

(1) 调用 GetWorkItemActivity 接口

使用上述请求路径和参数,调用接口获取工作项的动态记录。示例请求如下:

curl -X 'GET' \
  'https://{domain}/organization/{organizationId}/workitems/{workitemId}/getActivity' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

(2) 筛选 actionTypeassociate 的记录

从返回结果中筛选出 actionTypeassociate 的动态记录。例如:

[
    {
        "actionType": "associate",
        "eventId": 12345,
        "eventTime": "2023-10-01T12:00:00Z",
        "eventType": "workitem.association.changed",
        "relatedResource": {
            "resourceId": "workitem-id-xxx",
            "resourceType": "WORKITEM"
        }
    }
]

(3) 提取 relatedResource 字段

在筛选出的记录中,relatedResource 字段提供了具体的关联内容: - resourceId: 关联的工作项ID或其他资源ID。
- resourceType: 关联的资源类型,例如 WORKITEM 表示关联的是另一个工作项。


5. 注意事项

  • 权限要求: 调用接口时需提供有效的个人访问令牌(x-yunxiao-token),确保具备足够的权限访问目标工作项的动态信息。
  • 关联类型: 如果需要进一步确认关联的具体类型(如 PARENTSUBASSOCIATED 等),可以结合 GetWorkitemRelations 接口进行查询。

通过以上步骤,您可以准确查询到 actionTypeassociate 时的具体关联内容,并根据返回的 relatedResource 字段获取关联的工作项ID或资源信息。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答