调用ListProjectWorkitemTypes获取工作项类型_云效(Apsara Devops)-阿里云帮助中心

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

调试

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

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
projectId	string	是	项目 id，同 spaceIdentifier，项目唯一标识	asd345xxxxx9q9845xxxxx34
spaceType	string	是	空间类型，这里填 Project 即可。	Project
category	string	是	工作项类型，需求为 Req，缺陷为 Bug，任务为 Task，风险为 Risk	Req

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorCode	string	错误返回码	例：Openapi.RequestError
errorMessage	string	错误返回信息	errormessage
success	boolean	接口是否正常返回	true或者false
workitemTypes	array<object>	工作项类型
	object
identifier	string	工作项类型 id	dfexxxxxf4fee18xxxxx36
name	string	工作项类型的名称	例：业务类需求
nameEn	string	工作项类型的英文名称	例：Business Requirement
categoryIdentifier	string	工作项类型，需求为 Req，缺陷为 Bug，任务为 Task，风险为 Risk	Req
systemDefault	boolean	是否系统默认，true-系统默认/false-企业创建	true
gmtCreate	long	创建时间	1620455467000
creator	string	工作项类型创建人	用户阿里云pk，例如19xxxx31947xxxx
description	string	描述	该类型的具体信息
enable	boolean	是否启用	true或者false
defaultType	boolean	在项目中是否为默认类型	true或者false
gmtAdd	long	添加到项目中的时间	1641870287000
addUser	string	添加到项目中的添加人	用户阿里云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	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史