可以获取项目红自定义字段

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListProjectCustomFields

系统规定参数。取值:ListProjectCustomFields。

OrgId String 5ebbc0228123212b59xxxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如

https://devops.aliyun.com/organization/【OrgId】

ProjectId String 5ebbc0228123212b59xxxxx

项目ID,可以在项目链接中获取,如

https://devops.aliyun.com/project/【ProjectId】/story/section/all

返回数据

名称 类型 示例值 描述
ErrorCode String ”“

错误码

ErrorMsg String ”“

错误信息

Object Array of CustomField

自定义字段

CustomFieldId String 60b89c774283ccbe57xxxx

自定义字段id

Name String 缺陷分类

自定义字段名称

Subtype String bug

自定义字段类型

Type String dropDown

自定义字段,页面操作类型

Values Array of Value

自定义字段 各项值

Id String 5a2e597daddda52ad692xxxx

值id

Value String 致命

值name

RequestId String ASSDS-ASSASX-XSAXSA-XSAXSAXS

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

Successful Boolean true

true 接口调用成功,false 接口调用失败

示例

请求示例

http(s)://[Endpoint]/?Action=ListProjectCustomFields
&OrgId=5ebbc0228123212b59xxxxx
&ProjectId=5ebbc0228123212b59xxxxx
&<公共请求参数>

正常返回示例

JSON格式

{"RequestId":"ASSDS-ASSASX-XSAXSA-XSAXSAXS","ErrorMsg":"”“","Object":[{"Type":"dropDown","CustomFieldId":"60b89c774283ccbe57xxxx","Subtype":"bug","Name":"缺陷分类","Values":[{"Value":"致命","Id":"5a2e597daddda52ad692xxxx"}]}],"ErrorCode":"”“","Successful":"true"}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidOrganization.NotFound The specified organization doe not exist. 企业信息有误,未找到该企业
404 InvalidUser.NotFound The specified user does not exist. 用户数据有误,未找到该用户
400 InvalidUser.UserNotInCurrentOrganization The user does not belong to the specified organization. 当前用户不属于该企业

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