根据指定条件删除实例
功能介绍
通过此接口,删除满足指定条件的实例。
请您谨慎使用删除操作,实例删除后将无法恢复。
接口约束
不涉及。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/deleteByCondition
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
identifier |
是 |
String |
参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
modelName |
是 |
String |
参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
applicationId |
否 |
String |
参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
params |
否 |
DeleteByConditionVo object |
参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
condition |
是 |
QueryRequestVo object |
参数解释: 过滤条件对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
modifier |
否 |
String |
参数解释: 修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
characterSet |
否 |
CharacterSetEnum object |
参数解释: 编码类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
conditions |
否 |
Array of QueryCondition objects |
参数解释: 查询条件。 此参数已废弃,不建议继续使用,建议使用替代参数filter。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
decrypt |
否 |
Boolean |
参数解释: 是否加密。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
entityType |
否 |
String |
参数解释: 实体类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
filter |
否 |
QueryCondition object |
参数解释: 指定条件的构建对象。 约束限制: filter的属性仅joiner和conditions生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
isNeedTotal |
否 |
Boolean |
参数解释: 是否需要查询总记录数。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
isPresentAll |
否 |
Boolean |
参数解释: 是否需要展示所有参考对象信息。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
needPresentDetail |
否 |
Array of strings |
参数解释: 需要展示详细信息的参考对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
orderBy |
否 |
String |
参数解释: 按某个字段进行排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
orderByTableAlias |
否 |
String |
参数解释: 排序字段的表别名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
publicData |
否 |
String |
参数解释: 多租查询参数。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
sort |
否 |
String |
参数解释: 排序方向。 约束限制: 不涉及。 取值范围:
默认取值: ASC。 |
sorts |
否 |
Array of SortInfoVo objects |
参数解释: 排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
conditions |
否 |
Array of QueryCondition objects |
参数解释: 用于定义一组嵌套查询条件,其逻辑关系由同级的joiner属性决定。每个子条件可包含基础条件或嵌套条件,形成多层级查询逻辑。
约束限制: 当一个对象同时符合基础条件和嵌套条件时,系统将优先考虑嵌套条件,并忽略基础条件。 取值范围: 不涉及。 默认取值: 不涉及。 |
conditionName |
否 |
String |
参数解释: 表示查询条件的名称(对应数据模型中属性的英文名称)。 约束限制: 该参数仅在conditions数组中生效,在filter中不生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
operator |
否 |
String |
参数解释: 操作符。 约束限制:
取值范围:
默认取值: 不涉及。 |
conditionValues |
否 |
Array of strings |
参数解释: 查询条件的值。 约束限制: 仅在conditions数组中生效,在filter中不生效。 取值范围:
默认取值: 不涉及。 |
conditionValue |
否 |
String |
参数解释: 查询条件值(已过时)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
ignoreStr |
否 |
Boolean |
参数解释: 是否忽略大小写。 约束限制: 仅在conditions数组中生效,在filter中不生效。 取值范围:
默认取值: false。 |
joinTableAlias |
否 |
String |
参数解释: 关联查询时被关联表的别名。 约束限制: 仅在conditions数组中生效,在filter中不生效。 取值范围: 不涉及。 默认取值: 不涉及。 |
joiner |
否 |
String |
参数解释: 连接符,连接conditions中的条件对象。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
preCondition |
否 |
QueryCondition object |
参数解释: 当前condition对象的上一层级。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
characterSet |
否 |
CharacterSetEnum object |
参数解释: SQL编码类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
orderBy |
否 |
String |
参数解释: 按某个字段进行排序。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sort |
否 |
String |
参数解释: 排序方向。 约束限制: 不涉及。 取值范围:
默认取值: ASC。 |
sortInfo |
否 |
String |
参数解释: 排序信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sortInfoOrderBy |
否 |
String |
参数解释: 排序信息字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
参数解释: 请求结果。 取值范围:
默认取值: 不涉及。 |
data |
Array of longs |
参数解释: 请求操作数据数量。 取值范围: 不涉及。 默认取值: 不涉及。 |
errors |
Array of strings |
参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
-
基础条件场景示例:删除ID>100的实例数据。
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/deleteByCondition { "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "filter" : { "joiner" : "and", "conditions" : [ { "joiner" : "and", "conditions" : [ { "conditionName" : "id", "operator" : ">=", "conditionValues" : [ "100" ] } ] } ] } } } }
-
组合条件场景示例:删除ID在100-1000之间且创建时间在2025年7月1日至8月1日的实例。
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/deleteByCondition { "params" : { "condition" : { "characterSet" : "UTF8", "isNeedTotal" : true, "filter" : { "joiner" : "and", "conditions" : [ { "joiner" : "and", "conditions" : [ { "conditionName" : "id", "operator" : ">=", "conditionValues" : [ "100" ] }, { "conditionName" : "id", "operator" : "<=", "conditionValues" : [ "1000" ] } ] }, { "joiner" : "and", "conditions" : [ { "conditionName" : "createTime", "operator" : ">=", "conditionValues" : [ "2025-7-1 00:00:00" ] }, { "conditionName" : "createTime", "operator" : "<=", "conditionValues" : [ "2025-8-1 00:00:00" ] } ] } ] } } } }
响应示例
状态码:200
OK
{
"result" : "SUCCESS",
"data" : [ 1 ],
"errors" : [ ]
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。