批量删除字段 - DeleteField
功能介绍
删除自定义字段
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID,用于指定操作的工作空间范围。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 获取方式: 可通过调用查询数据类列表接口获取,也可从控制台获取。 |
| dataclass_id | 是 | String | 参数解释: 数据类的唯一ID,用于指定操作的数据类。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 获取方式: 可通过调用查询数据类列表接口获取,也可从控制台获取。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| content-type | 是 | String | 参数解释: 请求体的内容类型,用于指定请求体的媒体类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 否 | Array of strings | 参数解释: 待删除的字段ID列表,数组内每个String元素为字段ID,可通过调用查询数据类字段列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 成功响应码. 取值范围: 不涉及 |
| message | String | 参数解释: 成功信息 取值范围: 不涉及 |
| data | String | 参数解释: 成功标识. 取值范围: 不涉及 |
| success | Boolean | 参数解释: 请求是否成功的标识 取值范围: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述 取值范围: 不涉及 |
请求示例
删除自定义数据类字段
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields
[ "3e94505d-478f-4619-bef9-2c60a9fe3401" ] 响应示例
状态码:200
{
"code" : "00000000",
"message" : "Success",
"success" : true
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数有误 |
| 500 | 请求失败 |
错误码
请参见错误码。