根据指定条件更新实例 - UpdateByConditionUsingPost
功能介绍
根据指定条件更新指定模型的实例。
接口约束
不涉及。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/updateByCondition
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
identifier |
是 |
String |
参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
modelName |
是 |
String |
参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
applicationId |
否 |
String |
参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
params |
是 |
参数解释: 请求参数对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
condition |
否 |
QueryRequestVo object |
参数解释: 查询条件。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
updateDTO |
否 |
PersistableModelUpdateDTO object |
参数解释: 更新对象数据。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释: 排序信息字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cnName |
否 |
String |
参数解释: 中文名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
code |
否 |
String |
参数解释: 编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
enName |
否 |
String |
参数解释: 英文名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
createTime |
否 |
String |
参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
creator |
否 |
String |
参数解释: 创建者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
id |
否 |
String |
参数解释: 唯一标识。 约束限制: 不涉及。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
|
lastUpdateTime |
否 |
String |
参数解释: 最后更新时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
modifier |
否 |
String |
参数解释: 更新者。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
needSetNullAttrs |
否 |
Array of strings |
参数解释: 将自定义属性(包括基本属性、扩展属性和分类属性)设置为空值,其长度不能超过1000个字符。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
rdmExtensionType |
否 |
String |
参数解释: 扩展类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
uniqueKey |
否 |
String |
参数解释: 示例模型的唯一键属性。 约束限制: 实例值不能重复。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
String |
参数解释: 请求结果。 取值范围:
默认取值: 不涉及。 |
|
data |
Array of PersistableModelViewDTO objects |
参数解释: 请求数据。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
errors |
Array of strings |
参数解释: 异常信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
className |
String |
参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
createTime |
String |
参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
creator |
String |
参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
id |
String |
参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
|
rdmDeleteFlag |
Integer |
参数解释: 软删除标识。 取值范围:
默认取值: 0。 |
|
rdmExtensionType |
String |
参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
rdmVersion |
Integer |
参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
modifier |
String |
参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
lastUpdateTime |
AnyType |
参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
tenant |
TenantViewDTO object |
参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
uniqueKey |
String |
参数解释: 示例模型中定义的唯一键属性。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
className |
String |
参数解释: 类名。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
code |
String |
参数解释: 租户编码。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
createTime |
String |
参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
creator |
String |
参数解释: 创建者。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
dataSource |
String |
参数解释: 租户使用的数据源名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
description |
String |
参数解释: 描述信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
disableFlag |
Boolean |
参数解释: 失效标识。 取值范围:
默认取值: false。 |
|
id |
String |
参数解释: 唯一标识。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
|
kiaguid |
String |
参数解释: KIA密级。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
lastUpdateTime |
String |
参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
modifier |
String |
参数解释: 修改人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name |
String |
参数解释: 中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
rdmDeleteFlag |
Integer |
参数解释: 软删除标识。 取值范围:
默认取值: 0。 |
|
rdmExtensionType |
String |
参数解释: 扩展类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
rdmVersion |
Integer |
参数解释: 系统版本。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
securityLevel |
String |
参数解释: 安全密级。 取值范围:
默认取值: 不涉及。 |
|
tenant |
TenantViewDTO object |
参数解释: 租户信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
构建条件为:id = 2
POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/updateByCondition
{
"applicationId" : "b3f9b7523a6141f4b2d76b92d6595281",
"params" : {
"condition" : {
"characterSet" : "UTF8",
"isNeedTotal" : true,
"isPresentAll" : true,
"publicData" : "INCLUDE_PUBLIC_DATA",
"decrypt" : false,
"filter" : {
"joiner" : "and",
"ignoreStr" : false,
"conditions" : [ {
"conditionName" : "id",
"conditionValues" : [ "2" ],
"operator" : "=",
"ignoreStr" : false
} ]
},
"sorts" : [ ]
},
"updateDTO" : {
"modifier" : "test1",
"creator" : "test1",
"rdmExtensionType" : "PersistableModel",
"uniqueKey" : "条件更新"
}
}
}
响应示例
状态码:200
OK
{
"result" : "SUCCESS",
"data" : [ {
"id" : "123",
"creator" : "test1",
"modifier" : "XDM_Developer xxx",
"createTime" : "2023-12-04T11:52:48.000+0000",
"lastUpdateTime" : "2023-12-06T06:44:32.287+0000",
"rdmVersion" : 3,
"rdmDeleteFlag" : 0,
"rdmExtensionType" : "PersistableModel",
"tenant" : {
"id" : "-1",
"creator" : "xdmAdmin",
"modifier" : "xdmAdmin",
"createTime" : "2023-12-01T01:25:21.000+0000",
"lastUpdateTime" : "2023-12-01T01:25:21.000+0000",
"rdmVersion" : 1,
"rdmDeleteFlag" : 0,
"rdmExtensionType" : "Tenant",
"tenant" : null,
"className" : "Tenant",
"name" : "basicTenant",
"description" : "默认租户",
"kiaguid" : null,
"securityLevel" : "internal",
"nameEn" : null,
"code" : "basicTenant",
"disableFlag" : false,
"dataSource" : "DefaultDataSource"
},
"className" : "PersistableModel",
"uniqueKey" : "123"
} ],
"errors" : [ ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。