ListWorkitemRelationRecords,获取工作项关联项-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
项目协作	工作项相关项	只读

请求语法

中心版

GET https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/relationRecords

Region版

GET https://{domain}/oapi/v1/projex/workitems/{id}/relationRecords

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	工作项唯一标识。
organizationId	string	path	是：中心版否：Region版	organizationId。
relationType	string	query	是	关联类型，可选值为 PARENT、SUB、ASSOCIATED，DEPEND_ON, DEPENDED_BY 分别对应父项，子项，关联项，依赖项，支撑项。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/workitems/{id}/relationRecords?relationType={relationType}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/workitems/{id}/relationRecords?relationType={relationType}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
gmtCreate	string	创建关联的时间。
id	string	关联详细的 id。	beda1775d1c3eca7dbdff5****
relationType	string	关联的类型，可选值为 PARENT、SUB、ASSOCIATED，DEPEND_ON, DEPENDED_BY 分别对应父项，子项，关联项，依赖项，支撑项。	ASSOCIATED
resourceId	string	关联的资源 id。	beda1775d1c3eca7dbdff5****
resourceType	string	关联的资源类型。	WORKITEM

返回示例

[
    {
        "gmtCreate": "",
        "id": "beda1775d1c3eca7dbdff5****",
        "relationType": "ASSOCIATED",
        "resourceId": "beda1775d1c3eca7dbdff5****",
        "resourceType": "WORKITEM"
    }
]

错误码

访问错误码中心查看 API 相关错误码。