huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250214

{"base_path":"/","components":null,"consumes":"","definitions":{"CharacterSetEnum":{"properties":{"cnName":{"description":"**参数解释:**\n\n中文名。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"GBK","type":"string"},"code":{"description":"**参数解释:**\n\n编码。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"GBK","type":"string"},"enName":{"description":"**参数解释:**\n\n英文名。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"GBK","type":"string"}},"type":"object"},"DeleteByConditionVo":{"properties":{"condition":{"$ref":"#/definitions/QueryRequestVo","description":"**参数解释:**\n\n查询条件。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"modifier":{"description":"**参数解释:**\n\n修改人。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"test1","type":"string"}},"required":["condition"],"type":"object"},"DeleteResp":{"properties":{"data":{"description":"**参数解释:**\n\n请求操作数据数量。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":[1],"items":{"format":"int64","type":"integer"},"type":"array"},"errors":{"$ref":"#/definitions/errors"},"result":{"$ref":"#/definitions/result"}},"type":"object"},"QueryCondition":{"properties":{"conditionName":{"description":"**参数解释:**\n\n查询条件的名称(数据模型的属性英文名称)。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"conditionValue":{"description":"**参数解释:**\n\n查询条件值(已过时)。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"value","type":"string"},"conditionValues":{"description":"**参数解释:**\n\n查询条件的值。operator为in时有多值,operator为其他操作符时均为单值。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":["574969257222213632"],"items":{"type":"string"},"type":"array"},"conditions":{"description":"**参数解释:**\n\n查询条件列表。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"[]","items":{"$ref":"#/definitions/QueryCondition"},"type":"array"},"ignoreStr":{"description":"**参数解释:**\n\n是否忽略大小写。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- true:表示忽略。\n- false:表示不忽略。\n\n**默认取值:**\n\nfalse。\n","example":false,"type":"boolean"},"joinTableAlias":{"description":"**参数解释:**\n\n关联查询时被关联表的别名。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"aliasName","type":"string"},"joiner":{"description":"**参数解释:**\n\n连接符。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"and","pattern":"and|or","type":"string"},"operator":{"description":"**参数解释:**\n\n操作符。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- =:等于查询。\n- <:小于查询。\n- \\>:大于查询。\n- \\>=:大于等于查询。\n- <=:小于等于查询。\n- <>:不等于查询。\n- startWith:头匹配查询。\n- endWith:尾匹配查询。\n- like:模糊查询。\n- customLike:支持输入*或%的模糊查询。\n- in:包含查询。\n- not in:排除查询。\n- ISNULL:值为空查询。\n- NOTNULL:值不为空查询。\n\n**默认取值:**\n\n不涉及。\n","example":"=","pattern":"=|<|>|>=|<=|<>|startWith|endWith|like|customLike|in|not in|ISNULL|NOTNULL","type":"string"},"preCondition":{"$ref":"#/definitions/QueryCondition","description":"**参数解释:**\n\n当前condition对象的上一层级。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"}},"type":"object"},"QueryRequestVo":{"properties":{"characterSet":{"$ref":"#/definitions/CharacterSetEnum","description":"**参数解释:**\n\n编码类型。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"conditions":{"description":"**参数解释:**\n\n查询条件。\n\n此参数已废弃,不建议继续使用,建议使用替代参数filter。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","items":{"$ref":"#/definitions/QueryCondition"},"type":"array"},"decrypt":{"description":"**参数解释:**\n\n是否加密。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- true:加密。\n- false:不加密。\n\n**默认取值:**\n\n不涉及。\n","example":false,"type":"boolean"},"entityType":{"description":"**参数解释:**\n\n实体类型。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"MODEL","type":"string"},"filter":{"$ref":"#/definitions/QueryCondition","description":"**参数解释:**\n\n查询条件。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"isNeedTotal":{"description":"**参数解释:**\n\n是否需要查询总记录数。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- true:需要。\n- false:不需要。\n\n**默认取值:**\n\nfalse。\n","example":true,"type":"boolean"},"isPresentAll":{"description":"**参数解释:**\n\n是否需要展示所有参考对象信息。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- true:需要。\n- false:不需要。\n\n**默认取值:**\n\nfalse。\n","example":true,"type":"boolean"},"needPresentDetail":{"description":"**参数解释:**\n\n需要展示详细信息的参考对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":[],"items":{"type":"string"},"type":"array"},"orderBy":{"description":"**参数解释:**\n\n按某个字段进行排序。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"orderByTableAlias":{"description":"**参数解释:**\n\n排序字段的表别名。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrAliasName","type":"string"},"publicData":{"description":"**参数解释:**\n\n多租查询参数。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- EXCLUDE_PUBLIC_DATA:不包括公共数据。\n- INCLUDE_PUBLIC_DATA:包括公共数据。\n- ONLY_NEED_PUBLIC_DATA:只有公共数据。\n\n**默认取值:**\n\n不涉及。\n","example":"INCLUDE_PUBLIC_DATA","type":"string"},"sort":{"description":"**参数解释:**\n\n排序方向。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- ASC:表示升序。\n- DESC:表示降序。\n\n**默认取值:**\n\nASC。\n","example":"ASC","pattern":"ASC|DESC","type":"string"},"sorts":{"description":"**参数解释:**\n\n排序。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","items":{"$ref":"#/definitions/SortInfoVo"},"type":"array"}},"type":"object"},"RDMParamVODeleteByConditionVo":{"properties":{"applicationId":{"description":"**参数解释**:\n\n应用ID。\n\n**约束限制**:\n\n不涉及。\n\n**取值范围**:\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值**:\n\n不涉及。\n","example":"b3f9b7523a6141f4b2d76b92d6595281","type":"string"},"params":{"$ref":"#/definitions/DeleteByConditionVo","description":"**参数解释:**\n\n请求参数对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"}},"type":"object"},"SortInfoVo":{"properties":{"characterSet":{"$ref":"#/definitions/CharacterSetEnum","description":"**参数解释:**\n\nSQL编码类型。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n"},"orderBy":{"description":"**参数解释:**\n\n按某个字段进行排序。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrName","pattern":"^[0-9a-zA-Z_.]{1,}$","type":"string"},"sort":{"description":"**参数解释:**\n\n排序方向。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n- ASC:表示升序。\n- DESC:表示降序。\n\n**默认取值:**\n\nASC。\n","example":"ASC","pattern":"ASC|DESC","type":"string"},"sortInfo":{"description":"**参数解释:**\n\n排序信息。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrName","type":"string"},"sortInfoOrderBy":{"description":"**参数解释:**\n\n排序信息字段。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":"attrName","type":"string"}},"type":"object"},"errors":{"description":"**参数解释:**\n\n异常信息。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。\n","example":[],"items":{"type":"string"},"type":"array"},"result":{"description":"**参数解释:**\n\n请求结果。\n\n**取值范围:**\n\n- SUCCESS:请求成功。\n- FAIL:请求失败。\n\n**默认取值:**\n\n不涉及。\n","example":"SUCCESS","type":"string"}},"description":null,"group_id":"ab5eda63b51647d6a950ceef4eccd859","host":"dme.cn-north-4.huaweicloud.com","id":"592341b9a9114a6e9cc72c743675e684","info_version":"v1","method":"post","name":"DeleteByConditionUsingPost","parameters":{"X-Auth-Token":{"description":"**参数解释:**\n\nIAM用户的token。\n\n获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。\n\n**约束限制:**  \n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**  \n\n不涉及。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},"identifier":{"description":"**参数解释:**\n\n应用唯一标识。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n由英文字母和数字组成,且长度为32个字符。\n\n**默认取值:**\n\n不涉及。\n","in":"path","name":"identifier","required":true,"type":"string","x-example":"b3f9b7523a6141f4b2d76b92d6595281"}},"paths":{"/rdm_{identifier}_app/publicservices/api/{modelName}/deleteByCondition":{"post":{"consumes":["application/json"],"description":"通过此接口,删除指定条件查询返回的实例。\n\n请您谨慎使用删除操作,实例删除后将无法恢复。","operationId":"DeleteByConditionUsingPost","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/identifier"},{"description":"**参数解释:**\n\n数据模型的英文名称。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。\n\n**默认取值:**\n\n不涉及。","in":"path","name":"modelName","required":true,"type":"string","x-example":"PersistableModel"},{"description":"**参数解释:**\n\n请求参数对象。\n\n**约束限制:**\n\n不涉及。\n\n**取值范围:**\n\n不涉及。\n\n**默认取值:**\n\n不涉及。","in":"body","name":"paramVO","required":true,"schema":{"$ref":"#/definitions/RDMParamVODeleteByConditionVo"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[1],"errors":[],"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/DeleteResp"}}},"summary":"根据指定条件删除实例","tags":["基础数据服务"],"x-constraint":"不涉及。","x-is-registered":"Y","x-order":4,"x-request-examples-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"condition":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"id","conditionValues":["666"],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","sorts":[]},"modifier":"test1"}},"x-request-examples-text-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"condition":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"id","conditionValues":["666"],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","sorts":[]},"modifier":"test1"}},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/deleteByCondition","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"}