获取自定义字段的选项值

调试

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

请求语法

GET /organization/organizationId/fields/fieldId/getCustomOption?spaceIdentifier=String&spaceType=String&workitemTypeIdentifier=String HTTP/1.1
Content-Type:application/json

请求参数

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

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

字段id
表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
spaceIdentifier String 是 e8bxxxxxxxxxxxxxxxx23

项目id
spaceType String 是 Project

资源类型，目前默认为Project
workitemTypeIdentifier String 是 9uyxxxx1re573f561dxxxxx

工作项类型id，可以从ListProjectWorkitemTypes接口获取，对应identifier字段。

响应体语法

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

{
  "requestId" : "String",
  "errorMsg" : "String",
  "errorCode" : "String",
  "success" : Boolean,
  "fileds" : [ {
    "displayValue" : "String",
    "fieldIdentifier" : "String",
    "identifier" : "String",
    "level" : Long,
    "position" : Long,
    "value" : "String",
    "valueEn" : "String"
  } ]
}

响应参数

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

请求id，每次请求都是唯一值，便于后续排查问题
errorMsg String error

错误信息
errorCode String Openapi.RequestError

错误码
success Boolean true

true或者false
fileds Array of field

字段值信息
displayValue String 223

展示的值
fieldIdentifier String e8bxxxxxxxxxxxxxxxx23

字段唯一标识
identifier String 3345

迭代唯一标识符
level Long 1

展示级别，数字范围1~9，数字越大，颜色越浅
position Long 1

待选值顺序
value String 223

字段中文名称
valueEn String 223

字段英文名称

示例1

GET /organization/5ebbc0228123212b59xxxxx/fields/1019xxxxx5f5c33xxxxx9920d44/getCustomOption?spaceIdentifier=e8bxxxxxxxxxxxxxxxx23&spaceType=Project&workitemTypeIdentifier=9uyxxxx1re573f561dxxxxx HTTP/1.1
Host:devops.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

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

<GetCustomFieldOptionResponse>
    <fileds>
        <displayValue>紧急</displayValue>
        <identifier>ec6b0daec1334292f636......</identifier>
        <fieldIdentifier>priority</fieldIdentifier>
        <valueEn>Urgent</valueEn>
        <level>0</level>
        <position>1</position>
        <value>紧急</value>
    </fileds>
    <fileds>
        <displayValue>高</displayValue>
        <identifier>0ff8f91ced4ee913da7......</identifier>
        <fieldIdentifier>priority</fieldIdentifier>
        <valueEn>High</valueEn>
        <level>1</level>
        <position>2</position>
        <value>高</value>
    </fileds>
    <fileds>
        <displayValue>中</displayValue>
        <identifier>77c7fb03c4186c8691d6......</identifier>
        <fieldIdentifier>priority</fieldIdentifier>
        <valueEn>Medium</valueEn>
        <level>4</level>
        <position>3</position>
        <value>中</value>
    </fileds>
    <fileds>
        <displayValue>低</displayValue>
        <identifier>39a7dc21e2552dff2304......</identifier>
        <fieldIdentifier>priority</fieldIdentifier>
        <valueEn>Low</valueEn>
        <level>9</level>
        <position>4</position>
        <value>低</value>
    </fileds>
    <requestId>76FE0461-3F2C-53D4-9833-96CA49......</requestId>
    <success>true</success>
    <errorCode/>
    <errorMsg/>
</GetCustomFieldOptionResponse>

JSON格式 

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

{
  "fileds" : [ {
    "displayValue" : "紧急",
    "identifier" : "ec6b0daec1334292f636......",
    "fieldIdentifier" : "priority",
    "valueEn" : "Urgent",
    "level" : 0,
    "position" : 1,
    "value" : "紧急"
  }, {
    "displayValue" : "高",
    "identifier" : "0ff8f91ced4ee913da7......",
    "fieldIdentifier" : "priority",
    "valueEn" : "High",
    "level" : 1,
    "position" : 2,
    "value" : "高"
  }, {
    "displayValue" : "中",
    "identifier" : "77c7fb03c4186c8691d6......",
    "fieldIdentifier" : "priority",
    "valueEn" : "Medium",
    "level" : 4,
    "position" : 3,
    "value" : "中"
  }, {
    "displayValue" : "低",
    "identifier" : "39a7dc21e2552dff2304......",
    "fieldIdentifier" : "priority",
    "valueEn" : "Low",
    "level" : 9,
    "position" : 4,
    "value" : "低"
  } ],
  "requestId" : "76FE0461-3F2C-53D4-9833-96CA49......",
  "success" : true,
  "errorCode" : "",
  "errorMsg" : ""
}

错误码

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

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

开发者资源

  • SDK

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

  • OpenAPI Explorer

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

  • 阿里云CLI

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