获取项目下的工作项类型列表

调试

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

请求语法

GET /organization/organizationId/projects/projectId/getWorkitemType?spaceType=String&category=String HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
organizationId String 5ebbc0228123212b59xxxxx

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

projectId String asd345xxxxx9q9845xxxxx34

项目id

表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
spaceType String Project

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

category String Req

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

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "String",
  "errorCode" : "String",
  "errorMessage" : "String",
  "success" : Boolean,
  "workitemTypes" : [ {
    "identifier" : "String",
    "name" : "String",
    "nameEn" : "String",
    "categoryIdentifier" : "String",
    "systemDefault" : Boolean,
    "gmtCreate" : Long,
    "creator" : "String",
    "description" : "String",
    "enable" : Boolean,
    "defaultType" : Boolean,
    "gmtAdd" : Long,
    "addUser" : "String"
  } ]
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
requestId String ASSDS-ASSASX-XSAXSA-XSAXSAXS

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

errorCode String 例:Openapi.RequestError

错误返回码

errorMessage String errormessage

错误返回信息

success Boolean true或者false

接口是否正常返回

workitemTypes Array of workitemType

工作项类型

identifier String dfexxxxxf4fee18xxxxx36

工作项类型id

name String 例:业务类需求

工作项类型的名称

nameEn String 例:Business Requirement

工作项类型的英文名称

categoryIdentifier String Req

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

systemDefault Boolean true

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

gmtCreate Long 1620455467000

创建时间

creator String 用户阿里云pk,例如19xxxx31947xxxx

工作项类型创建人

description String 该类型的具体信息

描述

enable Boolean true或者false

是否启用

defaultType Boolean true或者false

在项目中是否为默认类型

gmtAdd Long 1641870287000

添加到项目中的时间

addUser String 用户阿里云pk,例如19xxxx31947xxxx

添加到项目中的添加人

示例1

GET /organization/5ebbc0228123212b59xxxxx/projects/asd345xxxxx9q9845xxxxx34/getWorkitemType?spaceType=Project&category=Req HTTP/1.1
Host:devops.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListProjectWorkitemTypesResponse>
    <workitemTypes>
        <systemDefault>true</systemDefault>
        <identifier>9uy29901re573f561d......</identifier>
        <creator>AK-ADMIN</creator>
        <enable>true</enable>
        <addUser>1967043931......</addUser>
        <name>产品类需求</name>
        <description/>
        <nameEn>Requirement</nameEn>
        <gmtAdd>1644551256000</gmtAdd>
        <categoryIdentifier>Req</categoryIdentifier>
        <gmtCreate>1613978186000</gmtCreate>
        <defaultType>true</defaultType>
    </workitemTypes>
    <requestId>D8B2431B-7A35-5DD5-985D-C62192......</requestId>
    <success>true</success>
    <errorMessage/>
    <errorCode/>
</ListProjectWorkitemTypesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "workitemTypes" : [ {
    "systemDefault" : true,
    "identifier" : "9uy29901re573f561d......",
    "creator" : "AK-ADMIN",
    "enable" : true,
    "addUser" : "1967043931......",
    "name" : "产品类需求",
    "description" : "",
    "nameEn" : "Requirement",
    "gmtAdd" : 1644551256000,
    "categoryIdentifier" : "Req",
    "gmtCreate" : 1613978186000,
    "defaultType" : true
  } ],
  "requestId" : "D8B2431B-7A35-5DD5-985D-C62192......",
  "success" : true,
  "errorMessage" : "",
  "errorCode" : ""
}

错误码

HttpCode 错误码 错误信息 描述
400 Openapi.RequestError request error OpenAPI请求数据错误
403 Operate.NoPermission NoPermission 没有权限

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。