文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD字段管理/ 查询指定租户级字段使用情况 - ShowIpdTenantFieldUsed
更新时间:2026-09-01 GMT+08:00
分享

查询指定租户级字段使用情况 - ShowIpdTenantFieldUsed

功能介绍

查询指定租户级字段使用情况,返回使用该字段的项目信息和工作项类型。

调用方法

请参见如何调用API

授权信息

当前API调用无需身份策略权限。

URI

GET /v1/ipdprojectservice/tenant/fields/{field_id}/used

表1 路径参数

参数

是否必选

参数类型

描述

field_id

String

参数解释

工作项字段ID,可通过。 查询IPD项目租户字段列表接口获取,响应消息体中的field_id字段的值就是工作项字段field_id。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

[数组元素]

Array of FieldUsage objects

字段的使用情况,返回使用的项目ID和工作项类型。

表3 FieldUsage

参数

参数类型

描述

domain_id

String

参数解释

使用该字段的domain_id。

project_name

String

参数解释

使用该字段的项目名称。

project_id

String

参数解释

使用该字段的项目ID。

取值范围

不涉及。

model_id

String

参数解释

使用该字段的项目模型ID。

取值范围

10001(系统设备类)

10002(独立软件类)

10003(自运营软件/云服务类)。

create_by

String

参数解释

使用该字段的项目创建者ID。

取值范围

不涉及。

category_codes

String

参数解释

使用该字段的工作项类型,多个工作项类型使用英文逗号分隔。

取值范围

支持多种工作项类型,使用英文逗号分隔。

  • 系统设备类项目:RR、SF、IR、SR、AR、Task、Bug

  • 独立软件类项目:RR、SF、IR、US、Task、Bug

  • 云服务类项目:RR、Epic、FE、US、Task、Bug

categories

BaseUsedCategory object

参数解释

使用该字段的类型信息。

取值范围

不涉及。

表4 BaseUsedCategory

参数

参数类型

描述

id

String

参数解释

主键ID。

取值范围

不涉及。

icon

String

参数解释

icon图标。

取值范围

不涉及。

color

String

参数解释

颜色。

取值范围

可选颜色代码与对应中文描述如下:

  • #86CAFF:浅蓝色

  • #6DDEBB:青绿色

  • #A6DD82:黄绿色

  • #FAC20A:金黄色

  • #FA9841:橙色

  • #F66F6A:珊瑚红

  • #F3689A:粉红色

  • #A97AF8:淡紫色

  • #71757F:中性灰

  • #5E7CE0:宝蓝色

  • #207AB3:深蓝色

  • #169E6C:翠绿色

  • #6CA83B:草绿色

  • #B58200:棕黄色

  • #B54E04:赭石色

  • #B02121:朱红色

  • #AD215B:玫红色

  • #572DB3:深紫色

  • #4F4F4F:深灰色

  • #3C51A6:靛蓝色

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及。

error_msg

String

参数解释

错误描述,对error_code的补充解释。

取值范围

不涉及。

请求示例

查询指定租户字段使用情况

GET https://{endpoint}/v1/ipdprojectservice/tenant/fields/1162422376023437316/used

响应示例

状态码:200

ok

[ {
  "domain_id" : "1162174826943066113",
  "project_name" : "IPD-系统设备类11111111111111111",
  "project_id" : "056b156fc4a647a78d92a464afe58de6",
  "model_id" : "10001",
  "create_by" : "c2d89e38a64a466f8f945f595df4402d",
  "category_codes" : "RR,Bug,IR",
  "categories" : [ {
    "id" : "10021",
    "icon" : "RR",
    "color" : "#5e7ce0"
  }, {
    "id" : "10033",
    "icon" : "Bug",
    "color" : "#F56F6A"
  }, {
    "id" : "10020",
    "icon" : "IR",
    "color" : "#fa9841"
  } ]
} ]

状态码:400

请求失败的响应。例如无操作权限、项目不存在。

{
  "error_code" : "PM.02174103",
  "error_msg" : "无操作权限"
}

状态码

状态码

描述

200

ok

400

请求失败的响应。例如无操作权限、项目不存在。

错误码

请参见错误码

相关文档