huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250214

{"base_path":"/","components":null,"consumes":"","definitions":{"CharacterSetEnum":{"properties":{"cnName":{"description":"中文名。","example":"GBK","type":"string"},"code":{"description":"编码。","example":"GBK","type":"string"},"enName":{"description":"英文名。","example":"GBK","type":"string"}},"type":"object"},"PersistableModelUpdateDTO":{"properties":{"createTime":{"description":"创建时间。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"创建者。","example":"test1","type":"string"},"id":{"description":"唯一标识。","example":2,"format":"int64","type":"integer"},"lastUpdateTime":{"description":"最后更新时间。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"modifier":{"description":"更新者。","example":"test1","type":"string"},"needSetNullAttrs":{"description":"设置空值。","items":{"description":"设置空值。","type":"string"},"type":"array"},"rdmExtensionType":{"description":"扩展类型。","example":"PersistableModelUpdateDTO","type":"string"},"uniqueKey":{"description":"示例模型的唯一键属性。","example":"条件更新","type":"string"}},"type":"object"},"PersistableModelViewDTO":{"properties":{"className":{"description":"类名。","example":"AircraftModel","type":"string"},"createTime":{"description":"创建时间。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"创建者。","example":"Tester XXX","type":"string"},"id":{"description":"唯一标识。","example":"553535480021389312","type":"string"},"lastUpdateTime":{"description":"最后更新时间。"},"modifier":{"description":"修改人。","example":"Tester XXX","type":"string"},"rdmDeleteFlag":{"description":"软删除标识,参数值为0或1。\n- 0:表示未删除。\n- 1:表示已删除。","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"扩展类型。","example":"AircraftModel","type":"string"},"rdmVersion":{"description":"系统版本。","example":1,"format":"int32","type":"integer"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"租户信息。"},"uniqueKey":{"description":"示例模型中定义的唯一键属性。","example":"31415926548645665","type":"string"}},"type":"object"},"QueryCondition":{"properties":{"conditionName":{"description":"查询条件的名称(数据模型的属性英文名称)。","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"conditionValue":{"description":"查询条件值(已过时)。","example":"value","type":"string"},"conditionValues":{"description":"查询条件的值。operator为in时有多值,operator为其他操作符时均为单值。","example":[574969257222213632],"items":{"type":"string"},"type":"array"},"conditions":{"description":"查询条件列表。","example":"[]","items":{"$ref":"#/definitions/QueryCondition"},"type":"array"},"ignoreStr":{"description":"是否忽略大小写。\n- true:表示忽略。\n- false:表示不忽略。","example":false,"type":"boolean"},"joinTableAlias":{"description":"关联查询时被关联表的别名。","example":"aliasName","type":"string"},"joiner":{"description":"连接符。","example":"and","pattern":"and|or","type":"string"},"operator":{"description":"操作符。\n- =:等于查询。\n- like:模糊查询。\n- customLike:支持输入*或%的模糊查询。\n- in:包含查询。\n- <:小于查询。\n- \\>:大于查询。\n- \\>=:大于等于查询。\n- <=:小于等于查询。\n- <>:不等于查询。","example":"=","pattern":"=|like|in|<|>|>=|<=|<>|isnull|notnull","type":"string"},"preCondition":{"$ref":"#/definitions/QueryCondition","description":"当前condition对象的上一层级。"}},"type":"object"},"QueryRequestVo":{"properties":{"characterSet":{"$ref":"#/definitions/CharacterSetEnum","description":"编码类型。"},"conditions":{"description":"查询条件。","items":{"$ref":"#/definitions/QueryCondition"},"type":"array"},"decrypt":{"description":"是否加密。\n- true:加密。\n- false:不加密。","example":false,"type":"boolean"},"entityType":{"description":"实体类型。","example":"MODEL","type":"string"},"filter":{"$ref":"#/definitions/QueryCondition","description":"查询条件。"},"isNeedTotal":{"description":"是否需要查询总记录数。\n- true:需要。\n- false:不需要。","example":true,"type":"boolean"},"isPresentAll":{"description":"是否需要展示所有参考对象信息。\n- true:需要。\n- false:不需要。","example":true,"type":"boolean"},"needPresentDetail":{"description":"需要展示详细信息的参考对象。","example":[],"items":{"type":"string"},"type":"array"},"orderBy":{"description":"按某个字段进行排序。","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"orderByTableAlias":{"description":"排序字段的表别名。","example":"attrAliasName","type":"string"},"publicData":{"description":"多租查询参数。\n- EXCLUDE_PUBLIC_DATA:不包括公共数据。\n- INCLUDE_PUBLIC_DATA:包括公共数据。\n- ONLY_NEED_PUBLIC_DATA:只有公共数据。","example":"INCLUDE_PUBLIC_DATA","type":"string"},"sort":{"description":"排序方向。\n- ASC:表示升序。\n- DESC:表示降序。","example":"ASC","pattern":"ASC|DESC","type":"string"},"sorts":{"description":"排序。","items":{"$ref":"#/definitions/SortInfoVo"},"type":"array"}},"type":"object"},"RDMParamVOUpdateByConditionVoPersistableModelUpdateDTO":{"properties":{"applicationId":{"description":"应用ID。","example":"b3f9b7523a6141f4b2d76b92d6595281","type":"string"},"params":{"$ref":"#/definitions/UpdateByConditionVoPersistableModelUpdateDTO","description":"参数对象。"}},"type":"object"},"SortInfoVo":{"properties":{"characterSet":{"$ref":"#/definitions/CharacterSetEnum","description":"SQL编码类型。"},"orderBy":{"description":"按某个字段进行排序。","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"sort":{"description":"排序方向。\n- ASC:表示升序。\n- DESC:表示降序。","example":"ASC","pattern":"ASC|DESC","type":"string"},"sortInfo":{"description":"排序信息。","example":"attrName","type":"string"},"sortInfoOrderBy":{"description":"排序信息字段。","example":"attrName","type":"string"}},"type":"object"},"TenantViewDTO":{"properties":{"className":{"description":"类名。","example":"Tenant","type":"string"},"code":{"description":"租户编码。","example":"basicTenant","type":"string"},"createTime":{"description":"创建时间。","example":"2023-12-02T03:03:07.695+0000","type":"string"},"creator":{"description":"创建者。","example":"Tester XXX","type":"string"},"dataSource":{"description":"租户使用的数据源名称。","example":"DefaultDataSource","type":"string"},"description":{"description":"描述信息。","example":"默认租户","type":"string"},"disableFlag":{"description":"失效标识。 \n- true:失效。 \n- false:未失效。","example":false,"type":"boolean"},"id":{"description":"唯一标识。","example":"-1","type":"string"},"kiaguid":{"description":"KIA密级。","type":"string"},"lastUpdateTime":{"description":"最后更新时间。","type":"string"},"modifier":{"description":"修改人。","example":"Tester XXX","type":"string"},"name":{"description":"中文名称。","example":"basicTenant","type":"string"},"rdmDeleteFlag":{"description":"软删除标识,参数值为0或1。\n- 0:表示未删除。\n- 1:表示已删除。","example":0,"format":"int32","type":"integer"},"rdmExtensionType":{"description":"扩展类型。","example":"Tenant","type":"string"},"rdmVersion":{"description":"系统版本。","example":1,"format":"int32","type":"integer"},"securityLevel":{"description":"安全密级。\n- INTERNAL:内部公开。\n- SECRET:秘密。\n- CONFIDENTIAL:机密。\n- TOP_SECRET:绝密。","example":"INTERNAL","type":"string"},"tenant":{"$ref":"#/definitions/TenantViewDTO","description":"租户信息。"}},"required":["code","dataSource"],"type":"object"},"UpdateByConditionVoPersistableModelUpdateDTO":{"properties":{"condition":{"$ref":"#/definitions/QueryRequestVo","description":"查询条件。"},"updateDTO":{"$ref":"#/definitions/PersistableModelUpdateDTO","description":"更新对象数据。"}},"type":"object"},"UpdateResp":{"properties":{"data":{"description":"请求数据。","items":{"$ref":"#/definitions/PersistableModelViewDTO"},"type":"array"},"errors":{"description":"异常信息。","example":[],"items":{"type":"string"},"type":"array"},"result":{"description":"请求结果。","example":"SUCCESS","type":"string"}},"type":"object"}},"description":null,"group_id":"ab5eda63b51647d6a950ceef4eccd859","host":"dme.cn-north-4.huaweicloud.com","id":"cf47de1e60084a8fb8686ed88181fe93","info_version":"v1","method":"post","name":"ShowUpdateByConditionUsingPost","parameters":{},"paths":{"/rdm_{identifier}_app/publicservices/api/{modelName}/updateByCondition":{"post":{"consumes":["application/json"],"description":"根据指定条件更新指定模型的实例。","operationId":"ShowUpdateByConditionUsingPost","parameters":[{"description":"请求参数对象。","in":"body","name":"paramVO","required":true,"schema":{"$ref":"#/definitions/RDMParamVOUpdateByConditionVoPersistableModelUpdateDTO"}},{"description":"IAM用户的token。\n\n获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},{"description":"应用ID。","in":"path","name":"identifier","required":true,"type":"string","x-example":"b3f9b7523a6141f4b2d76b92d6595281"},{"description":"数据模型的英文名称。","in":"path","name":"modelName","required":true,"type":"string","x-example":"PersistableModel"}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[{"className":"PersistableModel","createTime":"2023-12-04T11:52:48.000+0000","creator":"test1","id":"123","lastUpdateTime":"2023-12-06T06:44:32.287+0000","modifier":"XDM_Developer xxx","rdmDeleteFlag":0,"rdmExtensionType":"PersistableModel","rdmVersion":3,"tenant":{"className":"Tenant","code":"basicTenant","createTime":"2023-12-01T01:25:21.000+0000","creator":"xdmAdmin","dataSource":"DefaultDataSource","description":"默认租户","disableFlag":false,"id":"-1","kiaguid":null,"lastUpdateTime":"2023-12-01T01:25:21.000+0000","modifier":"xdmAdmin","name":"basicTenant","nameEn":null,"rdmDeleteFlag":0,"rdmExtensionType":"Tenant","rdmVersion":1,"securityLevel":"internal","tenant":null},"uniqueKey":"123"}],"errors":[],"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/UpdateResp"}}},"summary":"根据指定条件更新实例","tags":["基础数据服务"],"x-is-registered":"Y","x-order":10,"x-request-examples-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"condition":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"id","conditionValues":[2],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","sorts":[]},"updateDTO":{"creator":"test1","modifier":"test1","rdmExtensionType":"PersistableModel","uniqueKey":"条件更新"}}},"x-request-examples-text-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"condition":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"id","conditionValues":[2],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","sorts":[]},"updateDTO":{"creator":"test1","modifier":"test1","rdmExtensionType":"PersistableModel","uniqueKey":"条件更新"}}},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/updateByCondition","x-support-sdk":"Y","x-version":"v1"}}},"product_short":"iDMEClassicAPI","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"根据指定条件更新实例","tags":"基础数据服务","uri":null,"version":"2.0"}