自定义字段是否被使用 - ShowProjectFieldUsed
功能介绍
此接口用于删除自定义字段前,判断自定义字段是否被使用
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/field-configs/used
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
uri |
是 |
String |
字段配置URI标识 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
ResultValueBoolean object |
参数解释: 请求返回的布尔值 取值范围:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
|
value |
Boolean |
实际的数据类型：单个对象，集合 或 NULL |
|
reason |
String |
业务失败的提示内容 |
|
page_size |
Integer |
每页展示条数 |
|
page_no |
Integer |
页码 |
|
has_more |
Boolean |
是否有更多 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
接口调用失败错误码 |
|
error_msg |
String |
接口调用失败错误信息 |
请求示例
post https://{endpoint}/v4/projects/ab26ad085a594c9baac38216dff3409c/field-configs/used
{
"uri" : "005t3o8pmtm"
}
响应示例
状态码：200
OK
{
"value" : true
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
