调用GetCustomFieldOption获取字段自定义选项_云效(Apsara Devops)-阿里云帮助中心

获取字段自定义选项。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/fields/{fieldId}/getCustomOption

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
spaceIdentifier	string	是	项目 id，同 projectId，项目唯一标识	e8bxxxxxxxxxxxxxxxx23
spaceType	string	是	资源类型，目前默认为 Project	Project
workitemTypeIdentifier	string	是	工作项类型 id，可以从 ListProjectWorkitemTypes 接口获取，对应 identifier 字段。	9uyxxxx1re573f561dxxxxx
fieldId	string	是	字段 id	1019xxxxx5f5c33xxxxx9920d44

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息	error
errorCode	string	错误码	Openapi.RequestError
success	boolean	true 或者 false	true
fileds	object []	字段值信息
displayValue	string	展示的值	223
fieldIdentifier	string	字段唯一标识	e8bxxxxxxxxxxxxxxxx23
identifier	string	迭代唯一标识符	3345
level	long	展示级别，数字范围 1~9，数字越大，颜色越浅	1
position	long	待选值顺序	1
value	string	字段中文名称	223
valueEn	string	字段英文名称	223

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "fileds": [
    {
      "displayValue": "223",
      "fieldIdentifier": "e8bxxxxxxxxxxxxxxxx23",
      "identifier": "3345",
      "level": 1,
      "position": 1,
      "value": "223",
      "valueEn": "223"
    }
  ]
}

错误码

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

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