huawei-cloud-api-definitions-iDMEClassicAPI 0.1.20250214

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"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"},"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"},"QueryRequestSelectedVo":{"properties":{"characterSet":{"$ref":"#/definitions/CharacterSetEnum","description":"编码类型。","example":"UTF8"},"conditions":{"description":"查询条件。","items":{"$ref":"#/definitions/QueryCondition"},"type":"array"},"decrypt":{"description":"是否加密。\n- true:加密。\n- false:不加密。","example":false,"type":"boolean"},"entityType":{"description":"实体类型。","example":"PersistableModel","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":"aliasName","type":"string"},"publicData":{"description":"多租查询参数。\n- EXCLUDE_PUBLIC_DATA:不包括公共数据。\n- INCLUDE_PUBLIC_DATA:包括公共数据。\n- ONLY_NEED_PUBLIC_DATA:只有公共数据。","example":"INCLUDE_PUBLIC_DATA","type":"string"},"selectedField":{"description":"指定需返回的属性。","items":{"$ref":"#/definitions/SelectedField"},"type":"array"},"sort":{"description":"排序方向。\n- ASC:表示升序。\n- DESC:表示降序。","example":"ASC","pattern":"ASC|DESC","type":"string"},"sorts":{"description":"排序。","items":{"$ref":"#/definitions/SortInfoVo"},"type":"array"}},"required":["selectedField"],"type":"object"},"RDMParamVOQueryRequestSelectedVo":{"properties":{"applicationId":{"description":"应用ID。","example":"b3f9b7523a6141f4b2d76b92d6595281","type":"string"},"params":{"$ref":"#/definitions/QueryRequestSelectedVo","description":"参数对象。"}},"type":"object"},"SelectResp":{"properties":{"data":{"description":"请求数据。","items":{"type":"object"},"type":"array"},"errors":{"description":"异常信息。","example":[],"items":{"type":"string"},"type":"array"},"result":{"description":"请求结果。","example":"SUCCESS","type":"string"}},"type":"object"},"SelectedField":{"properties":{"name":{"description":"字段名称,如果是子参考对象的属性,则为“参考对象.属性名称”,例如:“master.name”","example":"rdmExtensionType","type":"string"},"nameAs":{"description":"字段别名。如果不填,默认使用name参数的值。","example":"nameAsrdmExtensionType","type":"string"}},"required":["name"],"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"}},"description":null,"group_id":"ab5eda63b51647d6a950ceef4eccd859","host":"dme.cn-north-4.huaweicloud.com","id":"da20ac8d15194e36ad94ca285a61ea4d","info_version":"v1","method":"post","name":"ShowSelectUsingPost","parameters":{},"paths":{"/rdm_{identifier}_app/publicservices/api/{modelName}/select/{pageSizePath}/{curPagePath}":{"post":{"consumes":["application/json"],"description":"根据查询条件及指定属性分页返回(不支持扩展属性作为选定属性列)。","operationId":"ShowSelectUsingPost","parameters":[{"description":"当前页。","in":"query","name":"curPage","required":false,"type":"integer","x-example":1},{"description":"结束索引。","in":"query","name":"endIndex","required":false,"type":"integer","x-example":1},{"description":"最大分页数。","in":"query","name":"maxPageSize","required":false,"type":"integer","x-example":1},{"description":"每页大小。","in":"query","name":"pageSize","required":false,"type":"integer","x-example":1},{"description":"请求参数对象。","in":"body","name":"paramVO","required":true,"schema":{"$ref":"#/definitions/RDMParamVOQueryRequestSelectedVo"}},{"description":"起始索引。","in":"query","name":"startIndex","required":false,"type":"integer","x-example":1},{"description":"总页数。","in":"query","name":"totalPages","required":false,"type":"integer","x-example":1},{"description":"总行数。","in":"query","name":"totalRows","required":false,"type":"integer","x-example":1},{"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"},{"description":"分页大小(路径参数)。","in":"path","name":"pageSizePath","required":true,"type":"integer","x-example":10},{"description":"当前页数(路径参数)。","in":"path","name":"curPagePath","required":true,"type":"integer","x-example":1}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"data":[{"nameAsrdmExtensionType":"PersistableModel"}],"errors":[],"pageInfo":{"curPage":1,"pageSize":10,"totalPages":1,"totalRows":1},"result":"SUCCESS"}},"schema":{"$ref":"#/definitions/SelectResp"}}},"summary":"查询实例的指定属性","tags":["基础数据服务"],"x-is-registered":"Y","x-order":20,"x-request-examples-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"rdmExtensionType","conditionValues":["PersistableModel"],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","selectedField":[{"name":"rdmExtensionType","nameAs":"nameAsrdmExtensionType"}],"sorts":[]}},"x-request-examples-text-1":{"applicationId":"b3f9b7523a6141f4b2d76b92d6595281","params":{"characterSet":"UTF8","decrypt":false,"filter":{"conditions":[{"conditionName":"rdmExtensionType","conditionValues":["PersistableModel"],"ignoreStr":false,"operator":"="}],"ignoreStr":false,"joiner":"and"},"isNeedTotal":true,"isPresentAll":true,"publicData":"INCLUDE_PUBLIC_DATA","selectedField":[{"name":"rdmExtensionType","nameAs":"nameAsrdmExtensionType"}],"sorts":[]}},"x-request-examples-url-1":"POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/select/10/1","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"}