华为云用户手册

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/undoCheckoutByAdmin { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "masterId" : "602146893727801345", "modifier" : "test1" } }

响应示例 状态码： 200 OK { "result" : "SUC CES S", "data" : [ { "id" : "601060080745455616", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModel", "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" : "VersionModel", "name" : "modifier name", "description" : "modifier description", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "601060080779010048", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelMaster", "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" : "VersionModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelBranch", "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" : "VersionModelBranch", "version" : "A" }, "latest" : true, "latestIteration" : true, "versionCode" : 1, "iteration" : 1, "version" : "A", "latestVersion" : true, "workingCopy" : false, "workingState" : { "code" : "CHECKED_IN", "cnName" : "已检入", "enName" : "checked in", "alias" : "CHECKED_IN" }, "checkOutUserName" : null, "checkOutTime" : null, "preVersionId" : "601372141664866304" } ], "errors" : [ ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of VersionModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表6 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 参数解释： 分支对象。 取值范围： 不涉及。 默认取值： 不涉及。 checkOutTime String 参数解释： 检出时间。 取值范围： 不涉及。 默认取值： 不涉及。 checkOutUserName String 参数解释： 检出人。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 iteration Integer 参数解释： 迭代版本。 取值范围： 不涉及。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 latest Boolean 参数解释： 是否为最新版本。 取值范围： true：是最新版本。 false：不是最新版本。 默认取值： false。 latestIteration Boolean 参数解释： 是否为最新迭代版本。 取值范围： true：是最新迭代版本。 false：不是最新迭代版本。 默认取值： 不涉及。 latestVersion Boolean 参数解释： 是否为最新修订版本。 取值范围： true：是最新修订版本。 false：不是最新修订版本。 默认取值： 不涉及。 master VersionModelMasterViewDTO object 参数解释： 主对象。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 preVersionId String 参数解释： 前序版本实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 version String 参数解释： 版本号。 取值范围： 不涉及。 默认取值： 不涉及。 versionCode Integer 参数解释： 业务版本内码。 取值范围： 不涉及。 默认取值： 不涉及。 workingCopy Boolean 参数解释： 是否已检出。 取值范围： true：已检出。 false：未检出。 默认取值： false。 workingState WorkingState object 参数解释： 工作状态。 取值范围： 不涉及。 默认取值： 不涉及。 表7 VersionModelBranchViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime Object 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 version String 参数解释： 版本号。 取值范围： 不涉及。 默认取值： 不涉及。 表8 VersionModelMasterViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表9 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 WorkingState 参数 参数类型 描述 alias String 参数解释： 别名。 取值范围： 不涉及。 默认取值： 不涉及。 cnName String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 编码。 取值范围： 不涉及。 默认取值： 不涉及。 enName String 参数解释： 英文名称。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 VersionModelVersionUndoCheckOutDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 VersionModelVersionUndoCheckOutDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释： 主对象ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 modifier 否 String 参数解释： 更新者。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/undoCheckoutByAdmin 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 PersistObjectIdsModifierDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistObjectIdsModifierDTO 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释： 数据实例 ID列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 否 String 参数解释： 修改人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/batchLogicalDelete { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "ids" : [ "777", "888" ], "modifier" : "test1" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求操作数据数量。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchLogicalDelete 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

操作步骤 获取接口相关信息。 URI格式：POST /wom/v1/wos/batch-delete 详情请参见批量删除工单。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/batch-delete”。 Body [ "1417639245421830258", "1425789631742573107" ] 查看请求响应结果。 请求成功时，响应参数如下： { "status" : "200", "message" : "success", "data" : 1 } 请求异常时，错误码请参见错误码。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/RelationModel/batchQueryRelatedObjects/10/1 { "params" : { "role" : "SOURCE", "objectIds" : [ "614786412419489792" ], "isNeedTotal" : true, "latestOnly" : false } }

响应示例 状态码： 200 OK { "result" : "SUCCESS", "data" : [ { "objectId" : "614786412419489792", "relatedList" : [ { "id" : "614786496192323584", "creator" : "xdmAdmin", "createTime" : "2024-03-28T03:42:02.873+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2024-03-28T03:42:02.873+0000", "rdmExtensionType" : "Student", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "createTime" : "2024-03-28T03:28:34.795+0000", "modifier" : "xdmAdmin", "lastUpdateTime" : "2024-03-28T03:28:34.795+0000", "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "Student", "name" : "张三", "description" : null, "grade" : "98.99" } ], "relatedEntityList" : null } ], "errors" : [ ], "pageInfo" : { "curPage" : 1, "pageSize" : 1000, "totalRows" : 1, "totalPages" : 1 } }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of RelatedObjectViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 pageInfo PageInfoViewDTO object 参数解释： 分页信息。 取值范围： 不涉及。 默认取值： 不涉及。 表7 RelatedObjectViewDTO 参数 参数类型 描述 objectId String 参数解释： 数据实例ID。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 relatedList Array of BasicObjectQueryViewDTO objects 参数解释： 关联的数据传输对象列表。 取值范围： 不涉及。 默认取值： 不涉及。 relatedEntityList Array of BasicObjectQueryViewDTO objects 参数解释： 关联的数据实体列表。 取值范围： 不涉及。 默认取值： 不涉及。 表8 BasicObjectQueryViewDTO 参数 参数类型 描述 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后的修改时间。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 表9 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 PageInfoViewDTO 参数 参数类型 描述 curPage Integer 参数解释： 当前页。 取值范围： 不涉及。 默认取值： 不涉及。 pageSize Integer 参数解释： 每页大小。 取值范围： 不涉及。 默认取值： 不涉及。 totalRows Integer 参数解释： 总行数。 取值范围： 不涉及。 默认取值： 不涉及。 totalPages Integer 参数解释： 总页数。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchQueryRelatedObjects/{pageSizePath}/{curPagePath} 表1 路径参数 参数 是否必选 参数类型 描述 pageSizePath 是 Integer 参数解释： 分页大小（路径参数）。 约束限制： 不涉及。 取值范围： 1-1000。 默认取值： 不涉及。 curPagePath 是 Integer 参数解释： 当前页数（路径参数）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1。 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 curPage 否 Integer 参数解释： 当前页。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1。 endIndex 否 Integer 参数解释： 结束索引。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 maxPageSize 否 Integer 参数解释： 最大分页数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1000。 pageSize 否 Integer 参数解释： 每页大小。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1000。 startIndex 否 Integer 参数解释： 起始索引。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 totalPages 否 Integer 参数解释： 总页数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。 totalRows 否 Integer 参数解释： 总行数。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 0。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 GenericLinkBatchQueryDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表5 GenericLinkBatchQueryDTO 参数 是否必选 参数类型 描述 latestOnly 否 Boolean 参数解释： 是否返回源模型数据实例关联的最新版本目标模型数据实例。此参数仅对源/目标模型为M-V模型实体有效。 约束限制： 不涉及。 取值范围： true：返回源模型数据实例关联的最新版本的目标模型数据实例。 false：返回源模型数据实例关联的所有版本的目标模型数据实例。 默认取值： false。 objectIds 否 Array of strings 参数解释： 角色对应的数据实例ID列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 role 否 String 参数解释： 角色。 约束限制： 不涉及。 取值范围： TARGET：目标模型。 SOURCE：源模型。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/save { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "id" : "1", "modifier" : "test1", "creator" : "test1", "rdmExtensionType" : "PersistableModel", "uniqueKey" : "save接口通过唯一键更新值", "tenant" : { "id" : "-1", "clazz" : "Tenant" } } ] }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求数据。 约束限制： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/save 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 Array of PersistableModelSaveDTO objects 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistableModelSaveDTO 参数 是否必选 参数类型 描述 createTime 否 String 参数解释： 创建时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 creator 否 String 参数解释： 创建者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 否 String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime 否 String 参数解释： 最后更新时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 否 String 参数解释： 更新者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 needSetNullAttrs 否 Array of strings 参数解释： 设置NULL值的属性名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType 否 String 参数解释： 扩展类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 tenant 否 ObjectReferenceParamDTO object 参数解释： 租户信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey 否 String 参数解释： 示例模型的唯一键属性。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表5 ObjectReferenceParamDTO 参数 是否必选 参数类型 描述 clazz 否 String 参数解释： 类名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 是 String 参数解释： 数据实例ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。

响应消息体（可选） 响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The request message format is invalid.", "error_code": "IMG.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/batchUndoCheckout { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "masterId" : "602146893727801345", "modifier" : "test1" } ] }

响应示例 状态码： 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "601060080745455616", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.406+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModel", "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" : "VersionModel", "name" : "modifier name", "description" : "modifier description", "kiaguid" : "18409de0386546f8af4bb6c1dc5cf50f", "securityLevel" : "internal", "master" : { "id" : "601060080779010048", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.419+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelMaster", "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" : "VersionModelMaster" }, "branch" : { "id" : "601060080799981568", "creator" : "test1", "modifier" : "test1", "createTime" : "2024-02-19T06:38:10.464+0000", "lastUpdateTime" : "2024-02-19T06:56:43.319+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "VersionModelBranch", "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" : "VersionModelBranch", "version" : "A" }, "latest" : true, "latestIteration" : true, "versionCode" : 1, "iteration" : 1, "version" : "A", "latestVersion" : true, "workingCopy" : false, "workingState" : { "code" : "CHECKED_IN", "cnName" : "已检入", "enName" : "checked in", "alias" : "CHECKED_IN" }, "checkOutUserName" : null, "checkOutTime" : null, "preVersionId" : "601372141664866304" } ], "errors" : [ ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of VersionModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表6 VersionModelViewDTO 参数 参数类型 描述 branch VersionModelBranchViewDTO object 参数解释： 分支对象。 取值范围： 不涉及。 默认取值： 不涉及。 checkOutTime String 参数解释： 检出时间。 取值范围： 不涉及。 默认取值： 不涉及。 checkOutUserName String 参数解释： 检出人。 取值范围： 不涉及。 默认取值： 不涉及。 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 iteration Integer 参数解释： 迭代版本。 取值范围： 不涉及。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 latest Boolean 参数解释： 是否为最新版本。 取值范围： true：是最新版本。 false：不是最新版本。 默认取值： false。 latestIteration Boolean 参数解释： 是否为最新迭代版本。 取值范围： true：是最新迭代版本。 false：不是最新迭代版本。 默认取值： 不涉及。 latestVersion Boolean 参数解释： 是否为最新修订版本。 取值范围： true：是最新修订版本。 false：不是最新修订版本。 默认取值： 不涉及。 master VersionModelMasterViewDTO object 参数解释： 主对象。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 preVersionId String 参数解释： 前序版本实例ID。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 version String 参数解释： 版本号。 取值范围： 不涉及。 默认取值： 不涉及。 versionCode Integer 参数解释： 业务版本内码。 取值范围： 不涉及。 默认取值： 不涉及。 workingCopy Boolean 参数解释： 是否已检出。 取值范围： true：已检出。 false：未检出。 默认取值： false。 workingState WorkingState object 参数解释： 工作状态。 取值范围： 不涉及。 默认取值： 不涉及。 表7 VersionModelBranchViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime Object 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 version String 参数解释： 版本号。 取值范围： 不涉及。 默认取值： 不涉及。 表8 VersionModelMasterViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表9 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 表10 WorkingState 参数 参数类型 描述 alias String 参数解释： 别名。 取值范围： 不涉及。 默认取值： 不涉及。 cnName String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 编码。 取值范围： 不涉及。 默认取值： 不涉及。 enName String 参数解释： 英文名称。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 Array of VersionModelVersionUndoCheckOutDTO objects 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 VersionModelVersionUndoCheckOutDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释： 主对象ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 modifier 否 String 参数解释： 更新者。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchUndoCheckout 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/deleteLatestVersion { "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "modifier" : "test1", "masterId" : "602425926667476992", "version" : "A" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 VersionModelVersionMasterModifierDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 VersionModelVersionMasterModifierDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释： 父模型ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 modifier 否 String 参数解释： 修改人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 version 否 String 参数解释： 版本对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/deleteLatestVersion 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of integers 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。