文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 项目配置管理/ 自定义字段是否被使用 - ShowProjectFieldUsed
更新时间:2026-10-22 GMT+08:00
分享

自定义字段是否被使用 - ShowProjectFieldUsed

功能介绍

此接口用于删除自定义字段前,判断自定义字段是否被使用

调用方法

请参见如何调用API。

URI

POST /v4/projects/{project_id}/field-configs/used

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

uri

否

String

字段配置URI标识

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueBoolean object

true/false

error

ApiError object

错误信息。

request_id

String

由接口调用方传入,建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址

表4 ResultValueBoolean

参数

参数类型

描述

value

Boolean

参数解释

本次查询的记录结果,true表示存在对应记录,false表示不存在对应记录

取值范围

  • true:存在对应记录

  • false:不存在对应记录

表5 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v4/projects/ab26ad085a594c9baac38216dff3409c/field-configs/used

{
  "uri" : "005t3o8pmtm"
}

响应示例

状态码:200

{
  "result" : {
    "value" : true
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档