文档

GetWorkitemRelations - 获得工作项关联项

更新时间:

获得工作项关联项。

接口说明

获得工作项关联项。

调试

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

授权信息

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

请求语法

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

请求参数

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

企业 id

5ebbc0228123212b59xxxxx
workitemIdstring

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

8876ad01xxxxx65d9710b2631
relationTypestring

一共有 BLOCKING,BLOCKED,ASSOCIATED, DUPLICATED,SUB, PARENT,一共 6 个待选值,只会获得工作项类型的关系项

一共有BLOCKING,BLOCKED,ASSOCIATED, DUPLICATED,SUB, PARENT,一共6个待选值,只会获得工作项类型的关系项

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsgstring

错误描述信息。

error
errorCodestring
  • 当 success 为 false,返回业务错误码;

  • 当 success 为 true,返回空值。

InvalidGroup.IdNotFound
successboolean

请求是否成功。

  • true:成功

  • false:失败

true
relationListarray<object>

置顶关联项信息

object

工作项信息

identifierstring

工作项 id

deafe5f33xxxxx6a259d8dafd
subjectstring

工作项标题

标题内容
assignedTostring

负责人 aliyunPk

aliyun_1384605
spaceIdentifierstring

所属项目 id

2b856dxxxxxxb61d93676255ba
categoryIdentifierstring

工作项的类型 id

Req
workitemTypeIdentifierstring

工作项类型 id

9uy29901re573f561d69jn40
gmtCreatestring

创建时间

1667205617061
gmtModifiedstring

修改时间

1667205617089

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "InvalidGroup.IdNotFound",
  "success": true,
  "relationList": [
    {
      "identifier": "deafe5f33xxxxx6a259d8dafd",
      "subject": "标题内容",
      "assignedTo": " aliyun_1384605",
      "spaceIdentifier": "2b856dxxxxxxb61d93676255ba",
      "categoryIdentifier": "Req",
      "workitemTypeIdentifier": "9uy29901re573f561d69jn40",
      "gmtCreate": "1667205617061",
      "gmtModified": "1667205617089"
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史