查询自定义字段选项配置是否被使用 - ShowProjectFieldOptionConfigOptionUsed
功能介绍
查询自定义字段选项配置是否被使用
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/field-configs/option-value/used
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
uri | 是 | String | 字段配置URI标识 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
total | Integer | 起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
value | Array of ProjectFieldConfigOptionUsedVo objects | 实际的数据类型：单个对象，集合 或 NULL |
reason | String | 业务失败的提示内容 |
page_size | Integer | 分页大小 |
page_no | Integer | 分页编码 |
has_more | Boolean | 是否有更多 |
参数 | 参数类型 | 描述 |
|---|---|---|
uri | String | 字段配置uri |
option_value | String | 可选项名称 |
is_used | Boolean | 是否被使用 |
field_name | String | 字段名称 |
custom_field_uri | String | 自定义字段uri |
状态码：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/75681cbb7c324e15a9eb8ee74a96a474/field-configs/option-value/used
{
"uri" : "15269787"
} 响应示例
状态码：200
OK
{
"value": {
"uri": "15269787",
"option_value": "选项1",
"is_used": true,
"field_name": "字段1"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
500 | Internal Server Error |
错误码
请参见错误码。
