文档

ListProjectWorkitemTypes - 获取工作项类型

更新时间:

获取项目中的工作项类型。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/projects/{projectId}/getWorkitemType

请求参数

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

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

5ebbc0228123212b59xxxxx
projectIdstring

项目 id,同 spaceIdentifier,项目唯一标识

asd345xxxxx9q9845xxxxx34
spaceTypestring

空间类型,这里填 Project 即可。

Project
categorystring

工作项类型,需求为 Req,缺陷为 Bug,任务为 Task,风险为 Risk

Req

返回参数

名称类型描述示例值
object
requestIdstring

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

ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCodestring

错误返回码

例:Openapi.RequestError
errorMessagestring

错误返回信息

errormessage
successboolean

接口是否正常返回

true或者false
workitemTypesobject []

工作项类型

identifierstring

工作项类型 id

dfexxxxxf4fee18xxxxx36
namestring

工作项类型的名称

例:业务类需求
nameEnstring

工作项类型的英文名称

例:Business Requirement
categoryIdentifierstring

工作项类型,需求为 Req,缺陷为 Bug,任务为 Task,风险为 Risk

Req
systemDefaultboolean

是否系统默认,true-系统默认/false-企业创建

true
gmtCreatelong

创建时间

1620455467000
creatorstring

工作项类型创建人

用户阿里云pk,例如19xxxx31947xxxx
descriptionstring

描述

该类型的具体信息
enableboolean

是否启用

true或者false
defaultTypeboolean

在项目中是否为默认类型

true或者false
gmtAddlong

添加到项目中的时间

1641870287000
addUserstring

添加到项目中的添加人

用户阿里云pk,例如19xxxx31947xxxx

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorCode": "例:Openapi.RequestError",
  "errorMessage": "errormessage",
  "success": true,
  "workitemTypes": [
    {
      "identifier": "dfexxxxxf4fee18xxxxx36",
      "name": "例:业务类需求",
      "nameEn": "例:Business Requirement",
      "categoryIdentifier": "Req",
      "systemDefault": true,
      "gmtCreate": 1620455467000,
      "creator": "用户阿里云pk,例如19xxxx31947xxxx",
      "description": "该类型的具体信息",
      "enable": true,
      "defaultType": true,
      "gmtAdd": 1641870287000,
      "addUser": "用户阿里云pk,例如19xxxx31947xxxx"
    }
  ]
}

错误码

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

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

  • 本页导读 (0)